2019-12-14 13:28:14 +00:00
|
|
|
|
# Sentry Integration
|
|
|
|
|
|
|
|
|
|
## What is Sentry
|
|
|
|
|
|
|
|
|
|
From https://sentry.io
|
|
|
|
|
|
2020-02-18 14:34:41 +00:00
|
|
|
|
!!! note ""
|
|
|
|
|
Sentry provides self-hosted and cloud-based error monitoring that helps all software
|
|
|
|
|
teams discover, triage, and prioritize errors in real-time.
|
2019-12-14 13:28:14 +00:00
|
|
|
|
|
2020-02-18 14:34:41 +00:00
|
|
|
|
One million developers at over fifty thousand companies already ship
|
|
|
|
|
better software faster with Sentry. Won’t you join them?
|
2019-12-14 13:28:14 +00:00
|
|
|
|
|
|
|
|
|
## Preparation
|
|
|
|
|
|
|
|
|
|
The following placeholders will be used:
|
|
|
|
|
|
2020-06-18 18:57:58 +00:00
|
|
|
|
- `sentry.company` is the FQDN of the Sentry install.
|
|
|
|
|
- `passbook.company` is the FQDN of the passbook install.
|
2019-12-14 13:28:14 +00:00
|
|
|
|
|
2020-06-18 18:57:58 +00:00
|
|
|
|
Create an application in passbook. Create an OpenID provider with the following parameters:
|
2019-12-14 13:28:14 +00:00
|
|
|
|
|
|
|
|
|
- Client Type: `Confidential`
|
|
|
|
|
- Response types: `code (Authorization Code Flow)`
|
|
|
|
|
- JWT Algorithm: `RS256`
|
|
|
|
|
- Redirect URIs: `https://sentry.company/auth/sso/`
|
|
|
|
|
- Scopes: `openid email`
|
|
|
|
|
|
|
|
|
|
## Sentry
|
|
|
|
|
|
|
|
|
|
**This guide assumes you've installed Sentry using [getsentry/onpremise](https://github.com/getsentry/onpremise)**
|
|
|
|
|
|
|
|
|
|
- Add `sentry-auth-oidc` to `onpremise/sentry/requirements.txt` (Create the file if it doesn't exist yet)
|
|
|
|
|
- Add the following block to your `onpremise/sentry/sentry.conf.py`:
|
|
|
|
|
```
|
|
|
|
|
OIDC_ISSUER = "passbook"
|
|
|
|
|
OIDC_CLIENT_ID = "<Client ID from passbook>"
|
|
|
|
|
OIDC_CLIENT_SECRET = "<Client Secret from passbook>"
|
|
|
|
|
OIDC_SCOPE = "openid email"
|
|
|
|
|
OIDC_DOMAIN = "https://passbook.company/application/oidc/"
|
|
|
|
|
```
|