mirrors/overleaf-toolkit
1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-19 07:18:06 +02:00
Code Activity
No description
128 commits 9 branches 0 tags 1.2 MiB
Find a file
M Fahru fc9c91445c
Change suggested directory name from overleaf to overleaf-toolkit in the Quick Start Guide 
`overleaf` is the default directory name for the https://github.com/overleaf/overleaf repository, it would be better if the documentation suggests a different directory name for toolkit so they won't conflict when the toolkit repositor is cloned in the same parent directory as the overleaf community edition.
2022-07-26 08:45:17 -04: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 Change suggested directory name from overleaf to overleaf-toolkit in the Quick Start Guide 2022-07-26 08:45:17 -04: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
LICENSE Public release of the Overleaf Toolkit 2020-08-19 13:31:17 +01:00
README.md Link to CONTRIBUTING file in the main overleaf repository 2022-07-24 21:37:19 +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

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.