1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-19 23:38:06 +02:00

Update basic docs in readmen

This commit is contained in:
Shane Kilkelly 2020-06-16 13:27:24 +01:00
parent 4e1f4e4a77
commit b1c0abc56f
2 changed files with 33 additions and 4 deletions

View file

@ -13,6 +13,13 @@
Run `bin/doctor` for debug output
## Docker Compose Wrappers
The `bin/docker-compose` script is a wrapper around `docker-compose`,
and automatically loads the project configuration. `bin/up`, `bin/start`, etc,
are convenience wrappers around `bin/docker-compose`.
## Config files
- `config/overleaf.rc`
@ -23,14 +30,14 @@ Run `bin/doctor` for debug output
- `config/docker-compose.sibling-containers.yml`
### Overleaf.rc
### 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
### variables.env
Environment variables loaded in the overleaf container as application
settings.
@ -45,3 +52,24 @@ settings.
All are persisted outside of the containers.
These can be changed by setting `MONGO_DATA_PATH` (etc) in `overleaf.rc`
## How Too
### Change Image
- in `overleaf.rc`, set `IMAGE` to the desired image name
### Using an external mongo/redis
- Set `MONGO_ENABLED=false` in `overleaf.rc`
- In `variables.env`, set `SHARELATEX_MONGO_URL` to the appropriate url
### Using Sibling-Containers
- In `overleaf.rc` set `SIBLING_CONTAINERS_ENABLED=true`
- In `overleaf.rc`, ensure `DOCKER_SOCKET_PATH` is set
- In `variables.env`, un-comment the block starting with `DOCKER_RUNNER=...`,
and set the appropriate values

View file

@ -48,8 +48,9 @@ TEXMFVAR=/var/lib/sharelatex/tmp/texmf-var
## Server Pro ##
################
### Uncomment the following block when enabling sibling containers
### and replace 'path-to-data-directory' with full SHARELATEX_DATA_PATH
### Sibling Containers:
### Uncomment the following block when enabling sibling containers
### and replace 'path-to-data-directory' with full SHARELATEX_DATA_PATH
# DOCKER_RUNNER=true
# SANDBOXED_COMPILES=true