From 7f3da34318f837dced1703722335408699de67cd Mon Sep 17 00:00:00 2001 From: timvisee Date: Tue, 26 Jan 2021 20:22:04 +0100 Subject: [PATCH] Update Docker configuration --- docs/docker.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/docker.md b/docs/docker.md index 4fc4a7a2..7b38d6b0 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -12,18 +12,24 @@ Or run `docker build -t send:latest .` to create an image locally or `docker-com | Name | Description |------------------|-------------| +| `BASE_URL` | The HTTPS URL where traffic will be served (e.g. `https://send.firefox.com`) | `PORT` | Port the server will listen on (defaults to 1443). +| `NODE_ENV` | `"production"` +| `FILE_DIR` | Uploads directory for local storage | `S3_BUCKET` | The S3 bucket name. +| `S3_ENDPOINT`| Optional custom S3 endpoint host. +| `S3_USE_PATH_STYLE_ENDPOINTS`| `true` or `false` +| `AWS_ACCESS_KEY_ID` | S3 access key ID +| `AWS_SECRET_ACCESS_KEY` | S3 secret access key ID +| `MAX_FILE_SIZE` | Maximum upload file size in bytes (defaults to 2147483648) +| `MAX_EXPIRE_SECONDS` | Maximum upload expiry time in seconds (defaults to 604800) | `REDIS_HOST` | Host name of the Redis server. | `SENTRY_CLIENT` | Sentry Client ID | `SENTRY_DSN` | Sentry DSN -| `MAX_FILE_SIZE` | in bytes (defaults to 2147483648) -| `NODE_ENV` | "production" -| `BASE_URL` | The HTTPS URL where traffic will be served (e.g. `https://send.firefox.com`) ## Example: -```sh +```bash $ docker run --net=host -e 'NODE_ENV=production' \ -e 'S3_BUCKET=testpilot-p2p-dev' \ -e 'REDIS_HOST=dyf9s2r4vo3.bolxr4.0001.usw2.cache.amazonaws.com' \ @@ -32,3 +38,9 @@ $ docker run --net=host -e 'NODE_ENV=production' \ -e 'BASE_URL=https://send.firefox.com' \ registry.gitlab.com/timvisee/send:latest ``` + +## Docker compose + +For a Docker compose configuration example, see: + +https://github.com/timvisee/send-docker-compose