add config options for SSO (#29)

* add config options for SSO
MasaCMS · Jul 24, 2023 · 381a577 · 381a577
1 parent 6dd28bd
commit 381a577
Showing 1 changed file with 164 additions and 1 deletion.
diff --git a/01_getting-started/03_configuration/01_configuration-file.md b/01_getting-started/03_configuration/01_configuration-file.md
@@ -4,7 +4,7 @@ title: Configuration file
 nav_order: 1
 grand_parent: Getting started
 parent: Configuration
-last_modified_date: 15-07-2023 13:00
+last_modified_date: 24-07-2023 13:00
 permalink: /getting-started/configuration/configuration-file/
 ---
 # Configuration file
@@ -94,6 +94,17 @@ You can find a reference for this configuration file below.
   <dd></dd>
 </dl>
 
+#### allowedadmindomain
+
+<dl>
+  <dt>Type</dt>
+  <dd>list</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>List of domains of which users set to system users when authenticating using SSO</dd>
+</dl>
+
 #### allowautoupdates
 
 <dl>
@@ -105,6 +116,28 @@ You can find a reference for this configuration file below.
   <dd></dd>
 </dl>
 
+#### alloweddomain
+
+<dl>
+  <dt>Type</dt>
+  <dd>list</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>List of domains of which users are allowed to authenticate using SSO, if not allowed the user is created but set to inactive</dd>
+</dl>
+
+#### allowedadmingroupemaillist
+
+<dl>
+  <dt>Type</dt>
+  <dd>list</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>List of email addresses of users that are added to admin group when authenticating using SSO</dd>
+</dl>
+
 #### allowedindexfiles
 
 <dl>
@@ -138,6 +171,17 @@ You can find a reference for this configuration file below.
   <dd></dd>
 </dl>
 
+#### alloweds2emaillist
+
+<dl>
+  <dt>Type</dt>
+  <dd>list</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>List of email addresses of users that are set to super user when authenticating using SSO</dd>
+</dl>
+
 #### assetdir
 
 <dl>
@@ -193,6 +237,48 @@ You can find a reference for this configuration file below.
   <dd></dd>
 </dl>
 
+#### azureadclientid
+New in 7.4.3
+{: .label .label-orange }
+{: .no_toc }
+
+<dl>
+  <dt>Type</dt>
+  <dd>string</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>Oauth client ID for Azure AD SSO configuration</dd>
+</dl>
+
+#### azureadclientsecret
+New in 7.4.3
+{: .label .label-orange }
+{: .no_toc }
+
+<dl>
+  <dt>Type</dt>
+  <dd>string</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>Oauth client secret for Azure AD SSO configuration</dd>
+</dl>
+
+#### azureadtenantid
+New in 7.4.3
+{: .label .label-orange }
+{: .no_toc }
+
+<dl>
+  <dt>Type</dt>
+  <dd>string</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>Oauth tenant ID for Azure AD SSO configuration</dd>
+</dl>
+
 #### bcryptpasswords
 
 <dl>
@@ -380,6 +466,17 @@ You can find a reference for this configuration file below.
   <dd></dd>
 </dl>
 
+#### enableoauth
+
+<dl>
+  <dt>Type</dt>
+  <dd>list</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>List of enabled oauth providers.<br>Options: <code>google</code>, <code>facebook</code>, <code>github</code>, <code>azuread</code></dd>
+</dl>
+
 #### encryptionkey
 
 <dl>
@@ -402,6 +499,28 @@ You can find a reference for this configuration file below.
   <dd></dd>
 </dl>
 
+#### facebookclientid
+
+<dl>
+  <dt>Type</dt>
+  <dd>string</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>Oauth client ID for Facebook SSO configuration</dd>
+</dl>
+
+#### facebookclientsecret
+
+<dl>
+  <dt>Type</dt>
+  <dd>string</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>Oauth client secret for Facebook SSO configuration</dd>
+</dl>
+
 #### filedir
 
 <dl>
@@ -446,6 +565,50 @@ You can find a reference for this configuration file below.
   <dd></dd>
 </dl>
 
+#### githubclientid
+
+<dl>
+  <dt>Type</dt>
+  <dd>string</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>Oauth client ID for Github SSO configuration</dd>
+</dl>
+
+#### githubclientsecret
+
+<dl>
+  <dt>Type</dt>
+  <dd>string</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>Oauth client secret for Github SSO configuration</dd>
+</dl>
+
+#### googleclientid
+
+<dl>
+  <dt>Type</dt>
+  <dd>string</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>Oauth client ID for Google SSO configuration</dd>
+</dl>
+
+#### googleclientsecret
+
+<dl>
+  <dt>Type</dt>
+  <dd>string</dd>
+  <dt>Default</dt>
+  <dd><code>empty string</code></dd>
+  <dt>Description</dt>
+  <dd>Oauth client secret for Google SSO configuration</dd>
+</dl>
+
 #### hashurls
 
 <dl>