[doc] Somme summary about boot config variables (in file 'config')

1 files changed, 36 insertions, 0 deletions

diff --git a/doc/boot_config_vars b/doc/boot_config_vars
new file mode 100644
index 00000000..335e7a7a
--- /dev/null
+++ b/doc/boot_config_vars
@@ -0,0 +1,36 @@
+Summary of variables in the boot 'config' file
+
+The variables follow the form as VAR='value'.
+Remember to set all variables in inverted commata: '...'!
+
+NFS-share related variables:
+SLX_VM_NFS	FQDN/IP:share name for VM image share.
+		Example: some-store.here.example.tld:vmware/images/store
+SLX_STAGE4_NFS	FQDN/IP:share name for stage 4 storage.
+		Example: 10.20.30.40:/srv/suse/stage4
+
+Proxy server related variables:
+SLX_PROXY_MODE		Proxy mode, e.g. 'auto'.
+SLX_PROXY_IP		Proxy server IP.
+SLX_PROXY_PORT		Proxy server port, standard would be 8080.
+SLX_PROXY_TYPE		Proxy type, eg. 'http-connect'.
+SLX_PROXY_BLACKLIST	Proxy blacklist netmask, e.g. '10.20.30.40/16'.
+			Sites in this IP range will not be proxied.
+
+Time server variables:
+SLX_NTP_SERVER		Time server FQDN or IP.
+SLX_BIOS_CLOCK		BIOS clock type, e.g. 'local'.
+
+Domain related variables:
+SLX_NET_DOMAIN		Network domain, e.g. 'here.there.example.tld'.
+
+Configuration server variables:
+SLX_CONFIG_SERVERS	IP of configuration server
+
+Addon related variables:
+SLX_ADDONS		Space separated list of sqfs-modules to load.
+			Example: 'vmware vbox debug'.
+
+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".