Skip to content

Commit 1e8e84d

Browse files
author
Simon Hofmann
committed
Updated readme
1 parent fa496fa commit 1e8e84d

1 file changed

Lines changed: 23 additions & 19 deletions

File tree

README.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Docker container images with "headless" VNC session
22

3-
The repository contains a collection of Docker images with headless VNC environments.
3+
This repository contains a collection of Docker images with headless VNC environments.
44

55
Each Docker image is installed with the following components:
66

@@ -41,27 +41,27 @@ It's also possible to run the images in container orchestration platforms like [
4141
* [OpenShift usage of "headless" VNC Docker images](./openshift/README.md)
4242

4343
## Usage
44-
The usage is for all provide images **similar**, for instance see following the usage of the `consol/centos-xfce-vnc` image:
44+
Usage is **similar** for all provided images, e.g. for `consol/centos-xfce-vnc`:
4545

46-
Print out help page:
46+
- Print out help page:
4747

48-
docker run consol/centos-xfce-vnc --help
48+
docker run consol/centos-xfce-vnc --help
4949

50-
Run command with mapping to local port `5901` (vnc protocol) and `6901` (vnc web access):
50+
- Run command with mapping to local port `5901` (vnc protocol) and `6901` (vnc web access):
5151

52-
docker run -d -p 5901:5901 -p 6901:6901 consol/centos-xfce-vnc
52+
docker run -d -p 5901:5901 -p 6901:6901 consol/centos-xfce-vnc
5353

54-
Change the default user and group within a container to your own with adding `--user $(id -u):$(id -g)`:
54+
- Change the default user and group within a container to your own with adding `--user $(id -u):$(id -g)`:
5555

56-
docker run -d -p 5901:5901 -p 6901:6901 --user $(id -u):$(id -g) consol/centos-xfce-vnc
56+
docker run -d -p 5901:5901 -p 6901:6901 --user $(id -u):$(id -g) consol/centos-xfce-vnc
5757

58-
If you want to get into the container use interactive mode `-it` and `bash`
58+
- If you want to get into the container use interactive mode `-it` and `bash`
59+
60+
docker run -it -p 5901:5901 -p 6901:6901 consol/centos-xfce-vnc bash
5961

60-
docker run -it -p 5901:5901 -p 6901:6901 consol/centos-xfce-vnc bash
62+
- Build an image from scratch:
6163

62-
Build an image from scratch:
63-
64-
docker build -t consol/centos-xfce-vnc centos-xfce-vnc
64+
docker build -t consol/centos-xfce-vnc centos-xfce-vnc
6565

6666
# Connect & Control
6767
If the container is started like mentioned above, connect via one of these options:
@@ -74,24 +74,27 @@ If the container is started like mentioned above, connect via one of these optio
7474
## Hints
7575

7676
### 1) Extend a Image with your own software
77-
Since `1.1.0` all images run as non-root user per default, so that means, if you want to extend the image and install software, you have to switch in the `Dockerfile` back to the `root` user:
77+
Since version `1.1.0` all images run as non-root user per default, so if you want to extend the image and install software, you have to switch back to the `root` user:
7878

7979
```bash
8080
## Custom Dockerfile
8181
FROM consol/centos-xfce-vnc
8282
ENV REFRESHED_AT 2018-03-18
8383

84-
## Install a gedit
84+
# Switch to root user to install additional software
8585
USER 0
86+
87+
## Install a gedit
8688
RUN yum install -y gedit \
8789
&& yum clean all
90+
8891
## switch back to default user
8992
USER 1000
9093
```
9194

9295
### 2) Change User of running Sakuli Container
9396

94-
Per default, since version `1.3.0` all container processes will executed with user id `1000`. You can change the user id like follow:
97+
Per default, since version `1.3.0` all container processes will be executed with user id `1000`. You can change the user id as follows:
9598

9699
#### 2.1) Using root (user id `0`)
97100
Add the `--user` flag to your docker run command:
@@ -122,7 +125,7 @@ the docker run command:
122125
docker run -it -p 5901:5901 -p 6901:6901 -e VNC_RESOLUTION=800x600 consol/centos-xfce-vnc
123126

124127
### 4) View only VNC
125-
Since version `1.2.0` it's possible to prevent unwanted control over VNC. Therefore you can set the environment variable `VNC_VIEW_ONLY=true`. If set the docker startup script will create a random cryptic password for the control connection and use the value of `VNC_PW` for the view only connection over the VNC connection.
128+
Since version `1.2.0` it's possible to prevent unwanted control via VNC. Therefore you can set the environment variable `VNC_VIEW_ONLY=true`. If set, the startup script will create a random password for the control connection and use the value of `VNC_PW` for view only connection over the VNC connection.
126129

127130
docker run -it -p 5901:5901 -p 6901:6901 -e VNC_VIEW_ONLY=true consol/centos-xfce-vnc
128131

@@ -142,10 +145,11 @@ See **[how-to-release.md](./how-to-release.md)**
142145

143146
At this point we want to thank all contributors, which helped to move this great project by submitting code, writing documentation, or adapting other tools to play well together with the docker headless container.
144147

145-
* [Tobias Schneck](https://github.com/toschneck) - Lead Development
146-
* [Robert Bohne](https://github.com/rbo) - IceWM Images
148+
* [Tobias Schneck](https://github.com/toschneck) - Lead development
149+
* [Robert Bohne](https://github.com/rbo) - IceWM images
147150
* [hsiaoyi0504](https://github.com/hsiaoyi0504) - PR [#66](https://github.com/ConSol/docker-headless-vnc-container/pull/66)
148151
* [dmhumph](https://github.com/dmhumph) - PR [#44](https://github.com/ConSol/docker-headless-vnc-container/issue/44)
152+
* [Simon Hofmann](https://github.com/s1hofmann) - Current maintainer
149153

150154
## Changelog
151155

0 commit comments

Comments
 (0)