syntax and readme updates

This commit is contained in:
thelamer 2025-09-23 12:13:53 -04:00
parent eeb1b6c722
commit 79dac579fb
No known key found for this signature in database
4 changed files with 9 additions and 17 deletions

View File

@ -54,6 +54,6 @@ RUN \
COPY /root /
# ports and volumes
EXPOSE 3000
EXPOSE 3001
VOLUME /config

View File

@ -32,6 +32,6 @@ RUN \
COPY /root /
# ports and volumes
EXPOSE 3000
EXPOSE 3001
VOLUME /config

View File

@ -79,6 +79,8 @@ By default, this container has no authentication. The optional `CUSTOM_USER` and
The web interface includes a terminal with passwordless `sudo` access. Any user with access to the GUI can gain root control within the container, install arbitrary software, and probe your local network.
While not generally recommended, certain legacy environments specifically those with older hardware or outdated Linux distributions may require the deactivation of the standard seccomp profile to get containerized desktop software to run. This can be achieved by utilizing the `--security-opt seccomp=unconfined` parameter. It is critical to use this option only when absolutely necessary as it disables a key security layer of Docker, elevating the potential for container escape vulnerabilities.
### Options in all Selkies-based GUI containers
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies), which provides the following environment variables and run configurations to customize its functionality.
@ -221,18 +223,16 @@ services:
blender:
image: lscr.io/linuxserver/blender:latest
container_name: blender
security_opt:
- seccomp:unconfined #optional
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- SUBFOLDER=/ #optional
volumes:
- /path/to/blender/config:/config
ports:
- 3000:3000
- 3001:3001
shm_size: "1gb"
restart: unless-stopped
```
@ -241,14 +241,13 @@ services:
```bash
docker run -d \
--name=blender \
--security-opt seccomp=unconfined `#optional` \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e SUBFOLDER=/ `#optional` \
-p 3000:3000 \
-p 3001:3001 \
-v /path/to/blender/config:/config \
--shm-size="1gb" \
--restart unless-stopped \
lscr.io/linuxserver/blender:latest
```
@ -264,9 +263,8 @@ Containers are configured using parameters passed at runtime (such as those abov
| `-e PUID=1000` | for UserID - 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 SUBFOLDER=/` | Specify a subfolder to use with reverse proxies, IE `/subfolder/` |
| `-v /config` | Users home directory in the container, stores local files and settings |
| `--security-opt seccomp=unconfined` | For Docker Engine only, this may be required depending on your Docker and storage configuration. |
| `--shm-size=` | Recommended for all desktop images. |
## Environment variables from files (Docker secrets)

View File

@ -24,14 +24,8 @@ param_usage_include_ports: true
param_ports:
- {external_port: "3000", internal_port: "3000", port_desc: "Blender desktop gui"}
- {external_port: "3001", internal_port: "3001", port_desc: "Blender desktop gui HTTPS"}
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_devices:
- {device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "Add this for hardware acceleration (Linux hosts only)"}
opt_security_opt_param: true
opt_security_opt_param_vars:
- {run_var: "seccomp=unconfined", compose_var: "seccomp:unconfined", desc: "For Docker Engine only, this may be required depending on your Docker and storage configuration."}
custom_params:
- {name: "shm-size", name_compose: "shm_size", value: "1gb", desc: "Recommended for all desktop images."}
# Selkies blurb settings
selkies_blurb: true
show_nvidia: true