From 8a9cafecbea49935d32b250eaf96bd6f722b5aa1 Mon Sep 17 00:00:00 2001
From: Jonathan Bauer
Date: Fri, 30 Jan 2015 18:32:40 +0100
Subject: [doc] documented boot variables for setting up a network share

---
 doc/boot_config_vars | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'doc')

diff --git a/doc/boot_config_vars b/doc/boot_config_vars
index 36293d87..29910792 100644
--- a/doc/boot_config_vars
+++ b/doc/boot_config_vars
@@ -52,3 +52,16 @@ remote logging:
 SLX_REMOTE_LOG       URL where to post log to, eg. 'http://server/log.php'
 	POST variables: type, description, longdesc
 
+user-specific shares (the 'n' in the variable name is an identifier for the share,
+can give different shares using different(!) identifiers):
+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 
+is required for mounting the share. Type 'pam' means to use the same credentials as the
+user logging in. Type 'user' means the credentials defined by SLX_SHARE_n_AUTH_USER and
+SLX_SHARE_n_AUTH_PASS will be used. This option is mandatory.
+SLX_SHARE_n_AUTH_USER    Only required if SLX_SHARE_n_AUTH_TYPE is 'user'. Defines the
+username to use for authenticating the mount of the share.
+SLX_SHARE_n_AUTH_PASS    Only required if SLX_SHARE_n_AUTH_TYPE is 'user'. Defines the
+password to use for authenticating the mount of the share.
+SLX_SHARE_n_PERM         Permissions for the share. Supports 'rw' and 'ro'. Defaults to 'ro'.
+
-- 
cgit v1.2.3-55-g7522