Gitlab authentication provider for Sentry
Project description
Disclaimer 1
Thats a second level for of this library. This fork was made in order to prepare PyPi package and make installation process easier via supported plugins install flow. Original fork disclamer is below.
Disclaimer 2
I am NOT a python developer. I just changed what was necessary to make it work. This repository can be used directly or be an inspiration to others to enable Gitlab SSO with Sentry 10. These files can be installed from local folder only as no updated package is available in pip repository.
How to install
Install via pip
Use enhance-image.sh
script to build new image with this plugin.
Create a new file sentry/enhance-image.sh
if it is missing.
cp sentry/enhance-image.example.sh sentry/enhance-image.sh
Add the following line to sentry/enhance-image.sh
file:
pip install sentry-auth-gitlab-v2
Then run ./install.sh
script to build new image with this plugin.
Install from sources
Create plugins folder in sentry
and clone this repo:
mkdir sentry/plugins
cd sentry/plugins
git clone https://github.com/zekker6/sentry-auth-gitlab.git
Use enhance-image.sh
script to build new image with this plugin.
Create a new file sentry/enhance-image.sh
if it is missing.
cp sentry/enhance-image.example.sh sentry/enhance-image.sh
Add the following line to sentry/enhance-image.sh
file:
pip install /usr/src/sentry/plugins/sentry-auth-gitlab
Gitlab configuration
Tested with an official sentry/self-hosted installation:
- Sentry 24.1.0
- Gitlab 17.1
Create a new application under your GitLab. Enter the Callback URL as the prefix to your Sentry installation:
http(s?)://sentry.example.com/auth/sso/
Once done, grab your API keys and drop them in your sentry.conf.py
:
GITLAB_APP_ID = "APP-ID"
GITLAB_APP_SECRET = "APP-SECRET"
GITLAB_BASE_DOMAIN = "git.example.com"
Optionally you may also specify the api version, scheme, and scope:
GITLAB_API_VERSION = 4
GITLAB_HTTP_SCHEME = "https"
GITLAB_AUTH_SCOPE = "api"
Notice
If your gitlab is deployed in a private network (probably). You need to alter sentry's default ip black list to make oauth flow work.
Put following config in your sentry.conf.py and delete conflict ones
SENTRY_DISALLOWED_IPS = (
'0.0.0.0/8',
'10.0.0.0/8',
'100.64.0.0/10',
'127.0.0.0/8',
'169.254.0.0/16',
'172.16.0.0/12',
'192.0.0.0/29',
'192.0.2.0/24',
'192.88.99.0/24',
'192.168.0.0/16',
'198.18.0.0/15',
'198.51.100.0/24',
'224.0.0.0/4',
'240.0.0.0/4',
'255.255.255.255/32'
)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sentry_auth_gitlab_v2-0.4.3.tar.gz
.
File metadata
- Download URL: sentry_auth_gitlab_v2-0.4.3.tar.gz
- Upload date:
- Size: 9.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a694e7b7af6775783ec105a4fb0e0a05f831daa6325ccaf2225179322206cb1 |
|
MD5 | a0b25ccf8c373beacb6bd67c1f12b8b8 |
|
BLAKE2b-256 | 578588d311fb9e732b945543b8013054fc5033909a315c2789fab54868c9b846 |