drop.chapril.org-firefoxsend/docs/docker.md

35 lines
1.4 KiB
Markdown
Raw Normal View History

2017-08-25 22:43:11 +02:00
## Setup
Use `registry.gitlab.com/timvisee/send:latest` from [`timvisee/send`'s registry](https://gitlab.com/timvisee/send/container_registry) for the latest Docker image.
```bash
docker pull registry.gitlab.com/timvisee/send:latest
```
Or run `docker build -t send:latest .` to create an image locally or `docker-compose up` to run a full testable stack. *We don't recommend using docker-compose for production.*
2017-08-25 22:43:11 +02:00
2017-06-26 21:34:31 +02:00
## Environment variables:
2017-06-09 01:11:17 +02:00
2017-06-26 21:34:31 +02:00
| Name | Description
|------------------|-------------|
| `PORT` | Port the server will listen on (defaults to 1443).
| `S3_BUCKET` | The S3 bucket name.
| `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)
2017-06-26 21:34:31 +02:00
| `NODE_ENV` | "production"
| `BASE_URL` | The HTTPS URL where traffic will be served (e.g. `https://send.firefox.com`)
2017-06-09 01:11:17 +02:00
2017-06-26 21:34:31 +02:00
## Example:
2017-06-09 01:11:17 +02:00
2017-06-26 21:34:31 +02:00
```sh
$ docker run --net=host -e 'NODE_ENV=production' \
-e 'S3_BUCKET=testpilot-p2p-dev' \
-e 'REDIS_HOST=dyf9s2r4vo3.bolxr4.0001.usw2.cache.amazonaws.com' \
-e 'SENTRY_CLIENT=https://51e23d7263e348a7a3b90a5357c61cb2@sentry.prod.mozaws.net/168' \
-e 'SENTRY_DSN=https://51e23d7263e348a7a3b90a5357c61cb2:65e23d7263e348a7a3b90a5357c61c44@sentry.prod.mozaws.net/168' \
-e 'BASE_URL=https://send.firefox.com' \
registry.gitlab.com/timvisee/send:latest
2017-06-26 21:34:31 +02:00
```