https://github.com/overleaf/toolkit
https://github.com/overleaf/toolkit
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/overleaf/toolkit
- Owner: overleaf
- License: agpl-3.0
- Created: 2020-06-03T08:12:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-10-30T12:53:38.000Z (8 months ago)
- Last Synced: 2025-10-30T14:35:34.899Z (8 months ago)
- Language: Shell
- Size: 786 KB
- Stars: 991
- Watchers: 25
- Forks: 239
- Open Issues: 124
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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).
The [Developer wiki](https://github.com/overleaf/overleaf/wiki) contains further documentation on releases, features and other configuration elements.
## Getting Started
Clone this repository locally:
``` sh
git clone https://github.com/overleaf/toolkit.git ./overleaf-toolkit
```
Then follow the [Quick Start Guide](./doc/quick-start-guide.md).
## Documentation
See [Documentation Index](./doc/README.md)
## Contributing
See the [CONTRIBUTING](https://github.com/overleaf/overleaf/blob/main/CONTRIBUTING.md) file.
## 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.