From 809c8f64f69721d51b7d963248a77585867fac53 Mon Sep 17 00:00:00 2001 From: Lauri Ojansivu Date: Wed, 10 Oct 2018 17:24:05 +0300 Subject: - Add LDAP to Snap Help. Thanks to Akuket ! Related #119 --- snap-src/bin/wekan-help | 150 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) (limited to 'snap-src') diff --git a/snap-src/bin/wekan-help b/snap-src/bin/wekan-help index 95814d36..3af19336 100755 --- a/snap-src/bin/wekan-help +++ b/snap-src/bin/wekan-help @@ -95,6 +95,156 @@ echo -e "\t$ snap set $SNAP_NAME OAUTH2_TOKEN_ENDPOINT='/oauth/token'" echo -e "\t-Disable the OAuth2 Token Endpoint of Wekan:" echo -e "\t$ snap set $SNAP_NAME OAUTH2_TOKEN_ENDPOINT=''" echo -e "\n" +echo -e "Ldap Enable." +echo -e "To enable the ldap of Wekan:" +echo -e "\t$ snap set $SNAP_NAME LDAP_ENABLE='true'" +echo -e "\t-Disable the ldap of Wekan:" +echo -e "\t$ snap set $SNAP_NAME LDAP_ENABLE='false'" +echo -e "\n" +echo -e "Ldap Port." +echo -e "The port of the ldap server:" +echo -e "\t$ snap set $SNAP_NAME LDAP_PORT='12345'" +echo -e "\n" +echo -e "Ldap Host." +echo -e "The host server for the LDAP server:" +echo -e "\t$ snap set $SNAP_NAME LDAP_HOST='localhost'" +echo -e "\n" +echo -e "Ldap Base Dn." +echo -e "The base DN for the LDAP Tree:" +echo -e "\t$ snap set $SNAP_NAME LDAP_BASEDN='ou=user,dc=example,dc=org'" +echo -e "\n" +echo -e "Ldap Login Fallback." +echo -e "Fallback on the default authentication method:" +echo -e "\t$ snap set $SNAP_NAME LDAP_LOGIN_FALLBACK='true'" +echo -e "\n" +echo -e "Ldap Reconnect." +echo -e "Reconnect to the server if the connection is lost:" +echo -e "\t$ snap set $SNAP_NAME LDAP_RECONNECT='false'" +echo -e "\n" +echo -e "Ldap Timeout." +echo -e "Overall timeout, in milliseconds:" +echo -e "\t$ snap set $SNAP_NAME LDAP_TIMEOUT='12345'" +echo -e "\n" +echo -e "Ldap Idle Timeout." +echo -e "Specifies the timeout for idle LDAP connections in milliseconds:" +echo -e "\t$ snap set $SNAP_NAME LDAP_IDLE_TIMEOUT='12345'" +echo -e "\n" +echo -e "Ldap Connect Timeout." +echo -e "Connection timeout, in milliseconds:" +echo -e "\t$ snap set $SNAP_NAME LDAP_CONNECT_TIMEOUT='12345'" +echo -e "\n" +echo -e "Ldap Authentication." +echo -e "If the LDAP needs a user account to search:" +echo -e "\t$ snap set $SNAP_NAME LDAP_AUTHENTIFICATION='true'" +echo -e "\n" +echo -e "Ldap Authentication User Dn." +echo -e "The search user Dn:" +echo -e "\t$ snap set $SNAP_NAME LDAP_AUTHENTIFICATION_USERDN='cn=admin,dc=example,dc=org'" +echo -e "\n" +echo -e "Ldap Authentication Password." +echo -e "The password for the search user:" +echo -e "\t$ snap set $SNAP_NAME AUTHENTIFICATION_PASSWORD='admin'" +echo -e "\n" +echo -e "Ldap Log Enabled." +echo -e "Enable logs for the module:" +echo -e "\t$ snap set $SNAP_NAME LDAP_LOG_ENABLED='true'" +echo -e "\n" +echo -e "Ldap Background Sync." +echo -e "If the sync of the users should be done in the background:" +echo -e "\t$ snap set $SNAP_NAME LDAP_BACKGROUND_SYNC='true'" +echo -e "\n" +echo -e "Ldap Background Sync Interval." +echo -e "At which interval does the background task sync in milliseconds:" +echo -e "\t$ snap set $SNAP_NAME LDAP_BACKGROUND_SYNC_INTERVAL='12345'" +echo -e "\n" +echo -e "Ldap Background Sync Keep Existant Users Updated." +echo -e "\t$ snap set $SNAP_NAME LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED='true'" +echo -e "\n" +echo -e "Ldap Background Sync Import New Users." +echo -e "\t$ snap set $SNAP_NAME LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS='true'" +echo -e "\n" +echo -e "Ldap Encryption." +echo -e "Allow LDAPS:" +echo -e "\t$ snap set $SNAP_NAME LDAP_ENCRYPTION='true'" +echo -e "\n" +echo -e "Ldap Ca Cert." +echo -e "The certification for the LDAPS server:" +echo -e "\t$ snap set $SNAP_NAME LDAP_CA_CERT=-----BEGIN CERTIFICATE-----MIIE+zCCA+OgAwIBAgIkAhwR/6TVLmdRY6hHxvUFWc0+Enmu/Hu6cj+G2FIdAgIC...-----END CERTIFICATE-----" +echo -e "\n" +echo -e "Ldap Reject Unauthorized." +echo -e "Reject Unauthorized Certificate:" +echo -e "\t$ snap set $SNAP_NAME LDAP_REJECT_UNAUTHORIZED='true'" +echo -e "\n" +echo -e "Ldap User Search Filter." +echo -e "Optional extra LDAP filters. Don't forget the outmost enclosing parentheses if needed:" +echo -e "\t$ snap set $SNAP_NAME LDAP_USER_SEARCH_FILTER=''" +echo -e "\n" +echo -e "Ldap User Search Scope." +echo -e "Base (search only in the provided DN), one (search only in the provided DN and one level deep), or subtree (search the whole subtree):" +echo -e "\t$ snap set $SNAP_NAME LDAP_USER_SEARCH_SCOPE=one" +echo -e "\n" +echo -e "Ldap User Search Field." +echo -e "Which field is used to find the user:" +echo -e "\t$ snap set $SNAP_NAME LDAP_USER_SEARCH_FIELD='uid'" +echo -e "\n" +echo -e "Ldap Search Page Size." +echo -e "Used for pagination (0=unlimited):" +echo -e "\t$ snap set $SNAP_NAME LDAP_SEARCH_PAGE_SIZE='12345'" +echo -e "\n" +echo -e "Ldap Search Size Limit." +echo -e "The limit number of entries (0=unlimited):" +echo -e "\t$ snap set $SNAP_NAME LDAP_SEARCH_SIZE_LIMIT='12345'" +echo -e "\n" +echo -e "Ldap Group Filter Enable." +echo -e "Enable group filtering:" +echo -e "\t$ snap set $SNAP_NAME LDAP_GROUP_FILTER_ENABLE='true'" +echo -e "\n" +echo -e "Ldap Group Filter ObjectClass." +echo -e "The object class for filtering:" +echo -e "\t$ snap set $SNAP_NAME LDAP_GROUP_FILTER_OBJECTCLASS='group'" +echo -e "\n" +echo -e "Ldap Group Filter Id Attribute." +echo -e "\t$ snap set $SNAP_NAME LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=''" +echo -e "\n" +echo -e "Ldap Group Filter Member Attribute." +echo -e "\t$ snap set $SNAP_NAME LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE=''" +echo -e "\n" +echo -e "Ldap Group Filter Member Format." +echo -e "\t$ snap set $SNAP_NAME LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT=''" +echo -e "\n" +echo -e "Ldap Group Filter Group Name." +echo -e "\t$ snap set $SNAP_NAME LDAP_GROUP_FILTER_GROUP_NAME=''" +echo -e "\n" +echo -e "Ldap Unique Identifier Field." +echo -e "This field is sometimes class GUID (Globally Unique Identifier):" +echo -e "\t$ snap set $SNAP_NAME LDAP_UNIQUE_IDENTIFIER_FIELD=guid" +echo -e "\n" +echo -e "Ldap Utf8 Names Slugify." +echo -e "Convert the username to utf8:" +echo -e "\t$ snap set $SNAP_NAME LDAP_UTF8_NAMES_SLUGIFY='false'" +echo -e "\n" +echo -e "Ldap Username Field." +echo -e "Which field contains the ldap username:" +echo -e "\t$ snap set $SNAP_NAME LDAP_USERNAME_FIELD='username'" +echo -e "\n" +echo -e "Ldap Merge Existing Users." +echo -e "\t$ snap set $SNAP_NAME LDAP_MERGE_EXISTING_USERS='true'" +echo -e "\n" +echo -e "Ldap Sync User Data." +echo -e "Enable synchronization of user data:" +echo -e "\t$ snap set $SNAP_NAME LDAP_SYNC_USER_DATA='true'" +echo -e "\n" +echo -e "Ldap Sync User Data Fieldmap." +echo -e "A field map for the matching:" +echo -e "\t$ snap set $SNAP_NAME LDAP_SYNC_USER_DATA_FIELDMAP={\"cn\":\"name\", \"mail\":\"email\"}" +echo -e "\n" +echo -e "Ldap Sync Group Roles." +echo -e "\t$ snap set $SNAP_NAME LDAP_SYNC_GROUP_ROLES=''" +echo -e "\n" +echo -e "Ldap Default Domain." +echo -e "The default domain of the ldap it is used to create email if the field is not map correctly with the LDAP_SYNC_USER_DATA_FIELDMAP:" +echo -e "\t$ snap set $SNAP_NAME LDAP_DEFAULT_DOMAIN=''" +echo -e "\n" # parse config file for supported settings keys echo -e "wekan supports settings keys" echo -e "values can be changed by calling\n$ snap set $SNAP_NAME =''" -- cgit v1.2.3-1-g7c22