Skip to content

Commit ddbd0d6

Browse files
thelamerthelamer
committed
bad template vars in block
1 parent 82e7cff commit ddbd0d6

2 files changed

Lines changed: 116 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,116 @@ This image provides various versions that are available via tags. Please read th
8585

8686
## Application Setup
8787

88+
The Webtop can be accessed at:
89+
90+
* https://yourhost:3001/
91+
92+
**Modern GUI desktop apps have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp**
93+
94+
### Security
95+
96+
>[!WARNING]
97+
>Do not put this on the Internet if you do not know what you are doing.
98+
99+
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.
100+
101+
### Options in all Selkies based GUI containers
102+
103+
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies) which means there are additional environment variables and run configurations to enable or disable specific functionality.
104+
105+
#### Optional environment variables
106+
107+
| Variable | Description |
108+
| :----: | --- |
109+
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
110+
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
111+
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
112+
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
113+
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
114+
| TITLE | The page title displayed on the web browser, default "Selkies". |
115+
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
116+
| DISABLE_IPV6 | If set to true or any value this will disable IPv6 |
117+
| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` |
118+
| NO_DECOR | If set the application will run without window borders in openbox for use as a PWA. |
119+
| NO_FULL | Do not automatically fullscreen applications when using openbox. |
120+
121+
#### Optional run configurations
122+
123+
| Variable | Description |
124+
| :----: | --- |
125+
| `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. |
126+
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
127+
128+
### Language Support - Internationalization
129+
130+
The environment variable `LC_ALL` can be used to start this container in a different language than English simply pass for example to launch the Desktop session in French `LC_ALL=fr_FR.UTF-8`. Some supported languages:
131+
132+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
133+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
134+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
135+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
136+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
137+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
138+
* `-e LC_ALL=de_DE.UTF-8` - German
139+
* `-e LC_ALL=fr_FR.UTF-8` - French
140+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
141+
* `-e LC_ALL=it_IT.UTF-8` - Italian
142+
143+
### Nvidia GPU Support
144+
145+
**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers**
146+
147+
Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags:
148+
149+
| Variable | Description |
150+
| :----: | --- |
151+
| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system |
152+
| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host |
153+
154+
The compose syntax is slightly different for this as you will need to set nvidia as the default runtime:
155+
156+
```
157+
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
158+
sudo service docker restart
159+
```
160+
161+
And to assign the GPU in compose:
162+
163+
```
164+
services:
165+
webtop:
166+
image: lscr.io/linuxserver/webtop:ubuntu-xfce
167+
deploy:
168+
resources:
169+
reservations:
170+
devices:
171+
- driver: nvidia
172+
count: 1
173+
capabilities: [compute,video,graphics,utility]
174+
```
175+
176+
### Application management
177+
178+
#### PRoot Apps
179+
180+
If you run system native installations of software IE `sudo apt-get install filezilla` and then upgrade or destroy/re-create the container that software will be removed and the container will be at a clean state. For some users that will be acceptable and they can update their system packages as well using system native commands like `apt-get upgrade`. If you want Docker to handle upgrading the container and retain your applications and settings we have created [proot-apps](https://github.com/linuxserver/proot-apps) which allow portable applications to be installed to persistent storage in the user's `$HOME` directory and they will work in a confined Docker environment out of the box. These applications and their settings will persist upgrades of the base container and can be mounted into different flavors ofSelkiess based containers on the fly. This can be achieved from the command line with:
181+
182+
```
183+
proot-apps install filezilla
184+
```
185+
186+
PRoot Apps is included in all Selkies based containers, a list of linuxserver.io supported applications is located [HERE](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps).
187+
188+
#### Native Apps
189+
190+
It is possible to install extra packages during container start using [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install). It might increase starting time significantly. PRoot is preferred.
191+
192+
```yaml
193+
environment:
194+
- DOCKER_MODS=linuxserver/mods:universal-package-install
195+
- INSTALL_PACKAGES=libfuse2|git|gdb
196+
```
197+
88198
### Strict reverse proxies
89199
90200
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.

‎readme-vars.yml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ app_setup_block: |
7070
7171
### Security
7272
73-
{{ "Do not put this on the Internet if you do not know what you are doing." | admonition(flavour=markdown, severity="warning") }}
73+
>[!WARNING]
74+
>Do not put this on the Internet if you do not know what you are doing.
7475
7576
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.
7677
@@ -82,8 +83,8 @@ app_setup_block: |
8283
8384
| Variable | Description |
8485
| :----: | --- |
85-
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default {% if external_http_port is defined %}{{ external_http_port }}{% else %}3000{% endif %}. |
86-
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default {% if external_https_port is defined %}{{ external_https_port }}{% else %}3001{% endif %}. |
86+
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
87+
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
8788
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
8889
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
8990
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
@@ -138,8 +139,8 @@ app_setup_block: |
138139
139140
```
140141
services:
141-
{{ project_name }}:
142-
image: lscr.io/{{ lsio_project_name_short }}/{{ project_name }}:{{ release_tag }}
142+
webtop:
143+
image: lscr.io/linuxserver/webtop:ubuntu-xfce
143144
deploy:
144145
resources:
145146
reservations:

0 commit comments

Comments
 (0)