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

Add missing environment variables to CLSI README.

services/clsi/README.md

@@ -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`.
 
-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:
 
-  * `DOCKER_RUNNER` - Set to true to use sibling containers
-  * `SYNCTEX_BIN_HOST_PATH` - Path to SyncTeX binary
-  * `COMPILES_HOST_DIR` - Working directory for LaTeX compiles
-  * `SQLITE_PATH` - Path to SQLite database
-  * `TEXLIVE_IMAGE` - The TEXLIVE docker image to use for sibling containers, e.g. `gcr.io/overleaf-ops/texlive-full:2017.1`
-  * `TEXLIVE_IMAGE_USER` - When using sibling containers, the user to run as in the TEXLIVE image. Defaults to `tex`
-  * `TEX_LIVE_IMAGE_NAME_OVERRIDE` - The name of the registry for the docker image e.g. `gcr.io/overleaf-ops`
-  * `FILESTORE_DOMAIN_OVERRIDE` - The url for the filestore service e.g.`http://$FILESTORE_HOST:3009`
-  * `STATSD_HOST` - The address of the Statsd service (used by the metrics module)
-  * `LISTEN_ADDRESS` - The address for the RESTful service to listen on. Set to `0.0.0.0` to listen on all network interfaces
-  * `SMOKE_TEST` - Whether to run smoke tests
+* `ALLOWED_COMPILE_GROUPS` - Space separated list of allowed compile groups
+* `ALLOWED_IMAGES` - Space separated list of allowed Docker TeX Live images 
+* `CATCH_ERRORS` - Set to `true` to log uncaught exceptions
+* `COMPILE_GROUP_DOCKER_CONFIGS` - JSON string of Docker configs for compile groups
+* `COMPILES_HOST_DIR` - Working directory for LaTeX compiles
+* `COMPILE_SIZE_LIMIT` - Sets the body-parser [limit](https://github.com/expressjs/body-parser#limit)
+* `DOCKER_RUNNER` - Set to true to use sibling containers
+* `DOCKER_RUNTIME` - 
+* `FILESTORE_DOMAIN_OVERRIDE` - The url for the filestore service e.g.`http://$FILESTORE_HOST:3009`
+* `FILESTORE_PARALLEL_FILE_DOWNLOADS` - Number of parallel file downloads
+* `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
 ------------
@@ -38,7 +50,7 @@ Then build the Docker image:
 
     $ docker build . -t overleaf/clsi
 
-Then pull the TeXLive image:
+Then pull the TeX Live image:
 
     $ docker pull texlive/texlive