From db8417d919b486e7f39dcea899c59201836cd07f Mon Sep 17 00:00:00 2001
From: SolomonTechnology <7052987f-303c-47f1-9584-e8b227ba3a60@happy-mochi.com>
Date: Tue, 14 Jan 2025 00:25:49 +1000
Subject: [PATCH] Improve documentation for the "port" and "site_url" env
 variables

---
 compose.yaml | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/compose.yaml b/compose.yaml
index 7236653..33e76bd 100644
--- a/compose.yaml
+++ b/compose.yaml
@@ -7,6 +7,8 @@ services:
         restart: unless-stopped
         container_name: chhoto-url
         ports:
+            # If you changed the "port" environment variable, adjust accordingly
+            # The number after the colon should match the "port" environment variable
             - 4567:4567
         environment:
             # Change if you want to mount the database somewhere else.
@@ -18,11 +20,17 @@ services:
             # a copy of your database.)
             - db_url=/db/urls.sqlite
 
-            # Change it in case you want to set the website name
-            # displayed in front of the shorturls, defaults to
-            # the hostname you're accessing it from.
+            # Change this if your server URL is not "http://localhost"
+            # This must not be surrounded by quotes. For example:
+            # site_url="https://www.example.com"   incorrect
+            # site_url=https://www.example.com     correct
+            # This is important to ensure Chhoto URL outputs the shortened link with the correct URL.
             # - site_url=https://www.example.com
 
+            # Change this if you are running Chhoto URL on a port which is not 4567.
+            # This is important to ensure Chhoto URL outputs the shortened link with the correct port.
+            # - port=4567
+            
             - password=TopSecretPass
 
             # This needs to be set in order to use programs that use the JSON interface of Chhoto URL.