Files
docker-xubuntu/README.md
Héctor Molinero Fernández 429a9b7b8d Renamed default user
2021-06-01 21:19:43 +02:00

58 lines
1.7 KiB
Markdown

# Xubuntu on Docker
A Docker image based on Ubuntu 20.04 with the Xfce desktop environment,
[xrdp](https://github.com/neutrinolabs/xrdp),
[xrdp PulseAudio module](https://github.com/neutrinolabs/pulseaudio-module-xrdp) and
[VirtualGL](https://github.com/VirtualGL/virtualgl).
![Preview](img/preview.png)
## Start an instance
### Docker CLI
```sh
docker run \
--name xubuntu \
--detach \
--shm-size 2g \
--publish 3322:3322/tcp \
--publish 3389:3389/tcp \
--device /dev/dri:/dev/dri \
docker.io/hectormolinero/xubuntu:latest
```
### Docker Compose
```yaml
version: '3.9'
services:
xubuntu:
image: 'docker.io/hectormolinero/xubuntu:latest'
shm_size: '2gb'
ports:
- '3322:3322/tcp'
- '3389:3389/tcp'
devices:
- '/dev/dri:/dev/dri'
```
> You will be able to connect to the container via SSH through 3322/TCP port and RDP through 3389/TCP port.
> **Important:** some software (like Firefox) need the shared memory to be increased, if you
encounter any problem related to this you may use the `--shm-size` option.
## Environment variables
* `UNPRIVILEGED_USER_UID`: unprivileged user UID (`1000` by default).
* `UNPRIVILEGED_USER_GID`: unprivileged user GID (`1000` by default).
* `UNPRIVILEGED_USER_NAME`: unprivileged user name (`user` by default).
* `UNPRIVILEGED_USER_PASSWORD`: unprivileged user password (`password` by default).
* `UNPRIVILEGED_USER_GROUPS`: comma-separated list of additional GIDs for the unprivileged user (none by default).
* `UNPRIVILEGED_USER_SHELL`: unprivileged user shell (`/bin/bash` by default).
* `ENABLE_XDUMMY`: enable a dummy X server (`false` by default).
## License
See the [license](LICENSE.md) file.