Skip to content

Commit b303d27

Browse files
thelamerthelamer
committed
use burb for readme
1 parent 0eab661 commit b303d27

2 files changed

Lines changed: 94 additions & 56 deletions

File tree

‎README.md‎

Lines changed: 91 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
66
[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://linuxserver.io/discord "realtime support / chat with the community and the team.")
77
[![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.")
8-
[![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
98
[![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.")
109
[![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
1110

@@ -22,7 +21,6 @@ Find us at:
2221
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2322
* [Discord](https://linuxserver.io/discord) - realtime support / chat with the community and the team.
2423
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
25-
* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
2624
* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
2725
* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
2826

@@ -55,41 +53,97 @@ The architectures supported by this image are:
5553
| :----: | :----: | ---- |
5654
| x86-64 | ✅ | amd64-\<version tag\> |
5755
| arm64 | ❌ | |
58-
| armhf | ❌ | |
5956

6057
## Application Setup
6158

6259
The application can be accessed at:
6360

6461
* https://yourhost:3001/
6562

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.**
6669

6770
### Security
6871

6972
>[!WARNING]
70-
>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.
7174
72-
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.
7376

74-
### 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.
7580

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

78-
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
7986

8087
| Variable | Description |
8188
| :----: | --- |
82-
| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system |
83-
| --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. |
84138

85-
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:
86140

87141
```
88142
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
89-
sudo service docker restart
143+
sudo systemctl restart docker
90144
```
91145

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

94148
```
95149
services:
@@ -104,10 +158,31 @@ services:
104158
capabilities: [compute,video,graphics,utility]
105159
```
106160

107-
### Strict reverse proxies
161+
### Application Management
108162

109-
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
110-
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+
```
111186
112187
## Usage
113188

‎readme-vars.yml‎

Lines changed: 3 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -31,53 +31,16 @@ custom_params:
3131
opt_security_opt_param: true
3232
opt_security_opt_param_vars:
3333
- {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."}
34+
# Selkies blurb settings
35+
selkies_blurb: true
36+
show_nvidia: true
3437
# application setup block
3538
app_setup_block_enabled: true
3639
app_setup_block: |
3740
The application can be accessed at:
3841
3942
* https://yourhost:3001/
4043
41-
42-
### Security
43-
44-
>[!WARNING]
45-
>Do not put this on the Internet if you do not know what you are doing.
46-
47-
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.
48-
49-
### Nvidia GPU Support
50-
51-
**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers**
52-
53-
Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags:
54-
55-
| Variable | Description |
56-
| :----: | --- |
57-
| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system |
58-
| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host |
59-
60-
The compose syntax is slightly different for this as you will need to set nvidia as the default runtime:
61-
62-
```
63-
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
64-
sudo service docker restart
65-
```
66-
67-
And to assign the GPU in compose:
68-
69-
```
70-
services:
71-
pcsx2:
72-
image: lscr.io/linuxserver/pcsx2:latest
73-
deploy:
74-
resources:
75-
reservations:
76-
devices:
77-
- driver: nvidia
78-
count: 1
79-
capabilities: [compute,video,graphics,utility]
80-
```
8144
# init diagram
8245
init_diagram: |
8346
"pcsx2:latest": {

0 commit comments

Comments
 (0)