Updated readme
This commit is contained in:
36
README.md
36
README.md
@@ -7,6 +7,8 @@ A Docker image based on Ubuntu 20.04 with the Xfce desktop environment,
|
|||||||
|
|
||||||
## Start an instance
|
## Start an instance
|
||||||
|
|
||||||
|
### Docker CLI
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
docker run \
|
docker run \
|
||||||
--name xubuntu \
|
--name xubuntu \
|
||||||
@@ -15,7 +17,22 @@ docker run \
|
|||||||
--publish 3322:3322/tcp \
|
--publish 3322:3322/tcp \
|
||||||
--publish 3389:3389/tcp \
|
--publish 3389:3389/tcp \
|
||||||
--device /dev/dri:/dev/dri \
|
--device /dev/dri:/dev/dri \
|
||||||
hectormolinero/xubuntu:latest
|
docker.io/hectormolinero/xubuntu:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
### Docker Compose
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
version: '3.8'
|
||||||
|
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.
|
> You will be able to connect to the container via SSH through 3322/tcp port and RDP through 3389/tcp port.
|
||||||
@@ -23,23 +40,6 @@ docker run \
|
|||||||
> **Important:** some software (like Firefox) need the shared memory to be increased, if you
|
> **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.
|
encounter any problem related to this you may use the `--shm-size` option.
|
||||||
|
|
||||||
### Using `docker-compose`
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
version: '3.8'
|
|
||||||
services:
|
|
||||||
xubuntu:
|
|
||||||
image: hectormolinero/xubuntu:latest
|
|
||||||
ports:
|
|
||||||
- 3322:3322/tcp
|
|
||||||
- 3389:3389/tcp
|
|
||||||
devices:
|
|
||||||
- /dev/dri:/dev/dri
|
|
||||||
shm_size: 2gb
|
|
||||||
tmpfs:
|
|
||||||
- /tmp
|
|
||||||
```
|
|
||||||
|
|
||||||
## Environment variables
|
## Environment variables
|
||||||
|
|
||||||
* `UNPRIVILEGED_USER_UID`: unprivileged user UID (`1000` by default).
|
* `UNPRIVILEGED_USER_UID`: unprivileged user UID (`1000` by default).
|
||||||
|
|||||||
Reference in New Issue
Block a user