summaryrefslogtreecommitdiff
path: root/docs/guides/auth/gitlab-self-hosted.md
diff options
context:
space:
mode:
authorChristoph (Sheogorath) Kern2018-06-01 20:18:28 +0200
committerGitHub2018-06-01 20:18:28 +0200
commit3f7a33df646c4db3de449bd486a7dfddc9ba6e6b (patch)
tree1787ed34235c5c8ff3c27c3033aeb03f7b960d5d /docs/guides/auth/gitlab-self-hosted.md
parent94e015dde7127647f0533f2580c6b7c406c5a759 (diff)
parent3251bcbadc7721c771e19e81e7043dde4afe7cc9 (diff)
Merge pull request #783 from SISheogorath/docs/splitAuth
Split authentication guides into multiple documents
Diffstat (limited to 'docs/guides/auth/gitlab-self-hosted.md')
-rw-r--r--docs/guides/auth/gitlab-self-hosted.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/guides/auth/gitlab-self-hosted.md b/docs/guides/auth/gitlab-self-hosted.md
new file mode 100644
index 00000000..361ee958
--- /dev/null
+++ b/docs/guides/auth/gitlab-self-hosted.md
@@ -0,0 +1,30 @@
+# 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:
+
+![New GitLab application](images/auth/gitlab-new-application.png)
+
+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.
+
+![Application: HackMD](images/auth/gitlab-application-details.png)
+
+
+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=23462a34example99XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+- HMD_GITLAB_CLIENTSECRET=5532e9dexamplXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+7. Run `docker-compose up -d` to apply your settings.
+8. Sign in to your HackMD using your GitLab ID:
+
+![Sign in via GitLab](images/auth/gitlab-sign-in.png)