From 52c280882a013cfb645fcb5e79cd743bb82fec17 Mon Sep 17 00:00:00 2001
From: timvisee <tim@visee.me>
Date: Thu, 9 Jul 2020 11:48:57 +0200
Subject: [PATCH] Update README, add Send base URL

---
 .env.example        |  3 +++
 README.md           | 13 +++++++++++++
 docker-compose.yaml |  1 +
 3 files changed, 17 insertions(+)

diff --git a/.env.example b/.env.example
index c04cb46..01d5756 100644
--- a/.env.example
+++ b/.env.example
@@ -1,6 +1,9 @@
 # Host to expose Send on
 HOST=send.example.org
 
+# Base URL for Send
+SEND_BASE_URL=https://send.example.org
+
 # Optional: for LetsEncrypt SSL, same as HOST
 LETSENCRYPT_HOST=
 
diff --git a/README.md b/README.md
index 7abfb94..cb22357 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,14 @@
 # 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
@@ -12,6 +22,9 @@
 # Host to expose Send on
 HOST=send.example.org
 
+# Base URL for Send
+SEND_BASE_URL=https://send.example.org
+
 # Optional: for LetsEncrypt SSL, same as HOST
 LETSENCRYPT_HOST=
 
diff --git a/docker-compose.yaml b/docker-compose.yaml
index 75dc784..842c08d 100644
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -40,6 +40,7 @@ services:
       - LETSENCRYPT_EMAIL
       - PORT=1234
       - REDIS_HOST=redis
+      - BASE_URL=${SEND_BASE_URL}
   redis:
     image: 'redis:alpine'
     restart: always