mirrors/overleaf-toolkit
1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-19 15:28:06 +02:00
Code Activity

Update readme and docs

Browse source
This commit is contained in:
Shane Kilkelly 2020-07-09 13:58:44 +01:00
parent a5b189a6a2
commit 8687d98ca2
2 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -21,6 +21,7 @@ are convenience wrappers around `bin/docker-compose`.
- `config/overleaf.rc`
- `config/variables.env`
- `config/version`
If `config/docker-compose.override.yml` is present, it will also be loaded.
@ -61,8 +62,7 @@ These can be changed by setting `MONGO_DATA_PATH` (etc) in `overleaf.rc`
### Update to the latest version
This project uses tags to mark releases on the `master` branch.
Run `git pull`, and check out the latest tag. (TODO: improve this).
- Change the contents of `config/version`
### Switch to Server Pro

5
doc/quick-start-guide.md
View file

@ -68,14 +68,15 @@ Now check the contents of the `config/` directory
```sh
$ ls config
overleaf.rc variables.env
overleaf.rc variables.env version
```
These are the two configuration files you will interact with:
These are the three configuration files you will interact with:
- `overleaf.rc` : top-level configuration
- `variables.env` : environment variables loaded into the docker container
- `version` : version of the docker images to use
## Starting Up