diff options
| author | Claudius | 2019-03-31 16:02:05 +0200 |
|---|---|---|
| committer | Claudius | 2019-04-01 01:03:36 +0200 |
| commit | edf301cfa320cce48eaf055a57f416bc1aa6ee1e (patch) | |
| tree | 34e583fedcbce75bb3d4409cc5e21b3c18226b9f /docs/guides/auth | |
| parent | 3a0ff5edd3882cca3751bcfbca1843807ef0c7d7 (diff) | |
splitting README.md into files in /docs for better readability
Signed-off-by: Claudius <opensource@amenthes.de>
Diffstat (limited to 'docs/guides/auth')
| -rw-r--r-- | docs/guides/auth/github.md | 6 | ||||
| -rw-r--r-- | docs/guides/auth/gitlab-self-hosted.md | 6 | ||||
| -rw-r--r-- | docs/guides/auth/mattermost-self-hosted.md | 8 | ||||
| -rw-r--r-- | docs/guides/auth/nextcloud.md | 6 | ||||
| -rw-r--r-- | docs/guides/auth/oauth.md | 12 | ||||
| -rw-r--r-- | docs/guides/auth/saml-onelogin.md | 12 | ||||
| -rw-r--r-- | docs/guides/auth/twitter.md | 8 |
7 files changed, 35 insertions, 23 deletions
diff --git a/docs/guides/auth/github.md b/docs/guides/auth/github.md index d6a1095e..482bca31 100644 --- a/docs/guides/auth/github.md +++ b/docs/guides/auth/github.md @@ -7,17 +7,17 @@ Authentication guide - GitHub 2. Navigate to developer settings in your GitHub account [here](https://github.com/settings/developers) and select the "OAuth Apps" tab 3. Click on the **New OAuth App** button, to create a new OAuth App: - + 4. Fill out the new OAuth application registration form, and click **Register Application** - + *Note: The callback URL is <your-hackmd-url>/auth/github/callback* 5. After successfully registering the application, you'll receive the Client ID and Client Secret for the application - + 6. Add the Client ID and Client Secret to your config.json file or pass them as environment variables * config.json: diff --git a/docs/guides/auth/gitlab-self-hosted.md b/docs/guides/auth/gitlab-self-hosted.md index 60f62616..d19caf76 100644 --- a/docs/guides/auth/gitlab-self-hosted.md +++ b/docs/guides/auth/gitlab-self-hosted.md @@ -7,12 +7,12 @@ 2. Navigate to the application management page at `https://your.gitlab.domain/admin/applications` (admin permissions required) 3. Click **New application** to create a new application and fill out the registration form: - + 4. Click **Submit** 5. In the list of applications select **HackMD**. Leave that site open to copy the application ID and secret in the next step. - + 6. In the `docker-compose.yml` add the following environment variables to `app:` `environment:` @@ -29,4 +29,4 @@ 7. Run `docker-compose up -d` to apply your settings. 8. Sign in to your HackMD using your GitLab ID: - + diff --git a/docs/guides/auth/mattermost-self-hosted.md b/docs/guides/auth/mattermost-self-hosted.md index 631aabd3..e3050595 100644 --- a/docs/guides/auth/mattermost-self-hosted.md +++ b/docs/guides/auth/mattermost-self-hosted.md @@ -8,22 +8,22 @@ This guide uses the generic OAuth2 module for compatibility with Mattermost vers 1. Sign-in with an administrator account to your Mattermost instance 2. Make sure **OAuth 2.0 Service Provider** is enabled in the Main Menu (menu button next to your username in the top left corner) --> System Console --> Custom Integrations menu, which you can find at `https://your.mattermost.domain/admin_console/integrations/custom` - + 3. Navigate to the OAuth integration settings through Main Menu --> Integrations --> OAuth 2.0 Applications, at `https://your.mattermost.domain/yourteam/integrations/oauth2-apps` 4. Click on the **Add OAuth 2.0 Application** button to add a new OAuth application - + 5. Fill out the form and click **Save** - + *Note: The callback URL is \<your-codimd-url\>/auth/oauth2/callback* 6. After saving the application, you'll receive the Client ID and Client Secret - + 7. Add the Client ID and Client Secret to your config.json file or pass them as environment variables * config.json: diff --git a/docs/guides/auth/nextcloud.md b/docs/guides/auth/nextcloud.md index 108772dd..42db8b42 100644 --- a/docs/guides/auth/nextcloud.md +++ b/docs/guides/auth/nextcloud.md @@ -10,14 +10,14 @@ This guide uses the generic OAuth2 module for compatibility with Nextcloud 13 an 2. Navigate to the OAuth integration settings: Profile Icon (top right) --> Settings Then choose Security Settings from the *Administration* part of the list - Don't confuse this with Personal Security Settings, where you would change your personal password! At the top there's OAuth 2.0-Clients. -  +  3. Add your CodiMD instance by giving it a *name* (perhaps CodiMD, but could be anything) and a *Redirection-URI*. The Redirection-URI will be `\<your-codimd-url\>/auth/oauth2/callback`. Click <kbd>Add</kbd>. -  +  4. You'll now see a line containing a *client identifier* and a *Secret*. -  +  5. That's it for Nextcloud, the rest is configured in your CodiMD `config.json` or via the `CMD_` environment variables! diff --git a/docs/guides/auth/oauth.md b/docs/guides/auth/oauth.md new file mode 100644 index 00000000..46314e26 --- /dev/null +++ b/docs/guides/auth/oauth.md @@ -0,0 +1,12 @@ +# OAuth general information + +| service | callback URL (after the server URL) | +| ------- | --------- | +| facebook | `/auth/facebook/callback` | +| twitter | `/auth/twitter/callback` | +| github | `/auth/github/callback` | +| gitlab | `/auth/gitlab/callback` | +| mattermost | `/auth/mattermost/callback` | +| dropbox | `/auth/dropbox/callback` | +| google | `/auth/google/callback` | +| saml | `/auth/saml/callback` | diff --git a/docs/guides/auth/saml-onelogin.md b/docs/guides/auth/saml-onelogin.md index 02a5ffac..14ce61a5 100644 --- a/docs/guides/auth/saml-onelogin.md +++ b/docs/guides/auth/saml-onelogin.md @@ -7,15 +7,15 @@ Authentication guide - SAML (OneLogin) 2. Go to the administration page. 3. Select the **APPS** menu and click on the **Add Apps**. - + 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**. - + 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) @@ -23,13 +23,13 @@ Authentication guide - SAML (OneLogin) * ACS (Consumer) URL: same as above. * Login URL: login URL(SAML requester) of your hackmd. (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) - + 8. In your hackmd 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. @@ -51,4 +51,4 @@ Authentication guide - SAML (OneLogin) ```` 10. Try sign-in with SAML from your hackmd sign-in button or OneLogin dashboard (like the screenshot below). - + diff --git a/docs/guides/auth/twitter.md b/docs/guides/auth/twitter.md index 1b96288f..da35a4e3 100644 --- a/docs/guides/auth/twitter.md +++ b/docs/guides/auth/twitter.md @@ -7,11 +7,11 @@ Authentication guide - Twitter 2. Go to the Twitter Application management page [here](https://apps.twitter.com/) 3. Click on the **Create New App** button to create a new Twitter app: - + 4. Fill out the create application form, check the developer agreement box, and click **Create Your Twitter Application** - + *Note: you may have to register your phone number with Twitter to create a Twitter application* @@ -19,11 +19,11 @@ To do this Click your profile icon --> Settings and privacy --> Mobile --> Sele 5. After you receive confirmation that the Twitter application was created, click **Keys and Access Tokens** - + 6. Obtain your Twitter Consumer Key and Consumer Secret - + 7. Add your Consumer Key and Consumer Secret to your config.json file or pass them as environment variables: * config.json: |