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. 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:

git clone https://github.com/overleaf/toolkit.git ./overleaf

Then follow the Quick Start Guide.

Documentation

See Documentation Index

Contributing

See the CONTRIBUTING file.

Getting Help

Users of the free Community Edition should open an issue on github.

Users of Server Pro should contact [email protected] for assistance.

In both cases, it is a good idea to include the output of the bin/doctor script in your message.