authentik icon indicating copy to clipboard operation
authentik copied to clipboard

website/integrations: Add hass-openid instructions

Open cavefire opened this issue 6 months ago β€’ 9 comments

Details

This PR updates the documentation to include a custom integration for Home Assistant that enables OAuth2/OpenID support. No modifications have been made to the Authentik codebase.


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)

If applicable

  • [x] The documentation has been updated
  • [x] The documentation has been formatted (make website)

cavefire avatar May 24 '25 09:05 cavefire

Deploy Preview for authentik-docs ready!

Name Link
Latest commit 5967adb4280b6742484d2e4951969e6eb0a7246b
Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/6877cfbf086a0b0008c4981b
Deploy Preview https://deploy-preview-14672--authentik-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

netlify[bot] avatar May 24 '25 09:05 netlify[bot]

Deploy Preview for authentik-storybook ready!

Name Link
Latest commit 5967adb4280b6742484d2e4951969e6eb0a7246b
Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/6877cfbfbf3d8a00089eb557
Deploy Preview https://deploy-preview-14672--authentik-storybook.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

netlify[bot] avatar May 24 '25 09:05 netlify[bot]

OOOO I can't wait to try this. Thank you for your contribution!

rissson avatar May 26 '25 12:05 rissson

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 93.16%. Comparing base (91a675a) to head (5967adb). :warning: Report is 507 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14672      +/-   ##
==========================================
+ Coverage   92.95%   93.16%   +0.20%     
==========================================
  Files         822      831       +9     
  Lines       42481    44140    +1659     
==========================================
+ Hits        39487    41121    +1634     
- Misses       2994     3019      +25     
Flag Coverage Ξ”
e2e 46.63% <ΓΈ> (-1.12%) :arrow_down:
integration 23.48% <ΓΈ> (-0.86%) :arrow_down:
unit 91.25% <ΓΈ> (+0.40%) :arrow_up:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar May 26 '25 12:05 codecov[bot]

Thanks @cavefire ! As you can see we are having trouble with our build process at the moment but as soon as it is cleared up I can get this merged. Thanks so much for your contribution!

tanberry avatar May 27 '25 16:05 tanberry

Hey @tanberry can I do something in order to get this merged?

cavefire avatar Jun 03 '25 18:06 cavefire

Thank you for your patience with our edits and build challenges, @cavefire !

A few more edits by Dominic for you, and then the bigger issue is our question to you about changing the current link into your repo to instead add your docs in the authentik repo... and linking to those. Let us know your thoughts on this please. In general, we don't want to link from our docs into other repos.

Also, for the build challenges, I know you rebased with main but you might need to also run make website-install in your local working branch. I suspect there are some build tools or dependencies that your local working branch doesn't have, so when you push to the PR and our build process starts up, it fails.

tanberry avatar Jun 05 '25 19:06 tanberry

Hey @tanberry changes have been applied and ran make website-install.

cavefire avatar Jun 08 '25 18:06 cavefire

@cavefire thanks for the integration! Are you okay with our forking your integration code over to our GH org (with credit!) so we can keep all the source materials in ~one place, in case we need to make some direct update to repo in the future?

fheisler avatar Jun 09 '25 19:06 fheisler

Deploy Preview for authentik-integrations ready!

Name Link
Latest commit 5967adb4280b6742484d2e4951969e6eb0a7246b
Latest deploy log https://app.netlify.com/projects/authentik-integrations/deploys/6877cfbf02528600089f422c
Deploy Preview https://deploy-preview-14672--authentik-integrations.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

netlify[bot] avatar Jun 24 '25 05:06 netlify[bot]

Thanks again for this contribution @cavefire. I've added tabs to the document to clean it up a bit and applied some other changes.

We'll need to update the proxy section to make it a bit clearer before merging. Otherwise this is shaping up nicely.

dewi-tik avatar Jun 24 '25 07:06 dewi-tik

I haven't forgotten about this, I just need to find time to install this on my HA instance. Hopefully this WE

rissson avatar Jul 04 '25 14:07 rissson

Hey there @cavefire , just a friendly ping regarding this PR. Please let us know if you have any questions or need any assistance. Thanks

dominic-r avatar Aug 02 '25 00:08 dominic-r

Hey @dominic-r, from my point of view this PR is read to be merged. Your comments are on the section, I did not change. This might be for another PR. Thanks!

cavefire avatar Aug 02 '25 07:08 cavefire

Thanks everyone (so many people), especially @cavefire for your work and patience, on this PR! Let'e merge and as mentioned above, do any further word polishing on a diff PR.

tanberry avatar Aug 04 '25 14:08 tanberry