summaryrefslogtreecommitdiff
path: root/docs/content/guides/auth/gitlab-self-hosted.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/guides/auth/gitlab-self-hosted.md')
-rw-r--r--docs/content/guides/auth/gitlab-self-hosted.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/content/guides/auth/gitlab-self-hosted.md b/docs/content/guides/auth/gitlab-self-hosted.md
new file mode 100644
index 00000000..fc655ac5
--- /dev/null
+++ b/docs/content/guides/auth/gitlab-self-hosted.md
@@ -0,0 +1,30 @@
+# GitLab (self-hosted)
+
+*Note:* This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind :smile: thanks!
+
+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:`
+
+```Dockerfile
+- CMD_DOMAIN=your.hedgedoc.domain
+- CMD_URL_ADDPORT=true
+- CMD_PROTOCOL_USESSL=true
+- CMD_GITLAB_BASEURL=https://your.gitlab.domain
+- CMD_GITLAB_CLIENTID=23462a34example99XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+- CMD_GITLAB_CLIENTSECRET=5532e9dexamplXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+7. Run `docker-compose up -d` to apply your settings.
+8. Sign in to your HedgeDoc using your GitLab ID:
+
+![Sign in via GitLab](../../images/auth/gitlab-sign-in.png)