From a78c985c1bb625748d51aa10a25a57421fb4892a Mon Sep 17 00:00:00 2001
From: thelamer <ryankuba@gmail.com>
Date: Fri, 25 Jun 2021 16:55:09 -0700
Subject: [PATCH] update formatting to include the default param to cover copy
 and pasting

---
 README.md       | 5 +++--
 readme-vars.yml | 5 +++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 0e57ebe5..e04436f2 100644
--- a/README.md
+++ b/README.md
@@ -92,8 +92,6 @@ You can access advanced features of the Guacamole remote desktop using ctrl+alt+
 
 **The KDE and i3 flavors for Ubuntu need to be run in privileged mode to function properly**
 
-**If using a reverse proxy with a subfolder please use the `SUBFOLDER` environment variable to define it's name, IE `-e SUBFOLDER="/subfolder/"`**
-
 If you ever lose your password you can always reset it by execing into the container as root:
 ```
 docker exec -it webtop passwd abc
@@ -121,6 +119,7 @@ services:
       - PUID=1000
       - PGID=1000
       - TZ=Europe/London
+      - SUBFOLDER=/ #optional
     volumes:
       - /path/to/data:/config
       - /var/run/docker.sock:/var/run/docker.sock #optional
@@ -139,6 +138,7 @@ docker run -d \
   -e PUID=1000 \
   -e PGID=1000 \
   -e TZ=Europe/London \
+  -e SUBFOLDER=/ `#optional` \
   -p 3000:3000 \
   -v /path/to/data:/config \
   -v /var/run/docker.sock:/var/run/docker.sock `#optional` \
@@ -157,6 +157,7 @@ Container images are configured using parameters passed at runtime (such as thos
 | `-e PUID=1000` | for UserID - see below for explanation |
 | `-e PGID=1000` | for GroupID - see below for explanation |
 | `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London |
+| `-e SUBFOLDER=/` | Specify a subfolder to use with reverse proxies, IE `/subfolder/` |
 | `-v /config` | abc users home directory |
 | `-v /var/run/docker.sock` | Docker Socket on the system, if you want to use Docker in the container |
 | `--shm-size=` | We set this to 1 gig to prevent modern web browsers from crashing |
diff --git a/readme-vars.yml b/readme-vars.yml
index 093da3b3..28b85b87 100644
--- a/readme-vars.yml
+++ b/readme-vars.yml
@@ -43,6 +43,9 @@ param_usage_include_env: true
 param_env_vars:
   - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
 # optional variables
+opt_param_usage_include_env: true
+opt_param_env_vars:
+  - { env_var: "SUBFOLDER", env_value: "/", desc: "Specify a subfolder to use with reverse proxies, IE `/subfolder/`"}
 opt_param_usage_include_vols: true
 opt_param_volumes:
   - { vol_path: "/var/run/docker.sock", vol_host_path: "/var/run/docker.sock", desc: "Docker Socket on the system, if you want to use Docker in the container" }
@@ -66,8 +69,6 @@ app_setup_block: |
 
   **The KDE and i3 flavors for Ubuntu need to be run in privileged mode to function properly**
 
-  **If using a reverse proxy with a subfolder please use the `SUBFOLDER` environment variable to define it's name, IE `-e SUBFOLDER="/subfolder/"`**
-  
   If you ever lose your password you can always reset it by execing into the container as root:
   ```
   docker exec -it webtop passwd abc