Skip to content

Commit

Permalink
website/docs: Add documentation for Glitchtip (#8182)
Browse files Browse the repository at this point in the history
* website/docs: Add documentation for Glitchtip

* Fix code review comments
  • Loading branch information
Daniel15 authored Feb 26, 2024
1 parent 868229a commit 2e451f4
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
54 changes: 54 additions & 0 deletions website/integrations/services/glitchtip/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Glitchtip
---

<span class="badge badge--secondary">Support level: Community</span>

## 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.

1. Create a superuser using the `manage.py` script:

```
sudo docker exec -it glitchtip-web-1 ./manage.py createsuperuser
```

2. Go to `https://glitchtip.company/admin/socialaccount/socialapp/` and log in with the newly-created superuser.

3. Click **Add Social Application** and 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: &lt;Client ID from authentik>
- Secret key: &lt;Client Secret from authentik>
- Key: leave blank
- Settings: `{"server_url": "https://authentik.company/application/o/<Slug of the application from above>/"}`
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.
1 change: 1 addition & 0 deletions website/sidebarsIntegrations.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ module.exports = {
type: "category",
label: "Monitoring",
items: [
"services/glitchtip/index",
"services/grafana/index",
"services/sentry/index",
"services/ubuntu-landscape/index",
Expand Down

0 comments on commit 2e451f4

Please sign in to comment.