authentik icon indicating copy to clipboard operation
authentik copied to clipboard

website/integrations: add omada controller doc

Open dewi-tik opened this issue 6 months ago β€’ 7 comments

Details

WIP - not ready for review

Adds an integration doc for omada controller and updates the integrations sidebar.

Closes #14508


If applicable

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

dewi-tik avatar May 15 '25 14:05 dewi-tik

Deploy Preview for authentik-docs ready!

Name Link
Latest commit 853efb1ebb73f9d141fb3ec26401b9b056321437
Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/68600a522630b10008326b56
Deploy Preview https://deploy-preview-14523--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 15 '25 14:05 netlify[bot]

Deploy Preview for authentik-storybook canceled.

Name Link
Latest commit 853efb1ebb73f9d141fb3ec26401b9b056321437
Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/68600a529cf9d70008e24846

netlify[bot] avatar May 15 '25 14:05 netlify[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 93.03%. Comparing base (877f312) to head (853efb1). Report is 2 commits behind head on main.

:white_check_mark: All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14523      +/-   ##
==========================================
+ Coverage   92.98%   93.03%   +0.05%     
==========================================
  Files         824      824              
  Lines       42695    42695              
==========================================
+ Hits        39700    39722      +22     
+ Misses       2995     2973      -22     
Flag Coverage Ξ”
e2e 47.54% <ΓΈ> (+0.08%) :arrow_up:
integration 24.21% <ΓΈ> (+<0.01%) :arrow_up:
unit 91.02% <ΓΈ> (ΓΈ)

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 15 '25 14:05 codecov[bot]

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-853efb1ebb73f9d141fb3ec26401b9b056321437
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-853efb1ebb73f9d141fb3ec26401b9b056321437

Afterwards, run the upgrade commands from the latest release notes.

github-actions[bot] avatar May 16 '25 11:05 github-actions[bot]

Running into significant errors with software controller. Continuous errors about the browser being incompatible when accessing the SAML log in link. Same issue on multiple operating systems and browsers. I've contacted TPlink to request advice.

dewi-tik avatar May 21 '25 07:05 dewi-tik

Any updates from TPLink?

cheggerdev avatar May 30 '25 10:05 cheggerdev

Any updates from TPLink?

Not much progress so far. Potentially a bug on their side. Will update this PR as soon as there's progress.

dewi-tik avatar May 30 '25 11:05 dewi-tik

Deploy Preview for authentik-integrations ready!

Name Link
Latest commit 853efb1ebb73f9d141fb3ec26401b9b056321437
Latest deploy log https://app.netlify.com/projects/authentik-integrations/deploys/68600a5251e87700071173d3
Deploy Preview https://deploy-preview-14523--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 18 '25 14:06 netlify[bot]

@cheggerdev I've tested this config with the software controller and it works. Could you please test with your Omada Controller setup?

dewi-tik avatar Jun 18 '25 14:06 dewi-tik

@cheggerdev I've tested this config with the software controller and it works. Could you please test with your Omada Controller setup?

Thank you for doing this. Great work! I left some nits in the comments.

In the verification step I get this message:

Screenshot 2025-06-23 at 10 03 18

This is very strange because the direct login works perfectly with my browser.

cheggerdev avatar Jun 23 '25 08:06 cheggerdev

@cheggerdev I've tested this config with the software controller and it works. Could you please test with your Omada Controller setup?

Thank you for doing this. Great work! I left some nits in the comments.

In the verification step I get this message: Screenshot 2025-06-23 at 10 03 18

This is very strange because the direct login works perfectly with my browser.

When you say "direct login", what are you referring to? I couldn't see any direct login option on the software controller login screen.

dewi-tik avatar Jun 23 '25 09:06 dewi-tik

@cheggerdev I've tested this config with the software controller and it works. Could you please test with your Omada Controller setup?

Thank you for doing this. Great work! I left some nits in the comments. In the verification step I get this message: Screenshot 2025-06-23 at 10 03 18 This is very strange because the direct login works perfectly with my browser.

When you say "direct login", what are you referring to? I couldn't see any direct login option on the software controller login screen.

By "direct login" I mean the non-SSO-Login without authentik.

cheggerdev avatar Jun 23 '25 09:06 cheggerdev

@cheggerdev I've tested this config with the software controller and it works. Could you please test with your Omada Controller setup?

Thank you for doing this. Great work! I left some nits in the comments. In the verification step I get this message: Screenshot 2025-06-23 at 10 03 18 This is very strange because the direct login works perfectly with my browser.

When you say "direct login", what are you referring to? I couldn't see any direct login option on the software controller login screen.

By "direct login" I mean the non-SSO-Login without authentik.

Update: The browser incompatibility issue is a firmware issue. I noticed TP-Link released a release-candidate of a new firmware. After installing this error disappeared.

In my test installation I have a Software Controller behind an reverse proxy.

There I get this link

https://omada.company:8043//login?accessToken=

which fails because of the reverse proxy. When remove the port manually then it works.

I will test the Hardware Controller ASAP.

cheggerdev avatar Jun 23 '25 10:06 cheggerdev

By "direct login" I mean the non-SSO-Login without authentik.

Ok This makes sense. I thought that there was an option to initiate SSO login from the Omada controller that I'd missed.

Update: The browser incompatibility issue is a firmware issue. I noticed TP-Link released a release-candidate of a new firmware. After installing this error disappeared.

Thanks for the update.

dewi-tik avatar Jun 23 '25 11:06 dewi-tik

When I try the Validation part, then for both Software and Hardware Controller I get:

{"errorCode":-30199,"msg":"Temporary user is not within the validity period."}

cheggerdev avatar Jul 04 '25 13:07 cheggerdev

When I try the Validation part, then for both Software and Hardware Controller I get:

{"errorCode":-30199,"msg":"Temporary user is not within the validity period."}

Very strange. I'm not sure why the omada controller would be attempting to create a temporary user for you. Although this might be an expected part of the setup process, but it's failing for some reason.

One thing that could be causing this is a mismatch between the time on your controller and your client.

Otherwise I'd have to suggest raising this with tp-link/omada support as it's an error on their side.

dewi-tik avatar Jul 04 '25 14:07 dewi-tik