2020-06-02 14:20:23 +01:00
# Overleaf Toolkit
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).
2021-06-01 15:26:05 +02:00
The [Developer wiki ](https://github.com/overleaf/overleaf/wiki ) contains further documentation on releases, features and other configuration elements.
2020-06-02 14:20:23 +01:00
## Getting Started
Clone this repository locally:
``` sh
2022-10-12 09:52:12 +01:00
git clone https://github.com/overleaf/toolkit.git ./overleaf-toolkit
2020-06-02 14:20:23 +01:00
```
Then follow the [Quick Start Guide ](./doc/quick-start-guide.md ).
## Documentation
See [Documentation Index ](./doc/README.md )
2020-10-02 11:12:12 +01:00
## Contributing
2022-07-19 13:55:57 +01:00
See the [CONTRIBUTING ](https://github.com/overleaf/overleaf/blob/main/CONTRIBUTING.md ) file.
2020-10-02 11:12:12 +01:00
2020-06-02 14:20:23 +01:00
## 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.
