https://github.com/telkomindonesia/bytebase-unauth

https://github.com/telkomindonesia/bytebase-unauth

bytebase oauth2 oidc

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/telkomindonesia/bytebase-unauth
• Owner: TelkomIndonesia
• Created: 2023-05-24T07:43:34.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-07-17T08:13:39.000Z (over 1 year ago)
• Last Synced: 2024-06-22T08:10:18.346Z (6 months ago)
• Topics: bytebase, oauth2, oidc
• Language: Go
• Homepage:
• Size: 67.4 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Bytebase UnAuth

A simple service to create [bytebase](https://www.bytebase.com/) login session (HTTP cookies) based on supplied HTTP headers. It was created to enable delegation of authentication to external service. See [docker-compose.yml](./docker-compose.yml) for reference on using [caddy security plugin](https://authp.github.io/) to delegate authentication to external OAuth2 provider.

## HTTP Headers

- `X-User-Email`: the email of user. Should be unique.

- `X-User-Name`: the username of user. Should be unique.

- `X-User-Role`: the role assigned to the user. If multiple (comma separated) values are given, than it will use only the first one. If `BYTEBASE_UNAUTH_GROUP_PREFIX` environment variable is specified, then only prefixed value are choosen and the actual role name are extracted by removing the prefix, e.g. when prefix is `bytebase/`, then `bytebase/owner` become `owner`.

## Environment Variables

- `BYTEBASE_UNAUTH_PG_URL`: the url to external postgres database. This should be the same as [`PG_URL`](https://www.bytebase.com/docs/get-started/install/external-postgres/#:~:text=pg%20or%20pass-,PG_URL,-environment%20variable%20to) used by bytebase.

- `BYTEBASE_UNAUTH_LISTEN_ADDRESS`: the listen address, default `:8080`.

- `BYTEBASE_UNAUTH_CREATOR_ID`:  the existing user ID used for creating new user, default `101`.

- `BYTEBASE_UNAUTH_GROUP_PREFIX`: as noted above.