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

No description

Find a file

mserranom 1cb92d9f48 Rebrand variables for bin/docker-compose Updates docker-compose.base.yml and sibling containers base file with the changes in the script		2024-02-14 16:09:31 +01:00
.github	added github Issue and PR templates for contributions	2020-10-02 12:32:22 +02:00
bin	Rebrand variables for bin/docker-compose	2024-02-14 16:09:31 +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	Docs: Fix link to doc/ directory on GitHub	2024-02-09 12:29:01 +00:00
lib	Rebrand variables for bin/docker-compose	2024-02-14 16:09:31 +01:00
.gitignore	Public release of the Overleaf Toolkit	2020-08-19 13:31:17 +01:00
CHANGELOG.md	Updated config-seed to v4.2.2	2024-02-14 11:24:37 +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.