overleaf-toolkit/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](https://overleaf.com). 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:

``` sh
git clone https://github.com/overleaf/toolkit.git ./overleaf
```

Then follow the [Quick Start Guide](./doc/quick-start-guide.md).


## Documentation

See [Documentation Index](./doc/README.md)


## Getting Help

Users of the free Community Edition should [open an issue on github](https://github.com/overleaf/toolkit/issues). 

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.
init, basic doctor 2020-06-02 14:20:23 +01:00			`# Overleaf Toolkit`
Add some basic docs to README file 2020-06-05 11:00:42 +01:00
Add note about beta testing to README 2020-07-15 09:26:56 +01:00			`(Note: this software is currently in beta testing. Functionality and documentation`
			`may be incomplete)`

WIP: better docs 2020-07-21 16:26:01 +01:00			`This repository contains the Overleaf Toolkit, the standard tools for running a local`
			`instance of [Overleaf](https://overleaf.com). 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).`
Add note about beta testing to README 2020-07-15 09:26:56 +01:00
Add some basic docs to README file 2020-06-05 11:00:42 +01:00
WIP: better docs 2020-07-21 16:26:01 +01:00			`## Getting Started`
Add some basic docs to README file 2020-06-05 11:00:42 +01:00
WIP: better docs 2020-07-21 16:26:01 +01:00			`Clone this repository locally:`
Add some basic docs to README file 2020-06-05 11:00:42 +01:00
WIP: better docs 2020-07-21 16:26:01 +01:00			``` sh
Update clone instructions in readme 2020-08-05 13:56:49 +01:00			`git clone https://github.com/overleaf/toolkit.git ./overleaf`
WIP: better docs 2020-07-21 16:26:01 +01:00			```
Add a note about realpath to readme 2020-07-16 14:00:19 +01:00
WIP: better docs 2020-07-21 16:26:01 +01:00			`Then follow the [Quick Start Guide](./doc/quick-start-guide.md).`
Add a note about realpath to readme 2020-07-16 14:00:19 +01:00

WIP: better docs 2020-07-21 16:26:01 +01:00			`## Documentation`
Add a note about realpath to readme 2020-07-16 14:00:19 +01:00
Move the doc index to doc/README.md 2020-07-23 10:05:00 +01:00			`See [Documentation Index](./doc/README.md)`
Add a note about realpath to readme 2020-07-16 14:00:19 +01:00
Add some basic docs to README file 2020-06-05 11:00:42 +01:00
WIP: better docs 2020-07-21 16:26:01 +01:00			`## Getting Help`
Add some basic docs to README file 2020-06-05 11:00:42 +01:00
WIP: better docs 2020-07-21 16:26:01 +01:00			`Users of the free Community Edition should [open an issue on github](https://github.com/overleaf/toolkit/issues).`
Add some basic docs to README file 2020-06-05 11:00:42 +01:00
WIP: better docs 2020-07-21 16:26:01 +01:00			Users of Server Pro should contact `support@overleaf.com` for assistance.
Update basic docs in readmen 2020-06-16 13:27:24 +01:00
Update the 'getting help' phrasing 2020-07-23 10:10:40 +01:00			In both cases, it is a good idea to include the output of the `bin/doctor` script in your message.
Update basic docs in readmen 2020-06-16 13:27:24 +01:00