1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-18 14:58:21 +02:00

Update readme

This commit is contained in:
Shane Kilkelly 2020-06-12 11:42:39 +01:00
parent a7def9ba03
commit b0fe786136

View file

@ -15,13 +15,28 @@ Run `bin/doctor` for debug output
## Config files
- `config/docker-compose.yml`
- base config file for docker-compose, not meant to be edited
- `config/local.yml`
- local overrides, and environment configuration, editable
- `config/overleaf.rc`
- `config/variables.env`
- `config/docker-compose.base.yml`
- `config/docker-compose.mongo.yml`
- `config/docker-compose.redis.yml`
- `config/docker-compose.sibling-containers.yml`
## Data directories
### Overleaf.rc
The `config/overleaf.rc` file controls top-level configuration,
such as the docker image to use, data paths, etc. This is used
to configure the invocaton to docker-compose.
### Variables.env
Environment variables loaded in the overleaf container as application
settings.
## Data directories (default)
- `data/mongo`
- `data/redis`
@ -29,6 +44,8 @@ Run `bin/doctor` for debug output
All are persisted outside of the containers.
These can be changed by setting `MONGO_DATA_PATH` (etc) in `overleaf.rc`
## TODO