Skip to content

Commit

Permalink
docs: OIDC/oauth
Browse files Browse the repository at this point in the history
  • Loading branch information
antoniomuso committed Apr 11, 2024
1 parent ce29850 commit 22849c5
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- [Setup](#setup)
- [Setup Frontend Plugin](#setup-frontend-plugin)
- [Setup Backend Plugin](#setup-backend-plugin)
- [Extra OIDC/OAuth](#extra-oidcoauth)
- [Register To The New Backend System](#register-to-the-new-backend-system)
- [Annotations](#annotations)
- [Code owners file](#code-owners-file)
Expand Down Expand Up @@ -243,8 +244,23 @@ gitlab:
# This parameter controls SSL Certs verification
# Default: true
proxySecure: false
# Activate Oauth/OIDC
# Default: false
useOAuth: false
```

### Extra OIDC/OAuth

By default, this plugin utilizes the token specified in the configuration file `app-config.yaml` under the key: `integrations.gitlab[i].token`. However, you can opt out of using this token by activating OIDC as shown below:

```yaml
gitlab:
useOAuth: true
```

**Note:**: To use OIDC you have to configure the `@backstage/plugin-auth-backend-module-gitlab-provider` plugin.
**Note:**: OIDC does not allow multi GitLab instances!

### Register To The New Backend System

If you're already using the [New Backend System](https://backstage.io/docs/backend-system/), registering backend plugins will become much easier:
Expand Down
2 changes: 1 addition & 1 deletion packages/gitlab-backend/config.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export interface Config {
proxySecure?: boolean;

/**
* Active Oauth
* Activate Oauth/OIDC
* @default "false"
* @visibility backend
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/gitlab/config.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export interface Config {
defaultReadmePath?: string;

/**
* Active Oauth
* Activate Oauth/OIDC
* @default "false"
* @visibility frontend
*/
Expand Down

0 comments on commit 22849c5

Please sign in to comment.