From 9df090b4d96d12e68b2353403cc6cc358581bf20 Mon Sep 17 00:00:00 2001 From: Shyam Sunder Date: Wed, 14 Aug 2019 07:57:56 -0400 Subject: [PATCH] doc: simplified how to use the base URL feature --- doc/INSTALL.md | 6 +++--- doc/example.env | 4 ++++ docker-compose.yml | 1 + 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/INSTALL.md b/doc/INSTALL.md index e523a6a..901ae62 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -81,10 +81,10 @@ and Docker Compose (version 1.6.0 or greater) already installed. Some users may wish to access the service at a different base URI, such as `http://example.com/szuru/`, commonly when sharing multiple HTTP services on one domain using a reverse proxy. In this case, simply set - `BASE_URL="/szuru/"` in the frontend container (unless you are hosting your - data on a different domain). + `BASE_URL="/szuru/"` in your `.env` file. - You should set your reverse proxy to proxy `http(s)://example.com/szuru` to + Note that this will require a reverse proxy to function. You should set + your reverse proxy to proxy `http(s)://example.com/szuru` to `http:///`. For an NGINX reverse proxy, that will appear as: diff --git a/doc/example.env b/doc/example.env index 37c9cfa..b73377c 100644 --- a/doc/example.env +++ b/doc/example.env @@ -10,6 +10,10 @@ BUILD_INFO=latest # otherwise the port specified here will be publicly accessible PORT=8080 +# URL base to run szurubooru under +# See "Additional Features" section in INSTALL.md +BASE_URL=/ + # Directory to store image data MOUNT_DATA=/var/local/szurubooru/data diff --git a/docker-compose.yml b/docker-compose.yml index c9c5a5f..345e531 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -37,6 +37,7 @@ services: - api environment: BACKEND_HOST: api + BASE_URL: volumes: - "${MOUNT_DATA}:/data:ro" ports: