Files
send-docker-compose/README.md
2020-07-09 12:28:04 +02:00

38 lines
994 B
Markdown

# Firefox Send in Docker compose
This repository provides a basic Docker compose configuration to host a public
[Firefox Send](https://github.com/mozilla/send) instance on your own domain.
- Hosts on your own domain
- Provides automatic SSL certificates through LetsEncrypt
This configuration exposes a reverse proxy on ports 80 and 443, so these must be
available.
See [docker-compose.yaml](./docker-compose.yaml).
### Usage
- Install Docker with Docker compose
- Clone repository
- Run `cp .env.example .env` and configure it (see [example](#example-env))
- Run `docker-compose up`
- Visit your domain
### Example .env
```bash
# Docker image to use for Send
DOCKER_SEND_IMAGE=mozilla/send:latest
# Host to expose Send on
HOST=send.example.org
# Some exposed Send properties, see Send configuration
SEND_BASE_URL=
SEND_FILE_DIR=
# Optional: for LetsEncrypt SSL, same as HOST
LETSENCRYPT_HOST=
# Optional: for LetsEncrypt SSL, your email address
LETSENCRYPT_EMAIL=mail@example.org
```