Rename TLS cert/key variables

bin/docker-compose

@@ -73,8 +73,8 @@ function __main__() {
   SHARELATEX_DATA_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$SHARELATEX_DATA_PATH")
   MONGO_DATA_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$MONGO_DATA_PATH")
   REDIS_DATA_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$REDIS_DATA_PATH")
-  NGINX_PRIVATE_KEY_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$NGINX_PRIVATE_KEY_PATH")
-  NGINX_CERTIFICATE_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$NGINX_CERTIFICATE_PATH")
+  TLS_PRIVATE_KEY_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$TLS_PRIVATE_KEY_PATH")
+  TLS_CERTIFICATE_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$TLS_CERTIFICATE_PATH")
   NGINX_CONFIG_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$NGINX_CONFIG_PATH")
 
   # Print debug info
@@ -103,8 +103,8 @@ function __main__() {
   export REDIS_HOST
   export REDIS_PORT
   export NGINX_IMAGE
-  export NGINX_PRIVATE_KEY_PATH
-  export NGINX_CERTIFICATE_PATH
+  export TLS_PRIVATE_KEY_PATH
+  export TLS_CERTIFICATE_PATH
   export NGINX_CONFIG_PATH
   export TLS_PORT
 

bin/doctor

@@ -233,11 +233,11 @@ function check_config_files() {
         if [[ "${NGINX_CONFIG_PATH:-null}" != "null" ]]; then
           print_point 2 "NGINX_CONFIG_PATH: $NGINX_CONFIG_PATH"
         fi
-        if [[ "${NGINX_PRIVATE_KEY_PATH:-null}" != "null" ]]; then
-          print_point 2 "NGINX_PRIVATE_KEY_PATH: $NGINX_PRIVATE_KEY_PATH"
+        if [[ "${TLS_PRIVATE_KEY_PATH:-null}" != "null" ]]; then
+          print_point 2 "TLS_PRIVATE_KEY_PATH: $TLS_PRIVATE_KEY_PATH"
         fi
-        if [[ "${NGINX_CERTIFICATE_PATH:-null}" != "null" ]]; then
-          print_point 2 "NGINX_CERTIFICATE_PATH: $NGINX_CERTIFICATE_PATH"
+        if [[ "${TLS_CERTIFICATE_PATH:-null}" != "null" ]]; then
+          print_point 2 "TLS_CERTIFICATE_PATH: $TLS_CERTIFICATE_PATH"
         fi
       fi
     fi

doc/overleaf-rc.md

@@ -118,13 +118,13 @@ Path to the NGINX config file to use for the [TLS Proxy](tls-proxy.md).
 
 - Default: config/nginx/nginx.conf
 
-### `NGINX_PRIVATE_KEY_PATH`
+### `TLS_PRIVATE_KEY_PATH`
 
 Path to the private key to use for the [TLS Proxy](tls-proxy.md).
 
 - Default: config/nginx/certs/overleaf_key.pem
 
-### `NGINX_CERTIFICATE_PATH`
+### `TLS_CERTIFICATE_PATH`
 
 Path to the public certificate to use for the [TLS Proxy](tls-proxy.md).
 

doc/tls-proxy.md

@@ -2,7 +2,7 @@
 
 An optional TLS proxy for terminating https connections, based on NGINX.
 
-The toolkit is initialised with a sample private key in `config/nginx/certs/overleaf_key.pem` and a dummy certificate in `config/nginx/certs/overleaf_certificate.pem`. Either replace these with your actual private key and certificate, or set the values of the `NGINX_PRIVATE_KEY_PATH` and `NGINX_CERTIFICATE_PATH` variables to the paths of your actual private key and certificate respectively.
+The toolkit is initialised with a sample private key in `config/nginx/certs/overleaf_key.pem` and a dummy certificate in `config/nginx/certs/overleaf_certificate.pem`. Either replace these with your actual private key and certificate, or set the values of the `TLS_PRIVATE_KEY_PATH` and `TLS_CERTIFICATE_PATH` variables to the paths of your actual private key and certificate respectively.
 
 A default config for NGINX is provided in `config/nginx/nginx.conf` which may be customised to your requirements. The path to the config file can be changed with the `NGINX_CONFIG_PATH` variable.
 

lib/config-seed/overleaf.rc

@@ -22,6 +22,6 @@ REDIS_DATA_PATH=data/redis
 # TLS Proxy
 NGINX_ENABLED=false
 NGINX_CONFIG_PATH=config/nginx/nginx.conf
-NGINX_PRIVATE_KEY_PATH=config/nginx/certs/overleaf_key.pem
-NGINX_CERTIFICATE_PATH=config/nginx/certs/overleaf_certificate.pem
+TLS_PRIVATE_KEY_PATH=config/nginx/certs/overleaf_key.pem
+TLS_CERTIFICATE_PATH=config/nginx/certs/overleaf_certificate.pem
 TLS_PORT=443

lib/docker-compose.nginx.yml

@@ -7,8 +7,8 @@ services:
     ports:
       - "127.0.0.1:${TLS_PORT:-443}:18443"
     volumes:
-      - "${NGINX_PRIVATE_KEY_PATH}:/certs/nginx_key.pem"
-      - "${NGINX_CERTIFICATE_PATH}:/certs/nginx_certificate.pem"
+      - "${TLS_PRIVATE_KEY_PATH}:/certs/nginx_key.pem"
+      - "${TLS_CERTIFICATE_PATH}:/certs/nginx_certificate.pem"
       - "${NGINX_CONFIG_PATH}:/etc/nginx/nginx.conf"
     restart: on-failure:5
     container_name: nginx