mirror of https://github.com/overleaf/toolkit.git synced 2025-04-19 07:18:06 +02:00

No description

Find a file

Eric Mc Sween 01e4ed312e Merge pull request #156 from overleaf/em-change-git-bridge-data-directory Change the location of the git-bridge data directory		2023-05-11 07:44:18 -04:00
.github	added github Issue and PR templates for contributions	2020-10-02 12:32:22 +02:00
bin	Start Mongo in a replica set by default	2023-04-28 08:26:17 -04:00
config	Public release of the Overleaf Toolkit	2020-08-19 13:31:17 +01:00
data	Public release of the Overleaf Toolkit	2020-08-19 13:31:17 +01:00
doc	[docs] extend docs for upgrading from 0.x	2022-11-17 13:03:29 +00:00
lib	Change the location of the git-bridge data directory	2023-05-10 17:17:32 -04:00
.gitignore	Public release of the Overleaf Toolkit	2020-08-19 13:31:17 +01:00
CHANGELOG.md	Updated seed version to 3.5.5	2023-03-21 16:54:50 +00:00
LICENSE	Public release of the Overleaf Toolkit	2020-08-19 13:31:17 +01:00
README.md	Make `git clone` commands match	2022-10-12 09:52:12 +01:00

README.md

Overleaf Toolkit

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

The Developer wiki contains further documentation on releases, features and other configuration elements.

Getting Started

Clone this repository locally:

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

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