github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #216 from overleaf/csh-ae-readme

Browse source 
Add missing environment variables to CLSI README.
This commit is contained in:
Alf Eaton 2021-03-16 16:06:12 +00:00 committed by GitHub
commit 4dc656ae2a
1 changed files with 25 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
services/clsi/README.md
View file

@ -11,21 +11,33 @@ The Common LaTeX Service Interface (CLSI) provides a RESTful interface to tradit
These defaults can be modified in `config/settings.defaults.js`. These defaults can be modified in `config/settings.defaults.js`.
The provided `Dockerfile` builds a docker image which has the docker command line tools installed. The configuration in `docker-compose-config.yml` mounts the docker socket, in order that the CLSI container can talk to the docker host it is running in. This allows it to spin up `sibling containers` running an image with a TeX distribution installed to perform the actual compiles. The provided `Dockerfile` builds a Docker image which has the Docker command line tools installed. The configuration in `docker-compose-config.yml` mounts the Docker socket, in order that the CLSI container can talk to the Docker host it is running in. This allows it to spin up `sibling containers` running an image with a TeX distribution installed to perform the actual compiles.
The CLSI can be configured through the following environment variables: The CLSI can be configured through the following environment variables:
* `DOCKER_RUNNER` - Set to true to use sibling containers * `ALLOWED_COMPILE_GROUPS` - Space separated list of allowed compile groups
* `SYNCTEX_BIN_HOST_PATH` - Path to SyncTeX binary * `ALLOWED_IMAGES` - Space separated list of allowed Docker TeX Live images
* `COMPILES_HOST_DIR` - Working directory for LaTeX compiles * `CATCH_ERRORS` - Set to `true` to log uncaught exceptions
* `SQLITE_PATH` - Path to SQLite database * `COMPILE_GROUP_DOCKER_CONFIGS` - JSON string of Docker configs for compile groups
* `TEXLIVE_IMAGE` - The TEXLIVE docker image to use for sibling containers, e.g. `gcr.io/overleaf-ops/texlive-full:2017.1` * `COMPILES_HOST_DIR` - Working directory for LaTeX compiles
* `TEXLIVE_IMAGE_USER` - When using sibling containers, the user to run as in the TEXLIVE image. Defaults to `tex` * `COMPILE_SIZE_LIMIT` - Sets the body-parser [limit](https://github.com/expressjs/body-parser#limit)
* `TEX_LIVE_IMAGE_NAME_OVERRIDE` - The name of the registry for the docker image e.g. `gcr.io/overleaf-ops` * `DOCKER_RUNNER` - Set to true to use sibling containers
* `FILESTORE_DOMAIN_OVERRIDE` - The url for the filestore service e.g.`http://$FILESTORE_HOST:3009` * `DOCKER_RUNTIME` -
* `STATSD_HOST` - The address of the Statsd service (used by the metrics module) * `FILESTORE_DOMAIN_OVERRIDE` - The url for the filestore service e.g.`http://$FILESTORE_HOST:3009`
* `LISTEN_ADDRESS` - The address for the RESTful service to listen on. Set to `0.0.0.0` to listen on all network interfaces * `FILESTORE_PARALLEL_FILE_DOWNLOADS` - Number of parallel file downloads
* `SMOKE_TEST` - Whether to run smoke tests * `FILESTORE_PARALLEL_SQL_QUERY_LIMIT` - Number of parallel SQL queries
* `LISTEN_ADDRESS` - The address for the RESTful service to listen on. Set to `0.0.0.0` to listen on all network interfaces
* `PROCESS_LIFE_SPAN_LIMIT_MS` - Process life span limit in milliseconds
* `SENTRY_DSN` - Sentry [Data Source Name](https://docs.sentry.io/product/sentry-basics/dsn-explainer/)
* `SMOKE_TEST` - Whether to run smoke tests
* `SQLITE_PATH` - Path to SQLite database
* `SYNCTEX_BIN_HOST_PATH` - Path to SyncTeX binary
* `TEXLIVE_IMAGE` - The TeX Live Docker image to use for sibling containers, e.g. `gcr.io/overleaf-ops/texlive-full:2017.1`
* `TEX_LIVE_IMAGE_NAME_OVERRIDE` - The name of the registry for the Docker image e.g. `gcr.io/overleaf-ops`
* `TEXLIVE_IMAGE_USER` - When using sibling containers, the user to run as in the TeX Live image. Defaults to `tex`
* `TEXLIVE_OPENOUT_ANY` - Sets the `openout_any` environment variable for TeX Live
Further environment variables configure the [metrics module](https://github.com/overleaf/metrics-module)
Installation Installation
------------ ------------
@ -38,7 +50,7 @@ Then build the Docker image:
$ docker build . -t overleaf/clsi $ docker build . -t overleaf/clsi
Then pull the TeXLive image: Then pull the TeX Live image:
$ docker pull texlive/texlive $ docker pull texlive/texlive