From e83d6625552b0b942e9ac09b6a6eee33ef659f37 Mon Sep 17 00:00:00 2001 From: Andrew <63025323+ScriptInfra@users.noreply.github.com> Date: Fri, 18 Mar 2022 07:06:40 -0400 Subject: [PATCH] Doc: Update docker-compose.server.yml (#6283) --- docker-compose.server.yml | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docker-compose.server.yml b/docker-compose.server.yml index a4046b02b5..e89dc6b0a0 100644 --- a/docker-compose.server.yml +++ b/docker-compose.server.yml @@ -1,8 +1,19 @@ # This is a sample docker-compose file that can be used to run Joplin Server # along with a PostgreSQL server. # -# All environment variables are optional. If you don't set them, you will get a -# warning from docker-compose, however the app should use working defaults. +# Update the following fields in the stanza below: +# +# POSTGRES_USER +# POSTGRES_PASSWORD +# APP_BASE_URL +# +# APP_BASE_URL: This is the base public URL where the service will be running. +# - If Joplin Server needs to be accessible over the internet, configure APP_BASE_URL as follows: https://example.com/joplin. +# - If Joplin Server does not need to be accessible over the internet, set the the APP_BASE_URL to your server's hostname. +# For Example: http://[hostname]:22300. The base URL can include the port. +# APP_PORT: The local port on which the Docker container will listen. +# - This would typically be mapped to port to 443 (TLS) with a reverse proxy. +# - If Joplin Server does not need to be accessible over the internet, the port can be mapped to 22300. version: '3'