Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Simon Hofmann committed Sep 3, 2018
1 parent a3950c4 commit 45777cb
Showing 1 changed file with 23 additions and 19 deletions.
42 changes: 23 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Docker container images with "headless" VNC session

The repository contains a collection of Docker images with headless VNC environments.
This repository contains a collection of Docker images with headless VNC environments.

Each Docker image is installed with the following components:

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

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

Print out help page:
- Print out help page:

docker run consol/centos-xfce-vnc --help
docker run consol/centos-xfce-vnc --help

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

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

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

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

If you want to get into the container use interactive mode `-it` and `bash`
- If you want to get into the container use interactive mode `-it` and `bash`

docker run -it -p 5901:5901 -p 6901:6901 consol/centos-xfce-vnc bash

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

Build an image from scratch:

docker build -t consol/centos-xfce-vnc centos-xfce-vnc
docker build -t consol/centos-xfce-vnc centos-xfce-vnc

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

### 1) Extend a Image with your own software
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:
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:

```bash
## Custom Dockerfile
FROM consol/centos-xfce-vnc
ENV REFRESHED_AT 2018-03-18

## Install a gedit
# Switch to root user to install additional software
USER 0

## Install a gedit
RUN yum install -y gedit \
&& yum clean all

## switch back to default user
USER 1000
```

### 2) Change User of running Sakuli Container

Per default, since version `1.3.0` all container processes will executed with user id `1000`. You can change the user id like follow:
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:

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

### 4) View only VNC
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.
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.

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

Expand All @@ -139,10 +142,11 @@ Thx @raghavkarol for the hint!

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.

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

## Changelog

Expand Down

0 comments on commit 45777cb

Please sign in to comment.