mirrors/overleaf-toolkit
1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-19 07:18:06 +02:00
Code Activity

Public release of the Overleaf Toolkit

Browse source
This commit is contained in:
Shane Kilkelly 2020-06-02 14:20:23 +01:00
commit 9395627ac8
39 changed files with 2513 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md Normal file
View file

@ -0,0 +1,33 @@
# Overleaf Toolkit
(Note: this software is currently in beta testing. Functionality and documentation
may be incomplete)
This repository contains the Overleaf Toolkit, the standard tools for running a local
instance of [Overleaf](https://overleaf.com). This toolkit will help you to set up and administer both Overleaf Community Edition (free to use, and community supported), and Overleaf Server Pro (commercial, with professional support).
## Getting Started
Clone this repository locally:
``` sh
git clone https://github.com/overleaf/toolkit.git ./overleaf
```
Then follow the [Quick Start Guide](./doc/quick-start-guide.md).
## Documentation
See [Documentation Index](./doc/README.md)
## Getting Help
Users of the free Community Edition should [open an issue on github](https://github.com/overleaf/toolkit/issues).
Users of Server Pro should contact `support@overleaf.com` for assistance.
In both cases, it is a good idea to include the output of the `bin/doctor` script in your message.