syntax and readme updates

This commit is contained in:
thelamer 2025-09-23 12:32:18 -04:00
parent 78c0ebf196
commit 78b1d9efbe
No known key found for this signature in database
4 changed files with 13 additions and 12 deletions

View File

@ -1,3 +1,5 @@
# syntax=docker/dockerfile:1
FROM ghcr.io/linuxserver/baseimage-alpine:3.22 AS buildstage
ARG GITQLIENT_RELEASE
@ -65,6 +67,6 @@ RUN \
COPY /root /
# ports and volumes
EXPOSE 3000
EXPOSE 3001
VOLUME /config

View File

@ -1,3 +1,5 @@
# syntax=docker/dockerfile:1
FROM ghcr.io/linuxserver/baseimage-alpine:arm64v8-3.22 AS buildstage
ARG GITQLIENT_RELEASE
@ -65,6 +67,6 @@ RUN \
COPY /root /
# ports and volumes
EXPOSE 3000
EXPOSE 3001
VOLUME /config

View File

@ -78,6 +78,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.
@ -185,8 +187,6 @@ services:
gitqlient:
image: lscr.io/linuxserver/gitqlient:latest
container_name: gitqlient
security_opt:
- seccomp:unconfined #optional
environment:
- PUID=1000
- PGID=1000
@ -196,6 +196,7 @@ services:
ports:
- 3000:3000
- 3001:3001
shm_size: "1gb"
restart: unless-stopped
```
@ -204,13 +205,13 @@ services:
```bash
docker run -d \
--name=gitqlient \
--security-opt seccomp=unconfined `#optional` \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 3000:3000 \
-p 3001:3001 \
-v /path/to/config:/config \
--shm-size="1gb" \
--restart unless-stopped \
lscr.io/linuxserver/gitqlient:latest
```
@ -227,7 +228,7 @@ Containers are configured using parameters passed at runtime (such as those abov
| `-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). |
| `-v /config` | Users home directory in the container, stores local files and settings |
| `--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 |
| `--shm-size=` | Recommended for all desktop images. |
## Environment variables from files (Docker secrets)

View File

@ -17,9 +17,6 @@ development_versions: false
# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_env: true
param_env_vars:
- {env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London."}
param_usage_include_vols: true
param_volumes:
- {vol_path: "/config", vol_host_path: "/path/to/config", desc: "Users home directory in the container, stores local files and settings"}
@ -27,9 +24,8 @@ param_usage_include_ports: true
param_ports:
- {external_port: "3000", internal_port: "3000", port_desc: "HTTP GitQlient desktop gui, must be proxied."}
- {external_port: "3001", internal_port: "3001", port_desc: "HTTPS GitQlient desktop gui."}
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"}
custom_params:
- {name: "shm-size", name_compose: "shm_size", value: "1gb", desc: "Recommended for all desktop images."}
# Selkies blurb settings
selkies_blurb: true
# application setup block