From cf4195daf04585eae96887b3e62b2cf8ae7f24c5 Mon Sep 17 00:00:00 2001 From: Daniel Lo Nigro Date: Mon, 15 Jan 2024 19:28:48 -0800 Subject: [PATCH] website/docs: Add documentation for Glitchtip --- .../integrations/services/glitchtip/index.md | 56 +++++++++++++++++++ website/sidebarsIntegrations.js | 1 + 2 files changed, 57 insertions(+) create mode 100644 website/integrations/services/glitchtip/index.md diff --git a/website/integrations/services/glitchtip/index.md b/website/integrations/services/glitchtip/index.md new file mode 100644 index 000000000..5ec4d174d --- /dev/null +++ b/website/integrations/services/glitchtip/index.md @@ -0,0 +1,56 @@ +--- +title: Glitchtip +--- + +Support level: Community + +## What is Glitchtip + +> Bugs are inevitable in web development. The important thing is to catch them when they appear. With GlitchTip, you can rest easy knowing that if your web app throws an error or goes down, you will be notified immediately. GlitchTip combines error tracking and uptime monitoring in one open-source package to keep you and your team fully up-to-date on the status of your projects. +> +> -- https://glitchtip.com/documentation + +## Preparation + +The following placeholders will be used: + +- `glitchtip.company` is the FQDN of the Glitchtip install. +- `authentik.company` is the FQDN of the authentik install. + +## authentik Configuration + +Create an OAuth2/OpenID provider with the following parameters: + +- Client Type: `Confidential` +- Redirect URIs: `https://glitchtip.company/auth/authentik` + +Note the Client ID and Client Secret values. + +Create an application, using the provider you've created above. Note the slug of the application you've created. + +## Glitchtip Configuration + +Configuration of OpenID Connect providers in Glitchtip is done using Django Admin. + +Create a superuser: + +``` +sudo docker exec -it glitchtip-web-1 ./manage.py createsuperuser +``` + +Go to https://glitchtip.company/admin/socialaccount/socialapp/ and log in with the newly-created superuser. + +Click "Add Social Application" + +Enter the following details: + +- Provider: `OpenID Connect` +- Provider ID: `authentik` (should match the Redirect URI configured above) +- Provider Name: Whatever you want to appear on GlitchTip's log in button +- Client ID: <Client ID from Authentik> +- Secret key: <Client Secret from Authentik> +- Key: leave blank +- Settings: `{"server_url": "https://auth.d.sb/application/o//"}` + The URL should match the "OpenID Configuration Issuer" URL for the Authentik provider. + +This will add a "Log in with Authentik" button to the GlitchTip log in page. To add an Authentik account to an existing GlitchTip account, log in using the username/password, click _Profile_, then click _Add Account_ in the _Social Auth Accounts_ section. diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index 3735e3b32..2ec17b1db 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -114,6 +114,7 @@ module.exports = { type: "category", label: "Monitoring", items: [ + "services/glitchtip/index", "services/grafana/index", "services/sentry/index", "services/ubuntu-landscape/index",