doc: simplified how to use the base URL feature

This commit is contained in:
Shyam Sunder 2019-08-14 07:57:56 -04:00
parent 48e7eb10f1
commit 9df090b4d9
3 changed files with 8 additions and 3 deletions

View File

@ -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 Some users may wish to access the service at a different base URI, such
as `http://example.com/szuru/`, commonly when sharing multiple HTTP as `http://example.com/szuru/`, commonly when sharing multiple HTTP
services on one domain using a reverse proxy. In this case, simply set 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 `BASE_URL="/szuru/"` in your `.env` file.
data on a different domain).
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://<internal IP or hostname of frontend container>/`. For an NGINX `http://<internal IP or hostname of frontend container>/`. For an NGINX
reverse proxy, that will appear as: reverse proxy, that will appear as:

View File

@ -10,6 +10,10 @@ BUILD_INFO=latest
# otherwise the port specified here will be publicly accessible # otherwise the port specified here will be publicly accessible
PORT=8080 PORT=8080
# URL base to run szurubooru under
# See "Additional Features" section in INSTALL.md
BASE_URL=/
# Directory to store image data # Directory to store image data
MOUNT_DATA=/var/local/szurubooru/data MOUNT_DATA=/var/local/szurubooru/data

View File

@ -37,6 +37,7 @@ services:
- api - api
environment: environment:
BACKEND_HOST: api BACKEND_HOST: api
BASE_URL:
volumes: volumes:
- "${MOUNT_DATA}:/data:ro" - "${MOUNT_DATA}:/data:ro"
ports: ports: