website/docs: Add documentation for Glitchtip by Daniel15 · Pull Request #8182 · goauthentik/authentik

Daniel15 · 2024-01-16T03:29:40Z

Details

Adds documentation for how to configure Glitchtip.

Checklist

Local tests pass (ak test authentik/)
The code has been formatted (make lint-fix)

If an API change has been made

The API schema has been updated (make gen-build)

If changes to the frontend have been made

The code has been formatted (make web)
The translation files have been updated (make i18n-extract)

If applicable

The documentation has been updated
The documentation has been formatted (make website)

netlify · 2024-01-16T03:29:44Z

✅ Deploy Preview for authentik-storybook ready!

Name	Link
🔨 Latest commit	`3753002`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/65d98173e87eaa0008607ced
😎 Deploy Preview	https://deploy-preview-8182--authentik-storybook.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2024-01-16T03:31:22Z

✅ Deploy Preview for authentik ready!

Name	Link
🔨 Latest commit	`cf4195d`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik/deploys/65a5f82575284c0008d02958
😎 Deploy Preview	https://deploy-preview-8182--authentik.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

rissson

Hi, thank you for your contribution!

codecov · 2024-01-16T06:39:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.25%. Comparing base (eeb9716) to head (3753002).
Report is 362 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8182      +/-   ##
==========================================
+ Coverage   91.66%   92.25%   +0.59%     
==========================================
  Files         608      632      +24     
  Lines       30262    31297    +1035     
==========================================
+ Hits        27739    28873    +1134     
+ Misses       2523     2424      -99

Flag	Coverage Δ
e2e	`49.39% <ø> (+2.30%)`	⬆️
integration	`26.10% <ø> (-0.30%)`	⬇️
unit	`89.69% <ø> (+0.23%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

tanberry

Thanks so much @Daniel15 for this contribution! Glitchtip sounds like a cool tool.

tanberry · 2024-01-23T16:15:19Z

website/integrations/services/glitchtip/index.md

+-   `glitchtip.company` is the FQDN of the Glitchtip install.
+-   `authentik.company` is the FQDN of the authentik install.
+
+## authentik Configuration


Suggested change

## authentik Configuration

## authentik configuration

@tanberry I copied this (uppercase C for configuration) from one of the other ones: https://github.com/search?q=repo%3Agoauthentik%2Fauthentik+%23%23+%22authentik+Configuration%22&type=code

In general it seems like there's inconsistencies in the headings and layouts of these service integration pages. Reading a few pages, you can tell they were written by different people, without a style guide (not a bad thing, just a feature of a project that's grown organically over time). Maybe they should all use a standard template?

Yep, I was thinking we needed a template (the inconsistencies between the integrations are pretty wild) and then someone pointed out that we already DO have a template for integrations, haha. It is just rather hard to find: https://github.com/goauthentik/authentik/blob/main/website/integrations/_template/service.md

I'll find places to add a link to the tempalte, and in general try to get the word out that people contributing Integrations docs should use the template, and not copy form another (possibly incorrect) integration page. Thank you for making me dig into this more. :-)

We also do have a very very baby Style Guide for Docs... Needs a lot of work though... I'll get to it eventually.

@tanberry I saw that template but didn't it because it looked pretty different to most of the other service pages I looked at 😅

tanberry · 2024-01-23T16:15:43Z

website/integrations/services/glitchtip/index.md

+
+Create an application, using the provider you've created above. Note the slug of the application you've created.
+
+## Glitchtip Configuration


Suggested change

## Glitchtip Configuration

## Glitchtip configuration

tanberry · 2024-01-23T16:34:29Z

website/integrations/services/glitchtip/index.md

+
+Configuration of OpenID Connect providers in Glitchtip is done using Django Admin.
+
+Create a superuser:


Suggested change

Create a superuser:

1. Create a superuser:

Do think we need to be more specific about where one does this? Is in the UI of the Django Admin? If Yes, you could say:

In the Django Admin UI, create a superuser.

tanberry · 2024-01-23T16:35:30Z

website/integrations/services/glitchtip/index.md

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


Suggested change

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

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

tanberry · 2024-01-23T16:35:52Z

website/integrations/services/glitchtip/index.md

+
+Go to https://glitchtip.company/admin/socialaccount/socialapp/ and log in with the newly-created superuser.
+
+Click "Add Social Application"


Suggested change

Click "Add Social Application"

3. Click **Add Social Application** and enter the following details:

tanberry · 2024-01-23T16:38:54Z

website/integrations/services/glitchtip/index.md

+
+Click "Add Social Application"
+
+Enter the following details:


Suggested change

Enter the following details:

tanberry · 2024-01-23T16:40:29Z

website/integrations/services/glitchtip/index.md

+-   Secret key: &lt;Client Secret from Authentik>
+-   Key: leave blank
+-   Settings: `{"server_url": "https://auth.d.sb/application/o/<Slug of the application from above>/"}`
+    The URL should match the "OpenID Configuration Issuer" URL for the Authentik provider.


Suggested change

The URL should match the "OpenID Configuration Issuer" URL for the Authentik provider.

The URL should match the **OpenID Configuration Issuer** URL for the authentik provider.

tanberry · 2024-01-23T16:40:47Z

website/integrations/services/glitchtip/index.md

+-   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>


Suggested change

- Client ID: <Client ID from Authentik>

- Client ID: <Client ID from authentik>

tanberry · 2024-01-23T16:40:57Z

website/integrations/services/glitchtip/index.md

+-   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>


Suggested change

- Secret key: <Client Secret from Authentik>

- Secret key: <Client Secret from authentik>

tanberry · 2024-01-23T16:42:48Z

website/integrations/services/glitchtip/index.md

+-   Settings: `{"server_url": "https://auth.d.sb/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.


Suggested change

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.

This will add a **Log in with authentik** button to the GlitchTip login 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.

tanberry

Hi @Daniel15 a couple of small edits.

Daniel15 · 2024-02-23T18:50:01Z

Thanks - I'll make these changes when I have some time. Sorry I didn't see your first comment - GitHub didn't send me an email about it for some reason.

Daniel15 · 2024-02-24T05:38:49Z

website/integrations/services/glitchtip/index.md

+-   Client ID: &lt;Client ID from Authentik>
+-   Secret key: &lt;Client Secret from Authentik>
+-   Key: leave blank
+-   Settings: `{"server_url": "https://auth.d.sb/application/o/<Slug of the application from above>/"}`


netlify · 2024-02-24T05:41:24Z

✅ Deploy Preview for authentik ready!

Name	Link
🔨 Latest commit	`3753002`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik/deploys/65d981737dd45d0008c0192e
😎 Deploy Preview	https://deploy-preview-8182--authentik.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

tanberry

Thank you so much @Daniel15 !!

* main: (75 commits) Add missing commas, correction of spelling errors (#8680) website/docs: Add documentation for Glitchtip (#8182) website: add solve gitea group does not take effect (#8413) enterprise: fix read_only activating when no license is installed (#8697) core: fix blueprint export (#8695) web: bump the sentry group in /web with 1 update (#8687) web: bump yaml from 2.3.4 to 2.4.0 in /web (#8689) web: bump the eslint group in /web with 1 update (#8688) core: bump pytest from 8.0.1 to 8.0.2 (#8693) website: bump @types/react from 18.2.57 to 18.2.58 in /website (#8690) web: bump the eslint group in /tests/wdio with 1 update (#8691) core: bump sentry-sdk from 1.40.4 to 1.40.5 (#8692) core: bump coverage from 7.4.1 to 7.4.3 (#8694) providers/oauth2: fix inconsistent `sub` value when setting via mapping (#8677) translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#8678) translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#8679) core, web: update translations (#8672) root: fix config loading after refactor during ruff migration (#8674) root: early spring clean for linting (#8498) website/integrations: multiple integration edits (#7923) ...

website/docs: Add documentation for Glitchtip

cf4195d

Daniel15 requested a review from a team as a code owner January 16, 2024 03:29

rissson approved these changes Jan 16, 2024

View reviewed changes

rissson requested a review from tanberry January 16, 2024 06:08

tanberry requested changes Jan 23, 2024

View reviewed changes

tanberry requested changes Feb 23, 2024

View reviewed changes

Daniel15 commented Feb 24, 2024

View reviewed changes

Fix code review comments

3753002

tanberry approved these changes Feb 26, 2024

View reviewed changes

tanberry merged commit 2e451f4 into goauthentik:main Feb 26, 2024


		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:

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


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

		Click "Add Social Application"

	Click "Add Social Application"
	3. Click Add Social Application and enter the following details:

	The URL should match the "OpenID Configuration Issuer" URL for the Authentik provider.
	The URL should match the OpenID Configuration Issuer URL for the authentik provider.

	- Client ID: <Client ID from Authentik>
	- Client ID: <Client ID from authentik>

	- Secret key: <Client Secret from Authentik>
	- Secret key: <Client Secret from authentik>

	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.
	This will add a Log in with authentik button to the GlitchTip login 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.

Uh oh!

Conversation

Daniel15 commented Jan 16, 2024

Details

Checklist

Uh oh!

netlify bot commented Jan 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-storybook ready!

Uh oh!

netlify bot commented Jan 16, 2024

✅ Deploy Preview for authentik ready!

Uh oh!

rissson left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jan 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tanberry left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Daniel15 Feb 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tanberry left a comment

Choose a reason for hiding this comment

Uh oh!

Daniel15 commented Feb 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

netlify bot commented Feb 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik ready!

Uh oh!

tanberry left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

netlify bot commented Jan 16, 2024 •

edited

Loading

codecov bot commented Jan 16, 2024 •

edited

Loading

Daniel15 Feb 23, 2024 •

edited

Loading

Daniel15 commented Feb 23, 2024 •

edited

Loading

netlify bot commented Feb 24, 2024 •

edited

Loading