[doc] documented new config variables

1 files changed, 43 insertions, 9 deletions

diff --git a/doc/boot_config_vars b/doc/boot_config_vars
index 7890ecc2..9cf7f76a 100644
--- a/doc/boot_config_vars
+++ b/doc/boot_config_vars
@@ -12,6 +12,12 @@ SLX_STAGE4	FQDN/IP:share name for stage 4 storage (nfs):
 		Example: dnbd3 stage4/default/ubuntu1304.sqfs
 SLX_STAGE4_RID    Use specific revision of stage 4. Only used when
                   using dnbd3 for stage 4.
+DNBD3 related:
+SLX_DNBD3_SERVERS        Space separated list of dnbd3 servers, eg. '1.2.3.4 5.6.7.8'
+		The list will be randomized on use.
+SLX_DNBD3_PRIO_SERVERS   Space separated list of preferred dnbd3 servers
+		The list will not be randomized and is used before the regular list.
+SLX_VM_DNBD3		Specifies whether the VMs are to be loaded per DNBD3.
 
 Proxy server related variables:
 SLX_PROXY_MODE		Proxy mode, e.g. 'auto'.
@@ -31,6 +37,21 @@ SLX_NET_DOMAIN		Network domain, e.g. 'here.there.example.tld'.
 Configuration server variables:
 SLX_CONFIG_SERVERS	IP of configuration server
 
+VMChoose related variables:
+SLX_VMCHOOSER_BASE_URL		Specifies the base URL for all the vmchooser http requests (list.php, news.php, help.php?).
+SLX_VMCHOOSER_TAB				Specifies which tab to show per default when vmchooser starts.
+	0 for native linux sessions
+	1 for user-specific lectures
+	2 for all lectures
+	AUTO if low system specs this shows Linux Sessions (so 0) or all lectures (so 2).
+SLX_VMCHOOSER_FORLOCATION	Specifies how the lectures specific to the client's location should be shown within the list of images.
+	IGNORE		to simply sort them alphabetically with the rest of the images
+	BUMP			to put them atop the rest of the lectures
+	EXCLUSIVE	to put them atop the rest and collapse every other type of lectures.
+SLX_VMCHOOSER_TEMPLATES		Specifies how the template lectures are shown within the list of images.
+	IGNORE		to merge them with the rest
+	BUMP			to put them atop the list.
+
 Addon related variables:
 SLX_ADDONS		Space separated list of sqfs-modules to load.
 			Example: 'vmware vbox debug'.
@@ -38,20 +59,33 @@ SLX_ADDONS		Space separated list of sqfs-modules to load.
 VMWare related variables:
 SLX_VMWARE_3D  Boolean, sets 'mks.gl.allowBlacklistedDrivers'
 
-Client root password related variables:
-SLX_ROOT_PASS		Expects a (salted) sha-512 password hash.
-			Such hashes can be created using "mkpasswd -m sha-512".
+Automatic VM start:
+SLX_BENCHMARK_VM		Name of the VM to be started automatically after the start of the display manager (used for Benchmarks/E-Exam scenarios)
 
-dnbd3 related:
-SLX_DNBD3_SERVERS        Space separated list of dnbd3 servers, eg. '1.2.3.4 5.6.7.8'
-		The list will be randomized on use.
-SLX_DNBD3_PRIO_SERVERS   Space separated list of preferred dnbd3 servers
-		The list will not be randomized and is used before the regular list.
+Client local accounts related variables:
+SLX_ROOT_PASS		Password for the user 'root'. Expects a (salted) sha-512 password hash.
+			Such hashes can be created using "mkpasswd -m sha-512".
+SLX_DEMO_PASS		Same as SLX_ROOT_PASS but for the user 'demo'.
 
-remote logging:
+Remote logging:
 SLX_REMOTE_LOG       URL where to post log to, eg. 'http://server/log.php'
 	POST variables: type, description, longdesc
+SLX_REMOTE_LOG_SESSIONS	Defines whether user information is to be included when logging user sessions on clients. 'yes' enables this, 'anonymous' only logs sessions without user information and 'no' to disable this feature.
+
+bwIDM authentication support:
+SLX_BWIDM_AUTH			Enables authentication against the bwIDM service if set to 'yes'. Disabled otherwise.
+
+Location related:
+SLX_LOCATIONS			List of location ids the client belongs to. This variable is filled by the SLX-Admin.
+SLX_LOCAL_CONFIG		List of tags defining which subfolder of config.tgz:/openslx-configs/ is to be unpacked on those clients. Used in conjunction with the new config.tgz style (see wiki).
+
+Inactivity and shutdown
+SLX_LOGOUT_TIMEOUT		Time in seconds after which a inactive user is automatically logged off. Leave it empty to disable this feature.
+SLX_SHUTDOWN_SCHEDULE	List of HH:MM times the machine automatically shuts down (even if users are still on!). Accepts space separated list.
+SLX_SHUTDOWN_TIMEOUT		Time in seconds after which the computer shuts down if no user is logged on.
+SLX_REBOOT_SCHEDULE		Time in HH:MM format where the computer should restart itself.
 
+# currently not used
 user-specific shares (the 'n' in the variable name is a numerical (!) identifier for the share):
 SLX_SHARE_n_PATH         Network path to the share, e.g. //cifs.server/sharename
 SLX_SHARE_n_AUTH_TYPE    Type of authentication. Type 'guest' means no authentication