From 9b79877c702601a28e706a9cba7421af027edb0b Mon Sep 17 00:00:00 2001 From: Dominik Date: Thu, 3 Jan 2019 12:10:29 +0100 Subject: [PATCH] Add volume paths to readme --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3ce9579..b872013 100644 --- a/README.md +++ b/README.md @@ -24,14 +24,24 @@ The web interface will be available on port 5800 while the VNC server can be acc All listed configuration variables are required. -| Variable | Description | -|----------------|----------------------------------------------| -|`IDRAC_HOST`| Host for your iDRAC instance. Make sure your instance is reachable with https://. See IDRAC_PORT for using custom ports. HTTPS is always used. | -|`IDRAC_USER`| Username for your iDRAC instance. | -|`IDRAC_PASSWORD`| Password for your iDRAC instance. | -|`IDRAC_PORT`| The optional port for the web interface (443 by default) | +| Variable | Description | Required | +|----------------|----------------------------------------------|----------| +|`IDRAC_HOST`| Host for your iDRAC instance. Make sure your instance is reachable with https://. See IDRAC_PORT for using custom ports. HTTPS is always used. | Yes | +|`IDRAC_USER`| Username for your iDRAC instance. | Yes | +|`IDRAC_PASSWORD`| Password for your iDRAC instance. | Yes | +|`IDRAC_PORT`| The optional port for the web interface. (443 by default) | No | -For advanced configuration options please take a look [here](https://github.com/jlesage/docker-baseimage-gui#environment-variables). +**For advanced configuration options please take a look [here](https://github.com/jlesage/docker-baseimage-gui#environment-variables).** + +## Volumes + +| Path | Description | Required | +|------------|----------------------------------------------|----------| +|`/app`| Libraries downloaded from your iDRAC instance will be stored here. Add a volume to cache those files for a faster container startup. | No | +|`/vmedia`| Can be used to allow virtual media to be mounted. | No | +|`/screenshots`| Screenshots taken from the virtual console can be stored here. | No | + +Make sure the container user has read & write permission to these folders on the host. [More info here](https://github.com/jlesage/docker-baseimage-gui#usergroup-ids). ## Issues & limitations