syntax and readme updates

This commit is contained in:
thelamer 2025-09-23 14:47:58 -04:00
parent 72bc2a3558
commit 2562718546
No known key found for this signature in database
4 changed files with 11 additions and 34 deletions

View File

@ -1,3 +1,5 @@
# syntax=docker/dockerfile:1
FROM ghcr.io/linuxserver/baseimage-selkies:alpine322 FROM ghcr.io/linuxserver/baseimage-selkies:alpine322
# set version label # set version label
@ -43,6 +45,6 @@ RUN \
COPY /root / COPY /root /
# ports and volumes # ports and volumes
EXPOSE 3000 EXPOSE 3001
VOLUME /config VOLUME /config

View File

@ -1,3 +1,5 @@
# syntax=docker/dockerfile:1
FROM ghcr.io/linuxserver/baseimage-selkies:arm64v8-alpine322 FROM ghcr.io/linuxserver/baseimage-selkies:arm64v8-alpine322
# set version label # set version label
@ -43,6 +45,6 @@ RUN \
COPY /root / COPY /root /
# ports and volumes # ports and volumes
EXPOSE 3000 EXPOSE 3001
VOLUME /config VOLUME /config

View File

@ -251,21 +251,16 @@ services:
webtop: webtop:
image: lscr.io/linuxserver/webtop:latest image: lscr.io/linuxserver/webtop:latest
container_name: webtop container_name: webtop
security_opt:
- seccomp:unconfined #optional
environment: environment:
- PUID=1000 - PUID=1000
- PGID=1000 - PGID=1000
- TZ=Etc/UTC - TZ=Etc/UTC
- SUBFOLDER=/ #optional
- TITLE=Webtop #optional
volumes: volumes:
- /path/to/data:/config - /path/to/data:/config
- /var/run/docker.sock:/var/run/docker.sock #optional
ports: ports:
- 3000:3000 - 3000:3000
- 3001:3001 - 3001:3001
shm_size: "1gb" #optional shm_size: "1gb"
restart: unless-stopped restart: unless-stopped
``` ```
@ -274,17 +269,13 @@ services:
```bash ```bash
docker run -d \ docker run -d \
--name=webtop \ --name=webtop \
--security-opt seccomp=unconfined `#optional` \
-e PUID=1000 \ -e PUID=1000 \
-e PGID=1000 \ -e PGID=1000 \
-e TZ=Etc/UTC \ -e TZ=Etc/UTC \
-e SUBFOLDER=/ `#optional` \
-e TITLE=Webtop `#optional` \
-p 3000:3000 \ -p 3000:3000 \
-p 3001:3001 \ -p 3001:3001 \
-v /path/to/data:/config \ -v /path/to/data:/config \
-v /var/run/docker.sock:/var/run/docker.sock `#optional` \ --shm-size="1gb" \
--shm-size="1gb" `#optional` \
--restart unless-stopped \ --restart unless-stopped \
lscr.io/linuxserver/webtop:latest lscr.io/linuxserver/webtop:latest
``` ```
@ -300,12 +291,8 @@ Containers are configured using parameters passed at runtime (such as those abov
| `-e PUID=1000` | for UserID - see below for explanation | | `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation | | `-e PGID=1000` | for GroupID - see below for explanation |
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `-e SUBFOLDER=/` | Specify a subfolder to use with reverse proxies, IE `/subfolder/` |
| `-e TITLE=Webtop` | String which will be used as page/tab title in the web browser. |
| `-v /config` | abc users home directory | | `-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=` | Recommended for all desktop images. |
| `--shm-size=` | We set this to 1 gig to prevent modern web browsers from crashing |
| `--security-opt seccomp=unconfined` | For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. |
## Environment variables from files (Docker secrets) ## Environment variables from files (Docker secrets)

View File

@ -46,22 +46,8 @@ param_usage_include_ports: true
param_ports: param_ports:
- {external_port: "3000", internal_port: "3000", port_desc: "Web Desktop GUI HTTP, must be proxied"} - {external_port: "3000", internal_port: "3000", port_desc: "Web Desktop GUI HTTP, must be proxied"}
- {external_port: "3001", internal_port: "3001", port_desc: "Web Desktop GUI HTTPS"} - {external_port: "3001", internal_port: "3001", port_desc: "Web Desktop GUI HTTPS"}
param_usage_include_env: true custom_params:
param_env_vars: - {name: "shm-size", name_compose: "shm_size", value: "1gb", desc: "Recommended for all desktop images."}
- {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/`"}
- {env_var: "TITLE", env_value: "Webtop", desc: "String which will be used as page/tab title in the web browser."}
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"}
opt_custom_params:
- {name: "shm-size", name_compose: "shm_size", value: "1gb", desc: "We set this to 1 gig to prevent modern web browsers from crashing"}
opt_security_opt_param: true
opt_security_opt_param_vars:
- {run_var: "seccomp=unconfined", compose_var: "seccomp:unconfined", desc: "For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker."}
# Selkies blurb settings # Selkies blurb settings
selkies_blurb: true selkies_blurb: true
show_nvidia: true show_nvidia: true