Updated ldap/saml auth pages with youtube links

 - Also added note to remove_from_groups options regarding connecting to
   default registration role.
 
 Related to BookStackApp/BookStack#3307
 
 

diff --git a/content/docs/admin/ldap-auth.md b/content/docs/admin/ldap-auth.md
index 78deafa0889b07db7f502936d40c90c084f9d8c4..67ff33b61e627632fb0a0082bb52264b033189e9 100644 (file)
--- a/content/docs/admin/ldap-auth.md
+++ b/content/docs/admin/ldap-auth.md
@@ -5,7 +5,9 @@ date = "2017-01-21"
 type = "admin-doc"
 +++
 
-BookStack can be configured to allow LDAP based user login. While LDAP login is enabled you cannot log in with the standard user/password login and new user registration is disabled. BookStack will only use the LDAP server for getting user details and for authentication. Data on the LDAP server is not currently editable through BookStack.
+BookStack can be configured to allow LDAP based user login. While LDAP login is enabled you cannot log in with the standard user/password login and new user registration is disabled. BookStack will only use the LDAP server for getting user details and for authentication. Data on the LDAP server is not editable through BookStack.
+
+[A video guide for setting up LDAP can be found here](https://www.youtube.com/watch?v=50qw_LkhwoM).
 
 ### Authentication Setup
 
@@ -78,7 +80,7 @@ LDAP_START_TLS=false
 
 You will also need to have the php-ldap extension installed on your system. You can change your `APP_DEBUG` variable to `true` while setting up LDAP to make any errors visible. Note that debug mode can expose sensitive details to visitors so you may want to limit access while configuring and you should remember to change this back after LDAP is functioning.
 
-A user in BookStack will be linked to a LDAP user via a 'uid'. If a LDAP user uid changes it can be updated in BookStack by an admin by changing the 'External Authentication ID' field on the user's profile.
+A user in BookStack will be linked to a LDAP user via a 'uid'. If an LDAP user uid changes it can be updated in BookStack by an admin by changing the 'External Authentication ID' field on the user's profile.
 
 You may find that you cannot log in with your initial Admin account after changing the `AUTH_METHOD` to `ldap`. To get around this set the `AUTH_METHOD` to `standard`, login with your admin account then change it back to `ldap`. You get then edit your profile and add your LDAP uid under the 'External Authentication ID' field. You will then be able to login in with that ID.
 
@@ -116,5 +118,7 @@ LDAP_USER_TO_GROUPS=true
 LDAP_GROUP_ATTRIBUTE="memberOf"
 
 # Remove users from roles that don't match LDAP groups.
+# Note: While this is enabled the "Default Registration Role", editable within the 
+# BookStack settings view, will be considered a matched role and assigned to the user.
 LDAP_REMOVE_FROM_GROUPS=false
 ```

diff --git a/content/docs/admin/saml2-auth.md b/content/docs/admin/saml2-auth.md
index 8963db5567d5445875fc77592c5ec8af300278fd..75f2cec1fab889127bdb6e9f21861814a66f4735 100644 (file)
--- a/content/docs/admin/saml2-auth.md
+++ b/content/docs/admin/saml2-auth.md
@@ -7,6 +7,8 @@ type = "admin-doc"
 
 BookStack can be configured to utilise a SAML 2.0 based authentication provider as a solution for users to log-in, log-out and self-register within BookStack. This replaces the default email & password authentication mechanism within BookStack. When enabled, BookStack will attempt to match the SAML user to an existing BookStack user based on a stored external id attribute otherwise, if not found, BookStack will effectively auto-register that user to provide a seamless access experience.
 
+[A video guide for setting up SAML2 can be found here](https://www.youtube.com/watch?v=szweYsAow88).
+
 ### BookStack Configuration
 
 To set up SAML 2.0 based authentication add or modify the following variables in your `.env` file:
@@ -131,6 +133,8 @@ SAML2_USER_TO_GROUPS=true
 # Set the attribute from which BookStack will read groups names from.
 SAML2_GROUP_ATTRIBUTE=groups
 
-# Removed user from roles that don't match SAML groups upon login.
+# Remove the user from roles that don't match SAML groups upon login.
+# Note: While this is enabled the "Default Registration Role", editable within the 
+# BookStack settings view, will be considered a matched role and assigned to the user.
 SAML2_REMOVE_FROM_GROUPS=true
 ```