Skip to content

Commit b2fbc94

Browse files
thelamerthelamer
committed
use blurb
1 parent b93fc00 commit b2fbc94

File tree

2 files changed

+94
-53
lines changed

2 files changed

+94
-53
lines changed

‎README.md‎

Lines changed: 91 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,33 +60,90 @@ The application can be accessed at:
6060

6161
* https://yourhost:3001/
6262

63+
### Strict reverse proxies
64+
65+
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
66+
If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy).
67+
68+
**Modern GUI desktop apps may have compatibility issues with the latest Docker syscall restrictions. You can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp versions.**
6369

6470
### Security
6571

6672
>[!WARNING]
67-
>Do not put this on the Internet if you do not know what you are doing.
73+
>This container provides privileged access to the host system. Do not expose it to the Internet unless you have secured it properly.
6874
69-
By default this container has no authentication and the optional environment variables `CUSTOM_USER` and `PASSWORD` to enable basic http auth via the embedded NGINX server should only be used to locally secure the container from unwanted access on a local network. If exposing this to the Internet we recommend putting it behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), and ensuring a secure authentication solution is in place. From the web interface a terminal can be launched and it is configured for passwordless sudo, so anyone with access to it can install and run whatever they want along with probing your local network.
75+
**HTTPS is required for full functionality.** Modern browser features such as WebCodecs, used for video and audio, will not function over an insecure HTTP connection.
7076

71-
### Nvidia GPU Support
77+
By default, this container has no authentication. The optional `CUSTOM_USER` and `PASSWORD` environment variables enable basic HTTP auth, which is suitable only for securing the container on a trusted local network. For internet exposure, we strongly recommend placing the container behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), with a robust authentication mechanism.
78+
79+
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.
7280

73-
**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers**
81+
### Options in all Selkies-based GUI containers
7482

75-
Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags:
83+
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.
84+
85+
#### Optional Environment Variables
7686

7787
| Variable | Description |
7888
| :----: | --- |
79-
| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system |
80-
| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host |
89+
| `CUSTOM_PORT` | Internal HTTP port. Defaults to `3000`. |
90+
| `CUSTOM_HTTPS_PORT` | Internal HTTPS port. Defaults to `3001`. |
91+
| `CUSTOM_USER` | Username for HTTP Basic Auth. Defaults to `abc`. |
92+
| `PASSWORD` | Password for HTTP Basic Auth. If unset, authentication is disabled. |
93+
| `SUBFOLDER` | Application subfolder for reverse proxy configurations. Must include leading and trailing slashes, e.g., `/subfolder/`. |
94+
| `TITLE` | Page title displayed in the web browser. Defaults to "Selkies". |
95+
| `START_DOCKER` | If set to `false`, the privileged Docker-in-Docker setup will not start automatically. |
96+
| `DISABLE_IPV6` | Set to `true` to disable IPv6 support in the container. |
97+
| `LC_ALL` | Sets the container's locale, e.g., `fr_FR.UTF-8`. |
98+
| `NO_DECOR` | If set, applications will run without window borders, suitable for PWA usage. |
99+
| `NO_FULL` | If set, applications will not be automatically fullscreened. |
100+
| `DISABLE_ZINK` | If set, Zink-related environment variables will not be configured when a video card is detected. |
101+
| `WATERMARK_PNG` | Full path to a watermark PNG file inside the container, e.g., `/usr/share/selkies/www/icon.png`. |
102+
| `WATERMARK_LOCATION` | Integer specifying the watermark location: `1` (Top Left), `2` (Top Right), `3` (Bottom Left), `4` (Bottom Right), `5` (Centered), `6` (Animated). |
103+
104+
#### Optional Run Configurations
105+
106+
| Argument | Description |
107+
| :----: | --- |
108+
| `--privileged` | Starts a Docker-in-Docker (DinD) environment. For better performance, mount the Docker data directory from the host, e.g., `-v /path/to/docker-data:/var/lib/docker`. |
109+
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. |
110+
111+
### Language Support - Internationalization
112+
113+
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
114+
115+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
116+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
117+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
118+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
119+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
120+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
121+
* `-e LC_ALL=de_DE.UTF-8` - German
122+
* `-e LC_ALL=fr_FR.UTF-8` - French
123+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
124+
* `-e LC_ALL=it_IT.UTF-8` - Italian
125+
126+
### Nvidia GPU Support
127+
128+
**Note: Nvidia support is not available for Alpine-based images.**
129+
130+
Nvidia GPU support is available by leveraging Zink for OpenGL. When a compatible Nvidia GPU is passed through, it will also be **automatically utilized for hardware-accelerated video stream encoding** (using the `x264enc` full-frame profile), significantly reducing CPU load.
131+
132+
Enable Nvidia support with the following runtime flags:
133+
134+
| Flag | Description |
135+
| :----: | --- |
136+
| `--gpus all` | Passes all available host GPUs to the container. This can be filtered to specific GPUs. |
137+
| `--runtime nvidia` | Specifies the Nvidia runtime, which provides the necessary drivers and tools from the host. |
81138

82-
The compose syntax is slightly different for this as you will need to set nvidia as the default runtime:
139+
For Docker Compose, you must first configure the Nvidia runtime as the default on the host:
83140

84141
```
85142
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
86-
sudo service docker restart
143+
sudo systemctl restart docker
87144
```
88145

89-
And to assign the GPU in compose:
146+
Then, assign the GPU to the service in your `compose.yaml`:
90147

91148
```
92149
services:
@@ -101,10 +158,31 @@ services:
101158
capabilities: [compute,video,graphics,utility]
102159
```
103160

104-
### Strict reverse proxies
161+
### Application Management
105162

106-
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
107-
If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy).
163+
There are two methods for installing applications inside the container: PRoot Apps (recommended for persistence) and Native Apps.
164+
165+
#### PRoot Apps (Persistent)
166+
167+
Natively installed packages (e.g., via `apt-get install`) will not persist if the container is recreated. To retain applications and their settings across container updates, we recommend using [proot-apps](https://github.com/linuxserver/proot-apps). These are portable applications installed to the user's persistent `$HOME` directory.
168+
169+
To install an application, use the command line inside the container:
170+
171+
```
172+
proot-apps install filezilla
173+
```
174+
175+
A list of supported applications is available [here](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps).
176+
177+
#### Native Apps (Non-Persistent)
178+
179+
You can install packages from the system's native repository using the [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install) mod. This method will increase the container's start time and is not persistent. Add the following to your `compose.yaml`:
180+
181+
```yaml
182+
environment:
183+
- DOCKER_MODS=linuxserver/mods:universal-package-install
184+
- INSTALL_PACKAGES=libfuse2|git|gdb
185+
```
108186
109187
## Usage
110188

‎readme-vars.yml‎

Lines changed: 3 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -32,53 +32,16 @@ custom_params:
3232
opt_security_opt_param: true
3333
opt_security_opt_param_vars:
3434
- {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."}
35+
# Selkies blurb settings
36+
selkies_blurb: true
37+
show_nvidia: true
3538
# application setup block
3639
app_setup_block_enabled: true
3740
app_setup_block: |
3841
The application can be accessed at:
3942
4043
* https://yourhost:3001/
4144
42-
43-
### Security
44-
45-
>[!WARNING]
46-
>Do not put this on the Internet if you do not know what you are doing.
47-
48-
By default this container has no authentication and the optional environment variables `CUSTOM_USER` and `PASSWORD` to enable basic http auth via the embedded NGINX server should only be used to locally secure the container from unwanted access on a local network. If exposing this to the Internet we recommend putting it behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), and ensuring a secure authentication solution is in place. From the web interface a terminal can be launched and it is configured for passwordless sudo, so anyone with access to it can install and run whatever they want along with probing your local network.
49-
50-
### Nvidia GPU Support
51-
52-
**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers**
53-
54-
Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags:
55-
56-
| Variable | Description |
57-
| :----: | --- |
58-
| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system |
59-
| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host |
60-
61-
The compose syntax is slightly different for this as you will need to set nvidia as the default runtime:
62-
63-
```
64-
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
65-
sudo service docker restart
66-
```
67-
68-
And to assign the GPU in compose:
69-
70-
```
71-
services:
72-
xemu:
73-
image: lscr.io/linuxserver/xemu:latest
74-
deploy:
75-
resources:
76-
reservations:
77-
devices:
78-
- driver: nvidia
79-
count: 1
80-
capabilities: [compute,video,graphics,utility]
81-
```
8245
# init diagram
8346
init_diagram: |
8447
"xemu:latest": {

0 commit comments

Comments
 (0)