From e3a3608b8c7951370847dcf00a143166b8b7ec07 Mon Sep 17 00:00:00 2001
From: SolninjaA <51935570+SolninjaA@users.noreply.github.com>
Date: Tue, 14 Jan 2025 00:31:51 +1000
Subject: [PATCH] Update README.md

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index ff38c80..5e9117a 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,20 @@ Alternatively, using Docker Run, you can add `-e api_key="SECURE_API_KEY" \` to
 
 For example, on Linux, you could generate an API key by running `tr -dc A-Za-z0-9 </dev/urandom | head -c 128`
 
+### Ensure `site_url` and `port` are correct
+In order for the Chhoto URL server to properly output the correct shortend URLs, and for this extension to do the same, the `site_url` and `port` environment variables must be properly set.
+
+If your server is not located at `http://localhost`, make sure to set the `site_url` environment variable in the Chhoto URL server configuration. This value cannot be surrounded by quotes.
+
+If your server's port is not `4567`, make sure to set the `port` environment variable in the Chhoto URL server configuration. This value cannot be surrounded by quotes.
+
+Example configuration:
+```yaml
+environment:
+    - site_url=https://chhoto-url.example.com
+    - port=443
+```
+
 ## Installation
 *This extension will be published to extension stores in the near future*