From 92428529ad0f0b0c058cd13ee47979cb7ac4d35b Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Sat, 14 Dec 2019 14:28:14 +0100 Subject: [PATCH] docs: add sentry --- docs/integrations/services/sentry/index.md | 42 ++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 43 insertions(+) create mode 100644 docs/integrations/services/sentry/index.md diff --git a/docs/integrations/services/sentry/index.md b/docs/integrations/services/sentry/index.md new file mode 100644 index 000000000..d8161bec4 --- /dev/null +++ b/docs/integrations/services/sentry/index.md @@ -0,0 +1,42 @@ +# Sentry Integration + +## What is Sentry + +From https://sentry.io + +``` +Sentry provides self-hosted and cloud-based error monitoring that helps all software +teams discover, triage, and prioritize errors in real-time. + +One million developers at over fifty thousand companies already ship +better software faster with Sentry. Won’t you join them? +``` + +## Preparation + +The following placeholders will be used: + +- `sentry.company` is the FQDN of the Sentry Install +- `passbook.company` is the FQDN of the passbook Install + +Create an application in passbook. Create an OpenID Provider with the following Parameters: + +- 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 = "" +OIDC_CLIENT_SECRET = "" +OIDC_SCOPE = "openid email" +OIDC_DOMAIN = "https://passbook.company/application/oidc/" +``` diff --git a/mkdocs.yml b/mkdocs.yml index 06f0c987a..189378bb6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,6 +18,7 @@ nav: - GitLab: integrations/services/gitlab/index.md - Rancher: integrations/services/rancher/index.md - Harbor: integrations/services/harbor/index.md + - Sentry: integrations/services/sentry/index.md repo_name: "BeryJu.org/passbook" repo_url: https://git.beryju.org/BeryJu.org/passbook