tyler.durden
/
docker-webtop
mirror of https://github.com/linuxserver/docker-webtop.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update formatting to include the default param to cover copy and pasting

This commit is contained in:
thelamer 2021-06-25 16:55:09 -07:00 committed by Ryan Kuba
parent f268889316
commit a78c985c1b
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -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 |

5
readme-vars.yml
View File

@ -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