diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/guides/auth/saml-onelogin.md | 52 |
1 files changed, 23 insertions, 29 deletions
diff --git a/docs/guides/auth/saml-onelogin.md b/docs/guides/auth/saml-onelogin.md index 14ce61a5..785e36ba 100644 --- a/docs/guides/auth/saml-onelogin.md +++ b/docs/guides/auth/saml-onelogin.md @@ -1,40 +1,35 @@ Authentication guide - SAML (OneLogin) === -***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!* 1. Sign-in or sign-up for an OneLogin account. (available free trial for 2 weeks) 2. Go to the administration page. -3. Select the **APPS** menu and click on the **Add Apps**. +3. Select the **APPS** menu and click on the **Add Apps**. +  - +4. Find "SAML Test Connector (SP)" for template of settings and select it. +  -4. Find "SAML Test Connector (SP)" for template of settings and select it. - - - -5. Edit display name and icons for OneLogin dashboard as you want, and click **SAVE**. - - +5. Edit display name and icons for OneLogin dashboard as you want, and click **SAVE**. +  6. After that other tabs will appear, click the **Configuration**, and fill out the below items, and click **SAVE**. - * RelayState: The base URL of your hackmd, which is issuer. (last slash is not needed) - * ACS (Consumer) URL Validator: The callback URL of your hackmd. (serverurl + /auth/saml/callback) + * RelayState: The base URL of your CodiMD, which is issuer. (last slash is not needed) + * ACS (Consumer) URL Validator: The callback URL of your CodiMD. (serverurl + /auth/saml/callback) * ACS (Consumer) URL: same as above. - * Login URL: login URL(SAML requester) of your hackmd. (serverurl + /auth/saml) - - + * Login URL: login URL(SAML requester) of your CopiMD. (serverurl + /auth/saml) +  7. The registration is completed. Next, click **SSO** and copy or download the items below. * X.509 Certificate: Click **View Details** and **DOWNLOAD** or copy the content of certificate ....(A) - * SAML 2.0 Endpoint (HTTP): Copy the URL ....(B) - - + * SAML 2.0 Endpoint (HTTP): Copy the URL ....(B) +  -8. In your hackmd server, create IdP certificate file from (A) +8. In your CodiMD server, create IdP certificate file from (A) 9. Add the IdP URL (B) and the Idp certificate file path to your config.json file or pass them as environment variables. - * config.json: - ````javascript + * `config.json`: + ```javascript { "production": { "saml": { @@ -43,12 +38,11 @@ Authentication guide - SAML (OneLogin) } } } - ```` + ``` * environment variables - ```` - HMD_SAML_IDPSSOURL=https://*******.onelogin.com/trust/saml2/http-post/sso/****** - HMD_SAML_IDPCERT=/path/to/idp_cert.pem - ```` -10. Try sign-in with SAML from your hackmd sign-in button or OneLogin dashboard (like the screenshot below). - - + ```sh + CMD_SAML_IDPSSOURL=https://*******.onelogin.com/trust/saml2/http-post/sso/****** + CMD_SAML_IDPCERT=/path/to/idp_cert.pem + ``` +10. Try sign-in with SAML from your CodiMD sign-in button or OneLogin dashboard (like the screenshot below). +  |