From 54edec89000aec94cae325be3d5c85442ac21adf Mon Sep 17 00:00:00 2001
From: Claudius
Date: Sun, 31 Mar 2019 20:10:32 +0200
Subject: striving for consistency across various docs

Signed-off-by: Claudius <opensource@amenthes.de>
---
 docs/guides/auth/saml.md | 62 ++++++++++++++++++++++++------------------------
 1 file changed, 31 insertions(+), 31 deletions(-)

(limited to 'docs/guides/auth/saml.md')

diff --git a/docs/guides/auth/saml.md b/docs/guides/auth/saml.md
index 7f63b748..3a64f5f7 100644
--- a/docs/guides/auth/saml.md
+++ b/docs/guides/auth/saml.md
@@ -1,7 +1,7 @@
 Authentication guide - SAML
 ===
 
-***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!*
+**Note:** *This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!*
 
 The basic procedure is the same as the case of OneLogin which is mentioned in [OneLogin-Guide](./saml-onelogin.md). If you want to match your IdP, you can use more configurations as below.
 
@@ -9,36 +9,36 @@ The basic procedure is the same as the case of OneLogin which is mentioned in [O
     * {{your-serverurl}}/auth/saml/metadata
     * _Note: If not accessible from IdP, download to local once and upload to IdP._
 * Change the value of `issuer`, `identifierFormat` to match your IdP.
-  * `issuer`: A unique id to identify the application to the IdP, which is the base URL of your HackMD as default
+  * `issuer`: A unique id to identify the application to the IdP, which is the base URL of your CodiMD as default
   * `identifierFormat`: A format of unique id to identify the user of IdP, which is the format based on email address as default. It is recommend that you use as below.
     * urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress (default)
     * urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
-  * config.json:
-    ````javascript
+  * `config.json`:
+    ```javascript
     {
       "production": {
         "saml": {
           /* omitted */
-          "issuer": "myhackmd"
+          "issuer": "mycodimd"
           "identifierFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified"
         }
       }
     }
-    ````
+    ```
   * environment variables
-    ````
-    HMD_SAML_ISSUER=myhackmd
-    HMD_SAML_IDENTIFIERFORMAT=urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
-    ````
+    ```
+    CMD_SAML_ISSUER=mycodimd
+    CMD_SAML_IDENTIFIERFORMAT=urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
+    ```
 
 * Change mapping of attribute names to customize the displaying user name and email address to match your IdP.
   * `attribute`: A dictionary to map attribute names
-  * `attribute.id`: A primary key of user table for your HackMD
-  * `attribute.username`: Attribute name of displaying user name on HackMD
+  * `attribute.id`: A primary key of user table for your CodiMD
+  * `attribute.username`: Attribute name of displaying user name on CodiMD
   * `attribute.email`: Attribute name of email address, which will be also used for Gravatar
     * _Note: Default value of all attributes is NameID of SAML response, which is email address if `identifierFormat` is default._
-  * config.json:
-    ````javascript
+  * `config.json`:
+    ```javascript
     {
       "production": {
         "saml": {
@@ -51,35 +51,35 @@ The basic procedure is the same as the case of OneLogin which is mentioned in [O
         }
       }
     }
-    ````
+    ```
   * environment variables
-    ````
-    HMD_SAML_ATTRIBUTE_ID=sAMAccountName
-    HMD_SAML_ATTRIBUTE_USERNAME=nickName
-    HMD_SAML_ATTRIBUTE_EMAIL=mail
-    ````
+    ```sh
+    CMD_SAML_ATTRIBUTE_ID=sAMAccountName
+    CMD_SAML_ATTRIBUTE_USERNAME=nickName
+    CMD_SAML_ATTRIBUTE_EMAIL=mail
+    ```
 
 * If you want to control permission by group membership, add group attribute name and required group (allowed) or external group (not allowed).
   * `groupAttribute`: An attribute name of group membership
-  * `requiredGroups`: Group names array for allowed access to HackMD. Use vertical bar to separate for environment variables.
-  * `externalGroups`: Group names array for not allowed access to HackMD. Use vertical bar to separate for environment variables.
+  * `requiredGroups`: Group names array for allowed access to CodiMD. Use vertical bar to separate for environment variables.
+  * `externalGroups`: Group names array for not allowed access to CodiMD. Use vertical bar to separate for environment variables.
     * _Note: Evaluates `externalGroups` first_
-  * config.json:
-    ````javascript
+  * `config.json`:
+    ```javascript
     {
       "production": {
         "saml": {
           /* omitted */
           "groupAttribute": "memberOf",
-          "requiredGroups": [ "hackmd-users", "board-members" ],
+          "requiredGroups": [ "codimd-users", "board-members" ],
           "externalGroups": [ "temporary-staff" ]
         }
       }
     }
-    ````
+    ```
   * environment variables
-    ````
-    HMD_SAML_GROUPATTRIBUTE=memberOf
-    HMD_SAML_REQUIREDGROUPS=hackmd-users|board-members
-    HMD_SAML_EXTERNALGROUPS=temporary-staff
-    ````
+    ```sh
+    CMD_SAML_GROUPATTRIBUTE=memberOf
+    CMD_SAML_REQUIREDGROUPS=codimd-users|board-members
+    CMD_SAML_EXTERNALGROUPS=temporary-staff
+    ```
-- 
cgit v1.2.3