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

No description

Find a file

John Lees-Miller 30f705db5b Merge pull request #98 from alex-devg/patch-1 Update quick-start-guide.md (typo)		2022-06-09 09:33:28 +01:00
.github	added github Issue and PR templates for contributions	2020-10-02 12:32:22 +02:00
bin	prompt warning on major version upgrades	2021-12-20 16:08:43 +01: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	Update quick-start-guide.md	2022-06-08 21:13:18 +02:00
lib	Update config seed to upcoming 3.1.0	2022-05-17 12:07:54 +02:00
.gitignore	Public release of the Overleaf Toolkit	2020-08-19 13:31:17 +01:00
CHANGELOG.md	wip: Add new EXTERNAL_AUTH variable	2021-08-05 13:10:33 +01:00
CONTRIBUTING	Create CONTRIBUTING	2020-10-02 11:11:11 +01:00
LICENSE	Public release of the Overleaf Toolkit	2020-08-19 13:31:17 +01:00
README.md	Removed "incomplete" and "beta testing" references (#55 )	2021-06-01 15:26:05 +02: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

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.