diff options
| author | Christoph (Sheogorath) Kern | 2018-03-27 18:02:32 +0200 |
|---|---|---|
| committer | GitHub | 2018-03-27 18:02:32 +0200 |
| commit | 2d1dc881b8f470d3966cd1ae7744f5f9861e3acc (patch) | |
| tree | 4e40bfd32ae17b46f4ec5b9b5d9118620bb2e0b2 /docs | |
| parent | 5d57a4bb6f126e327d576d34e489d479326fb4e2 (diff) | |
| parent | 18d2bbb5f3186d51739d73677eae78763d9d4ed6 (diff) | |
Merge pull request #788 from mcnesium/docs/gitlab
Add documentation for setting up authentication with a self-hosted GitLab
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/guides/auth.md | 29 | ||||
| -rw-r--r-- | docs/guides/images/auth/gitlab-application-details.png | bin | 0 -> 30378 bytes | |||
| -rw-r--r-- | docs/guides/images/auth/gitlab-new-application.png | bin | 0 -> 45457 bytes | |||
| -rw-r--r-- | docs/guides/images/auth/gitlab-sign-in.png | bin | 0 -> 5590 bytes |
4 files changed, 29 insertions, 0 deletions
diff --git a/docs/guides/auth.md b/docs/guides/auth.md index aa629489..e4261724 100644 --- a/docs/guides/auth.md +++ b/docs/guides/auth.md @@ -210,3 +210,32 @@ The basic procedure is the same as the case of OneLogin which is mentioned above ```` +### GitLab (self-hosted) + +1. Sign in to your GitLab +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:` + +``` +- HMD_DOMAIN=your.hackmd.domain +- HMD_URL_ADDPORT=443 +- HMD_PROTOCOL_USESSL=true +- HMD_GITLAB_BASEURL=https://your.gitlab.domain +- HMD_GITLAB_CLIENTID=23462a34example99fid0943c3fde97310fb7db47fab1112 +- HMD_GITLAB_CLIENTSECRET=5532e9dexample70432secret0c37dd20ce077e6073ea9f1d6 +``` + +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/images/auth/gitlab-application-details.png b/docs/guides/images/auth/gitlab-application-details.png Binary files differnew file mode 100644 index 00000000..6e042886 --- /dev/null +++ b/docs/guides/images/auth/gitlab-application-details.png diff --git a/docs/guides/images/auth/gitlab-new-application.png b/docs/guides/images/auth/gitlab-new-application.png Binary files differnew file mode 100644 index 00000000..be9e4446 --- /dev/null +++ b/docs/guides/images/auth/gitlab-new-application.png diff --git a/docs/guides/images/auth/gitlab-sign-in.png b/docs/guides/images/auth/gitlab-sign-in.png Binary files differnew file mode 100644 index 00000000..27aaf6dd --- /dev/null +++ b/docs/guides/images/auth/gitlab-sign-in.png |
