From ae2344052a043190cf48138925c158b382c82a7b Mon Sep 17 00:00:00 2001
From: Jason Rothstein <fdragon@fdragon.org>
Date: Mon, 2 Jun 2025 05:02:24 +0000
Subject: [PATCH] Update README.md

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 82813c5..e9630e4 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
-# forgejo
+# Usage
+
+Check the environment variables for SecretSquirrels to hide/change, and then run : 
+
+```
+podman-compose pull
+podman-compose up -d
+```
+
+# Purpose
+
+Create containers for Forgejo, and MySQL. Only enabled for localhost access, no external.
+
+# Traffic Mapping for External Access
+
+If external access to this resource is desired, please configure HAProxy, HTTPD, or nginx with the following : 
+
+| External Port | Local Port | Protocol | URI Mapping | Description |
+| ------------- | ---------- | -------- | ----------- | ----------- |
+| 80            | XXX        | HTTP     | / redirect to port 443 | Force all unencrypted traffic to become TLS encrypted |
+| 80            | XXX        | HTTP     | /.well-known to disk | Enable LetsEncrypt to insert TLS certificates |
+| 443           | 3000       | HTTP     | / to port 3000 | This directs all gitea traffic to gitea |
+| 4000          | 4000       | TCP      | N/A         | Enable this to allow SSH access |