Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website/docs: Add Fleet integration. #13618

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

GirlBossRush
Copy link
Contributor

Details

This PR adds a guide for Fleet Device Management


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

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

@GirlBossRush GirlBossRush added the documentation Improvements or additions to documentation label Mar 21, 2025
@GirlBossRush GirlBossRush requested a review from tanberry March 21, 2025 18:33
@GirlBossRush GirlBossRush self-assigned this Mar 21, 2025
@GirlBossRush GirlBossRush requested a review from a team as a code owner March 21, 2025 18:33
Copy link

netlify bot commented Mar 21, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit d031bb0
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67e1cb513503f10007f60240
😎 Deploy Preview https://deploy-preview-13618--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 site configuration.

Copy link

netlify bot commented Mar 21, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit d031bb0
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67e1cb51ae37990008146c73

Copy link

codecov bot commented Mar 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.76%. Comparing base (50e2f1c) to head (d031bb0).
Report is 32 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #13618      +/-   ##
==========================================
+ Coverage   91.73%   92.76%   +1.03%     
==========================================
  Files         794      794              
  Lines       40502    40525      +23     
==========================================
+ Hits        37156    37595     +439     
+ Misses       3346     2930     -416     
Flag Coverage Δ
e2e 47.96% <ø> (-0.04%) ⬇️
integration 24.29% <ø> (?)
unit 90.53% <ø> (+<0.01%) ⬆️

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.

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

Copy link
Contributor

github-actions bot commented Mar 21, 2025

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

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

Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow looks great, thank you @teffen! I made a few edits; let me know if you want to try and get this merged tonight.

Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Teffen Ellis <[email protected]>

By the end of this integration, your users will be able to log into Fleet using their authentik credentials.

Your authentik and Fleet instance must both be running and accessible on an HTTPS domain.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Your authentik and Fleet instance must both be running and accessible on an HTTPS domain.
Your authentik and Fleet instances must both be running and accessible on an HTTPS domain.


2. For the **App name** enter `Fleet` and click **Next**.

3. Choose **SAML** as the **Provider Type** and click **Next**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can delete this line... it's a dupe of Step 4, on line 43, no? Sorry I missed that earlier!

Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @GirlBossRush! Two more things, both of which I missed on first pass, sorry!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants