From 46e786b219fc2dfa9407785eb54be9cac7e3e532 Mon Sep 17 00:00:00 2001 From: Hyperling Date: Thu, 30 Oct 2025 07:18:45 -0700 Subject: [PATCH] Update readme for Markdown best practices. --- Config/ReverseProxy/README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/Config/ReverseProxy/README.md b/Config/ReverseProxy/README.md index 0a58732..544d6a5 100644 --- a/Config/ReverseProxy/README.md +++ b/Config/ReverseProxy/README.md @@ -1,5 +1,7 @@ # Initial Setup Instructions + How to first begin using this subproject. + 1. Move to the directory of this README. ``` $ cd $DOCKER_HOME/Config/ReverseProxy @@ -10,6 +12,7 @@ How to first begin using this subproject. # ./create_placeholder_certs.sh ``` 1. Make any personal changes to `./config/nginx.conf`. +1. Copy the example files as `docker-compose.yml` and `.env`. 1. Build the project. ``` # docker compose build @@ -20,8 +23,8 @@ How to first begin using this subproject. ``` 1. Verify it started correctly, no configuration file errors. ``` - # docker logs reverseproxy-app-1 - # docker logs reverseproxy-certbot-1 + # docker logs rp-app + # docker logs rp-certbot ``` 1. Create the real certificates. ``` @@ -34,6 +37,7 @@ How to first begin using this subproject. ``` ## DO NOT + * Edit any configurations or website data inside the container. It is destroyed on each build. * Instead, modify the files in `./config/` then use the Update Config commands below. * Install any additional software inside of the container. It will not persist a down and up. @@ -41,17 +45,22 @@ How to first begin using this subproject. * Alternatively write a script such as `../Nextcloud/fixes.ksh` which is run after every upgrade. # Other Commands + Tasks which will also likely come up while using this subproject. ## Stop + If the proxy needs turned off either stop or down may be used. + ``` # docker compose stop # docker compose down ``` ## Upgrade + Upgrading the containers should be as easy as this: + ``` # docker compose down # docker compose pull @@ -60,15 +69,19 @@ Upgrading the containers should be as easy as this: ``` ## Update Config + Replace the configuration based on any new, updated, or removed files. This may be possible to do when the system is up, but the best results have come from going down and back up. This is essentially an upgrade but there is no pull. + ``` # docker compose down # docker compose build # docker compose up -d ``` + If wanted as a one-line command: + ``` # docker compose down && docker compose build && docker compose up -d ```