From 609f5726a386ab9986d2766a9e6ffbb9abdc6d66 Mon Sep 17 00:00:00 2001 From: Jason Rothstein Date: Sun, 12 Apr 2020 17:55:39 -0500 Subject: [PATCH] Make the URI mapping easier to follow --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ea15db0..d963d72 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -# gitea -------- - # Usage -------- + +Check the environment variables for SecretSquirrels to hide/change, and then run : ``` docker-compose pull @@ -10,18 +8,16 @@ docker-compose up -d ``` # Purpose ---------- Create containers for Gitea, Mariadb, and phpMyAdmin. Only enabled for localhost access, no external. -# Limitations -------------- +# 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 | Suggestions | -| ------------- | ---------- | -------- | ----------- | -| 80 | XXX | HTTP | Redirect all traffic to 443 | -| 443 | 3000 | HTTP | Pass the URI / to local port 3000 for Gitea, and the URI /phpMyAdmin/ as / to local port 5000 for phpMyAdmin | -| 4000 | 4000 | TCP | SSH for GIT runs here, pass this traffic as-is | +| External Port | Local Port | Protocol | URI Mapping | Suggestions | +| ------------- | ---------- | -------- | ----------- | ----------- | +| 80 | XXX | HTTP | / | Redirect all traffic to 443 | Keep /.well-known local if you wish to use LetsEncrypt | +| 443 | 3000 | HTTP | / to port 3000, and /phpMyAdmin as / to port 4000 | Keep /.well-known local if you wish to use LetsEncrypt | +| 4000 | 4000 | TCP | N/A | Enable this to allow SSH access |