paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 18 Packages Projects Releases Wiki Activity

Merge pull request #3187 from n2ygk/gitlab-doc

Browse Source 
Gitlab Enterprise documentation
This commit is contained in:
Patrik Oldsberg
2020-11-04 11:35:19 +01:00
committed by GitHub
parent bd0ae748c0 13e6a6d337
commit bb547d5bf6
2 changed files with 32 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/styles/vocab.txt
+1
View File
@@ -62,6 +62,7 @@ Firekube
Fredrik
github
Github
gitlab
Gitlab
graphql
graphviz
plugins/auth-backend/README.md
+31 -2
View File
@@ -52,9 +52,38 @@ export AUTH_GITHUB_ENTERPRISE_INSTANCE_URL=https://x
### Gitlab
#### Creating a GitLab OAuth application
Follow this link, [Add new application](https://gitlab.com/-/profile/applications).
1. Set Application Name to `backstage-dev` or something along those lines.
1. The Authorization Callback URL should match the redirect URI set in Backstage.
1. Set this to `http://localhost:7000/api/auth/gitlab/handler/frame` for local development.
1. Set this to `http://{APP_FQDN}:{APP_BACKEND_PORT}/api/auth/gitlab/handler/frame` for non-local deployments.
1. Select the following scopes from the list:
- [x] `read_user` Grants read-only access to the authenticated user's profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
- [x] `read_repository` Grants read-only access to repositories on private projects using Git-over-HTTP (not using the API).
- [x] `write_repository` Grants read-write access to repositories on private projects using Git-over-HTTP (not using the API).
- [x] `openid` Grants permission to authenticate with GitLab using OpenID Connect. Also gives read-only access to the user's profile and group memberships.
- [x] `profile` Grants read-only access to the user's profile data using OpenID Connect.
- [x] `email` Grants read-only access to the user's primary email address using OpenID Connect.
```bash
export GITLAB_BASE_URL=x # default is https://gitlab.com
export AUTH_GITLAB_CLIENT_ID=x
export GITLAB_BASE_URL=https://gitlab.com
export AUTH_GITLAB_CLIENT_ID=x # Gitlab calls this the Application ID
export AUTH_GITLAB_CLIENT_SECRET=x
```
#### Creating a GitLab Enterprise OAuth application
If you have GitLab Enterprise, perform the steps above, replacing `gitlab.example.com` in the following
with the domain of your GitLab Enterprise host:
Create new application at: `https://gitlab.example.com/profile/applications`.
```bash
export GITLAB_BASE_URL=https://gitlab.example.com
export AUTH_GITLAB_CLIENT_ID=x # GitLab calls this the Application ID
export AUTH_GITLAB_CLIENT_SECRET=x
```