Skip to content

Commit 2562718

Browse files
committed
syntax and readme updates
1 parent 72bc2a3 commit 2562718

4 files changed

Lines changed: 11 additions & 34 deletions

File tree

Dockerfile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# syntax=docker/dockerfile:1
2+
13
FROM ghcr.io/linuxserver/baseimage-selkies:alpine322
24

35
# set version label
@@ -43,6 +45,6 @@ RUN \
4345
COPY /root /
4446

4547
# ports and volumes
46-
EXPOSE 3000
48+
EXPOSE 3001
4749

4850
VOLUME /config

Dockerfile.aarch64

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# syntax=docker/dockerfile:1
2+
13
FROM ghcr.io/linuxserver/baseimage-selkies:arm64v8-alpine322
24

35
# set version label
@@ -43,6 +45,6 @@ RUN \
4345
COPY /root /
4446

4547
# ports and volumes
46-
EXPOSE 3000
48+
EXPOSE 3001
4749

4850
VOLUME /config

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -251,21 +251,16 @@ services:
251251
webtop:
252252
image: lscr.io/linuxserver/webtop:latest
253253
container_name: webtop
254-
security_opt:
255-
- seccomp:unconfined #optional
256254
environment:
257255
- PUID=1000
258256
- PGID=1000
259257
- TZ=Etc/UTC
260-
- SUBFOLDER=/ #optional
261-
- TITLE=Webtop #optional
262258
volumes:
263259
- /path/to/data:/config
264-
- /var/run/docker.sock:/var/run/docker.sock #optional
265260
ports:
266261
- 3000:3000
267262
- 3001:3001
268-
shm_size: "1gb" #optional
263+
shm_size: "1gb"
269264
restart: unless-stopped
270265
```
271266
@@ -274,17 +269,13 @@ services:
274269
```bash
275270
docker run -d \
276271
--name=webtop \
277-
--security-opt seccomp=unconfined `#optional` \
278272
-e PUID=1000 \
279273
-e PGID=1000 \
280274
-e TZ=Etc/UTC \
281-
-e SUBFOLDER=/ `#optional` \
282-
-e TITLE=Webtop `#optional` \
283275
-p 3000:3000 \
284276
-p 3001:3001 \
285277
-v /path/to/data:/config \
286-
-v /var/run/docker.sock:/var/run/docker.sock `#optional` \
287-
--shm-size="1gb" `#optional` \
278+
--shm-size="1gb" \
288279
--restart unless-stopped \
289280
lscr.io/linuxserver/webtop:latest
290281
```
@@ -300,12 +291,8 @@ Containers are configured using parameters passed at runtime (such as those abov
300291
| `-e PUID=1000` | for UserID - see below for explanation |
301292
| `-e PGID=1000` | for GroupID - see below for explanation |
302293
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
303-
| `-e SUBFOLDER=/` | Specify a subfolder to use with reverse proxies, IE `/subfolder/` |
304-
| `-e TITLE=Webtop` | String which will be used as page/tab title in the web browser. |
305294
| `-v /config` | abc users home directory |
306-
| `-v /var/run/docker.sock` | Docker Socket on the system, if you want to use Docker in the container |
307-
| `--shm-size=` | We set this to 1 gig to prevent modern web browsers from crashing |
308-
| `--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. |
295+
| `--shm-size=` | Recommended for all desktop images. |
309296

310297
## Environment variables from files (Docker secrets)
311298

readme-vars.yml

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,22 +46,8 @@ param_usage_include_ports: true
4646
param_ports:
4747
- {external_port: "3000", internal_port: "3000", port_desc: "Web Desktop GUI HTTP, must be proxied"}
4848
- {external_port: "3001", internal_port: "3001", port_desc: "Web Desktop GUI HTTPS"}
49-
param_usage_include_env: true
50-
param_env_vars:
51-
- {env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
52-
# optional variables
53-
opt_param_usage_include_env: true
54-
opt_param_env_vars:
55-
- {env_var: "SUBFOLDER", env_value: "/", desc: "Specify a subfolder to use with reverse proxies, IE `/subfolder/`"}
56-
- {env_var: "TITLE", env_value: "Webtop", desc: "String which will be used as page/tab title in the web browser."}
57-
opt_param_usage_include_vols: true
58-
opt_param_volumes:
59-
- {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"}
60-
opt_custom_params:
61-
- {name: "shm-size", name_compose: "shm_size", value: "1gb", desc: "We set this to 1 gig to prevent modern web browsers from crashing"}
62-
opt_security_opt_param: true
63-
opt_security_opt_param_vars:
64-
- {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."}
49+
custom_params:
50+
- {name: "shm-size", name_compose: "shm_size", value: "1gb", desc: "Recommended for all desktop images."}
6551
# Selkies blurb settings
6652
selkies_blurb: true
6753
show_nvidia: true

0 commit comments

Comments
 (0)