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

No description

Find a file

Christopher Hoskin 0a5905b434 Add a TLS proxy option to the Toolkit		2021-04-08 12:02:15 +01:00
.github	added github Issue and PR templates for contributions	2020-10-02 12:32:22 +02:00
bin	Add a TLS proxy option to the Toolkit	2021-04-08 12:02:15 +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	Add a TLS proxy option to the Toolkit	2021-04-08 12:02:15 +01:00
lib	Add a TLS proxy option to the Toolkit	2021-04-08 12:02:15 +01:00
tls_proxy	Add a TLS proxy option to the Toolkit	2021-04-08 12:02:15 +01:00
.gitignore	Public release of the Overleaf Toolkit	2020-08-19 13:31:17 +01:00
CHANGELOG.md	[misc] fix code linting errors in bin/ scripts	2020-11-25 10:30:24 +00: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	Update README.md	2020-10-02 11:12:12 +01:00

README.md

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