HackMD/docs/guides/auth/gitlab-self-hosted.md

GitLab (self-hosted)
===

**Note:** *This guide was written before the renaming. Just replace `HackMD` with `CodiMD` 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:`

```
- HMD_DOMAIN=your.codimd.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 CodiMD using your GitLab ID:

![Sign in via GitLab](../../images/auth/gitlab-sign-in.png)
striving for consistency across various docs Signed-off-by: Claudius <opensource@amenthes.de> 2019-03-31 18:10:32 +00:00			`GitLab (self-hosted)`
Split authentication guides into multiple documents Splitting the documentation should provide an easier access to the documentation people searching for and result in less merge conflicts when adding new documentation here. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com> 2018-03-20 13:44:01 +00:00			`===`

striving for consistency across various docs Signed-off-by: Claudius <opensource@amenthes.de> 2019-03-31 18:10:32 +00:00			Note: This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!
Add note about renaming to docs It's way easier to add a note to the guides than to redo all the images, etc. We have more important things to spend our time on, but if someone wants to redo them, you are very welcome! Signed-off-by: Sheogorath <sheogorath@shivering-isles.com> 2018-06-24 12:04:35 +00:00
Split authentication guides into multiple documents Splitting the documentation should provide an easier access to the documentation people searching for and result in less merge conflicts when adding new documentation here. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com> 2018-03-20 13:44:01 +00:00			`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:`

splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de> 2019-03-31 14:02:05 +00:00			`![New GitLab application](../../images/auth/gitlab-new-application.png)`
Split authentication guides into multiple documents Splitting the documentation should provide an easier access to the documentation people searching for and result in less merge conflicts when adding new documentation here. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com> 2018-03-20 13:44:01 +00:00
			`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.`

splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de> 2019-03-31 14:02:05 +00:00			`![Application: HackMD](../../images/auth/gitlab-application-details.png)`
Split authentication guides into multiple documents Splitting the documentation should provide an easier access to the documentation people searching for and result in less merge conflicts when adding new documentation here. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com> 2018-03-20 13:44:01 +00:00

			6. In the `docker-compose.yml` add the following environment variables to `app:` `environment:`

			```
striving for consistency across various docs Signed-off-by: Claudius <opensource@amenthes.de> 2019-03-31 18:10:32 +00:00			`- HMD_DOMAIN=your.codimd.domain`
Split authentication guides into multiple documents Splitting the documentation should provide an easier access to the documentation people searching for and result in less merge conflicts when adding new documentation here. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com> 2018-03-20 13:44:01 +00:00			`- 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.
striving for consistency across various docs Signed-off-by: Claudius <opensource@amenthes.de> 2019-03-31 18:10:32 +00:00			`8. Sign in to your CodiMD using your GitLab ID:`
Split authentication guides into multiple documents Splitting the documentation should provide an easier access to the documentation people searching for and result in less merge conflicts when adding new documentation here. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com> 2018-03-20 13:44:01 +00:00
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de> 2019-03-31 14:02:05 +00:00			`![Sign in via GitLab](../../images/auth/gitlab-sign-in.png)`