overleaf.rc
This document describes the variables that are supported in the config/overleaf.rc
file.
This file consists of variable definitions in the form NAME=value
. Lines beginning with #
are treated as comments.
Note: we recommend that you re-create the docker containers after changing anything in overleaf.rc
or variables.env
, by running bin/docker-compose down
, followed by bin/up
PROJECT_NAME
Sets the value of the --project-name
flag supplied to docker-compose
.
This is useful when running multiple instances of Overleaf on one host, as each instance can have a different project name.
SHARELATEX_DATA_PATH
Sets the path to the directory that will be mounted into the main sharelatex
container, and used to store compile data. This can be either a full path (beginning with a /
), or relative to the base directory of the toolkit.
SHARELATEX_LISTEN_IP
Sets the host IP address(es) that the container will bind to. For example, if this is set to 0.0.0.0
, then the web interface will be available on any host IP address.
Since https://github.com/overleaf/toolkit/pull/77 the listen mode of the application container was changed to localhost
only, so the value of SHARELATEX_LISTEN_IP
must be set to the public IP address for direct container access.
Setting SHARELATEX_LISTEN_IP
to either 0.0.0.0
or the external IP of your host will typically cause errors when used in conjunction with the TLS Proxy.
127.0.0.1
SHARELATEX_PORT
Sets the host port that the container will bind to. For example, if this is set to 8099
and SHARELATEX_LISTEN_IP
is set to 127.0.0.1
, then the web interface will be available on http://localhost:8099
.
SERVER_PRO
When set to true
, tells the toolkit to use the Server Pro image (quay.io/sharelatex/sharelatex-pro
), rather than the default Community Edition image (sharelatex/sharelatex
).
SIBLING_CONTAINERS_ENABLED
When set to true
, tells the toolkit to use the "Sibling Containers" technique
for compiling projects in separate sandboxes, using a separate docker container for
each project. See the legacy documentation on Sandboxed Compiles for more information.
Requires SERVER_PRO=true
DOCKER_SOCKET_PATH
Sets the path to the docker socket on the host machine (the machine running the toolkit code). When SIBLING_CONTAINERS_ENABLED
is true
, the socket will be mounted into the container, to allow the compiler service to spawn new docker containers on the host.
Requires SIBLING_CONTAINERS_ENABLED=true
MONGO_ENABLED
When set to true
, tells the toolkit to create a MongoDB container, to host the database.
When set to false
, this container will not be created, and the system will use the MongoDB database specified by MONGO_URL
instead.
MONGO_URL
Specifies the MongoDB connection URL to use when MONGO_ENABLED
is false
MONGO_DATA_PATH
Sets the path to the directory that will be mounted into the mongo
container, and used to store the MongoDB database. This can be either a full path (beginning with a /
), or relative to the base directory of the toolkit. This option only affects the local mongo
container that is created when MONGO_ENABLED
is true
.
REDIS_ENABLED
When set to true
, tells the toolkit to create a Redis container, to host the redis database.
When set to false
, this container will not be created, and the system will use the Redis database specified by REDIS_HOST
and REDIS_PORT
instead.
REDIS_HOST
Specifies the Redis host to use when REDIS_ENABLED
is false
REDIS_PORT
Specifies the Redis port to use when REDIS_ENABLED
is false
REDIS_DATA_PATH
Sets the path to the directory that will be mounted into the redis
container, and used to store the Redis database. This can be either a full path (beginning with a /
), or relative to the base directory of the toolkit. This option only affects the local redis
container that is created when REDIS_ENABLED
is true
.
NGINX_ENABLED
When set to true
, tells the toolkit to create an NGINX container, to act as a TLS Proxy.
NGINX_CONFIG_PATH
Path to the NGINX config file to use for the TLS Proxy.
TLS_PRIVATE_KEY_PATH
Path to the private key to use for the TLS Proxy.
TLS_CERTIFICATE_PATH
Path to the public certificate to use for the TLS Proxy.
NGINX_TLS_LISTEN_IP
Sets the host IP address(es) that the TLS Proxy container will bind to for https. For example, if this is set to 0.0.0.0
then the https web interface will be available on any host IP address.
Typically this should be set to the external IP of your host.
127.0.1.1
TLS_PORT
Sets the host port that the TLS Proxy container will bind to for https.
NGINX_HTTP_LISTEN_IP
Sets the host IP address(es) that the TLS Proxy container will bind to for http redirect. For example, if this is set to 127.0.1.1
then http connections to 127.0.1.1
will be redirected to the https web interface.
Typically this should be set to the external IP of your host. Do not set it to 0.0.0.0
as this will typically cause a conflict with SHARELATEX_LISTEN_IP
.
127.0.1.1
NGINX_HTTP_PORT
Sets the host port that the TLS Proxy container will bind to for http.
80
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。