Merge 1787d56 into 86ef326

README.md

@@ -127,36 +127,37 @@ of settings in the (optional) per user configuration file (``~/.dockersh``), if
 Config file values
 ------------------
 
-Setting name  | Type | Description | Default value | Example value
-------------- | ---- | ----------- | ------------- | -------------
-imagename  | String | The name of the container image to launch for the user. The %u sequence will interpolate the username | busybox | ubuntu, or %u/mydockersh
+Setting name | Type | Description | Default value | Example value
+-------------|------|-------------|---------------|--------------
+imagename | String | The name of the container image to launch for the user. The %u sequence will interpolate the username. | busybox | ubuntu, or %u/mydockersh
 containername | String | The name of the container (per user) which is launched. | %u_dockersh | %u-dsh
-mounthome | Bool | If the users home directory should be mounted in the target container | false | true
+mounthome | Bool | If the user's home directory should be mounted in the target container. | false | true
 mounttmp | Bool | If /tmp should be mounted into the target container (so that ssh agent forwarding works). N.B. Security risk | false | true
 mounthometo | String | Where to map the user's home directory inside the container. | %h | /opt/home/myhomedir
 mounthomefrom | String | Where to map the user's home directory from on the host. | %h | /opt/home/%u
 usercwd | String | Where to chdir into the container when starting a shell. | %h | /
-containerusername | String | Username which should be used inside the container. | %u | root
+containerusername | String | The username that should be used inside the container. | %u | root
 shell | String | The shell that should be started for the user inside the container. | /bin/ash | /bin/bash
-mountdockersocket | Bool | If to mount the docker socket from the host. (DANGEROUS) | false | true
+mountdockersocket | Bool | Set to true to mount the docker socket from the host. (DANGEROUS!) | false | true
 dockersocket | String | The location of the docker socket from the host. | /var/run/docker.sock | /opt/docker/var/run/docker.sock
-entrypoint | String | The entrypoint for the persistent process to keep the container running | internal | /sbin/yoursupervisor
-cmd | Array of Strings | Additional parameters to pass when launching the container as the command line | | -c'/echo foo'
-dockeropt | Array of Strings | Additional options to pass to docker when launching the container. Can be used to mount additional volumes or limit memory etc. | | -v /some/place:/foovol
-enableuserconfig | Bool | Set to true to enable reading of per user ``~/.dockersh`` files | false | true
-enableuserimagename | Bool | Set to true to enable reading of imagename parameter from ``~/.dockersh`` files | false | true
-enableusercontainername | Bool | Set to true to enable reading of containername parameter from ``~/.dockersh`` files. (Dangerous!) | false | true
-enableusermounthome | Bool | Set to true to enable reading of mounthome parameter from ``~/.dockersh`` files | false | true
-enableusermounttmp | Bool | Set to true to enable reading of mounttmp parameter from ``~/.dockersh`` files | false | true
-enableusermounthometo | Bool | Set to true to enable reading of mounthometo parameter from ``~/.dockersh`` files | false | true
-enableusermounthomefrom | Bool | Set to true to enable reading of mounthomefrom parameter from ``~/.dockersh`` files | false | true
-enableuserusercwd | Bool | Set to true to enable reading of usercwd parameter from ``~/.dockersh`` files | false | true
-enableusercontainerusername | bool | Set to true to enable reading of containerusername parameter from ``~/.dockersh`` files | false | true
-enableusershell | Bool | Set to true to enable reading of shell parameter from ``~/.dockersh`` files | false | true
-enableuserentrypoint | Bool | Set to true to enable users to set their own supervisor daemon / entry point to the container for PID 1 | false | true
-enableusercmd | Bool | Set to true to enable users to set the additional command parameters to the entry point | false | true
+entrypoint | String | The entrypoint for the persistent process to keep the container running. | internal | /sbin/yoursupervisor
+cmd | Array of Strings | Additional parameters to pass when launching the container as the command line. | | -c'/echo foo'
+dockeropt | Array of Strings | Additional options to pass to docker when launching the container. Can be used to mount additional volumes or limit memory, etc. | | -v /some/place:/foovol
+enableuserconfig | Bool | Set to true to enable reading of per user ``~/.dockersh`` files. | false | true
+enableuserimagename | Bool | Set to true to enable reading of imagename parameter from ``~/.dockersh`` files. | false | true
+enableusercontainername | Bool | Set to true to enable reading of the containername parameter from ``~/.dockersh`` files. (Dangerous!) | false | true
+enableusermounthome | Bool | Set to true to enable reading of the mounthome parameter from ``~/.dockersh`` files. | false | true
+enableusermounttmp | Bool | Set to true to enable reading of the mounttmp parameter from ``~/.dockersh`` files. | false | true
+enableusermounthometo | Bool | Set to true to enable reading of the mounthometo parameter from ``~/.dockersh`` files. | false | true
+enableusermounthomefrom | Bool | Set to true to enable reading of the mounthomefrom parameter from ``~/.dockersh`` files. | false | true
+enableuserusercwd | Bool | Set to true to enable reading of the usercwd parameter from ``~/.dockersh`` files. | false | true
+enableusercontainerusername | Bool | Set to true to enable reading of the containerusername parameter from ``~/.dockersh`` files. | false | true
+enableusershell | Bool | Set to true to enable reading of the shell parameter from ``~/.dockersh`` files. | false | true
+enableuserentrypoint | Bool | Set to true to enable users to set their own supervisor daemon / entry point to the container for PID 1. | false | true
+enableusercmd | Bool | Set to true to enable users to set the additional command parameters to the entry point. | false | true
 enableuserdockeropt | Bool | Set to true to enable users to set additional options to the docker container that's started. (Dangerous!) | false | true
 
+
 Notes:
 
   * Boolean settings are set by just putting the setting name in the config (see examples below).