Skip to content

website/docs: add a new page to help people get started after install is complete #19217

Merged
BeryJu merged 46 commits intomainfrom
docs-first-steps
Feb 4, 2026
Merged

website/docs: add a new page to help people get started after install is complete #19217
BeryJu merged 46 commits intomainfrom
docs-first-steps

Conversation

@tanberry
Copy link
Contributor

@tanberry tanberry commented Jan 6, 2026

This PR will add a tutorial style doc to help people get going after they finish installing authentik.

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

@tanberry tanberry requested a review from a team as a code owner January 6, 2026 23:14
@tanberry tanberry marked this pull request as draft January 6, 2026 23:14
@netlify
Copy link

netlify bot commented Jan 6, 2026

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit dd907a1
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/69834c25eee5dd000860ab4e
😎 Deploy Preview https://deploy-preview-19217--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
Copy link

netlify bot commented Jan 6, 2026

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 8703355
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/698350298e8c90000841f629
😎 Deploy Preview https://deploy-preview-19217--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
Copy link

netlify bot commented Jan 6, 2026

Deploy Preview for authentik-integrations ready!

Name Link
🔨 Latest commit 8703355
🔍 Latest deploy log https://app.netlify.com/projects/authentik-integrations/deploys/69835029d1c51e00082ee224
😎 Deploy Preview https://deploy-preview-19217--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.

@codecov
Copy link

codecov bot commented Jan 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.25%. Comparing base (a908704) to head (070327b).
⚠️ Report is 23 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #19217   +/-   ##
=======================================
  Coverage   93.24%   93.25%           
=======================================
  Files         968      968           
  Lines       53429    53429           
=======================================
+ Hits        49822    49827    +5     
+ Misses       3607     3602    -5     
Flag Coverage Δ
conformance 38.05% <ø> (+<0.01%) ⬆️
e2e 44.05% <ø> (+<0.01%) ⬆️
integration 22.76% <ø> (+<0.01%) ⬆️
unit 91.40% <ø> (+<0.01%) ⬆️
unit-migrate 91.42% <ø> (+<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.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

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-070327ba2b53079cfe7bdca79df4739d77c02107
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-070327ba2b53079cfe7bdca79df4739d77c02107

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

@tanberry tanberry requested a review from BeryJu January 14, 2026 22:53
tanberry and others added 2 commits January 14, 2026 18:08
@authentik-automation
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 83.3%, saving 220.0 KB.

Filename Before After Improvement Visual comparison
website/docs/install-config/workflow_first_steps.drawio.png 117.9 KB 18.5 KB 84.3% View diff
website/docs/install-config/install/docker.drawio.png 76.3 KB 14.3 KB 81.3% View diff
website/docs/install-config/install/kubernetes.drawio.png 69.9 KB 11.2 KB 83.9% View diff

@authentik-automation
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 6.9%, saving 1.8 KB.

Filename Before After Improvement Visual comparison
website/docs/install-config/install/docker.drawio.png 14.3 KB 13.1 KB 8.2% View diff
website/docs/install-config/install/kubernetes.drawio.png 11.2 KB 10.6 KB 5.2% View diff

1 image did not require optimisation.

@authentik-automation
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 6.9%, saving 920 B.

Filename Before After Improvement Visual comparison
website/docs/install-config/install/docker.drawio.png 13.1 KB 12.2 KB 6.9% View diff

2 images did not require optimisation.

@tanberry tanberry marked this pull request as ready for review January 21, 2026 20:17
@tanberry tanberry requested a review from dominic-r February 3, 2026 15:59
ingressClassName: nginx | traefik | kong
gateway:
# Specify kubernetes gateway controller class name
GatewayClassName: nginx | traefik | kong
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
GatewayClassName: nginx | traefik | kong
GatewayClassName: nginx # traefik, kong, or other

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is that the syntax, with a hash ??

Copy link
Member

Choose a reason for hiding this comment

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

It denotes a comment, and using | is inaccurate as only one value can be set and others outside of those listed can be as well

@tanberry tanberry dismissed dominic-r’s stale review February 4, 2026 13:46

Made most of the changes, some (like the Podman stuff) will need to go in a future PR

@BeryJu BeryJu merged commit 3fd278e into main Feb 4, 2026
93 of 94 checks passed
@BeryJu BeryJu deleted the docs-first-steps branch February 4, 2026 14:31
@tanberry tanberry added the backport/version-2025.12 Add this label to PRs to backport changes to version-2025.12 label Feb 5, 2026
authentik-automation bot pushed a commit that referenced this pull request Feb 5, 2026
This cherry-pick has conflicts that need manual resolution.

Original PR: #19217
Original commit: 3fd278e
@authentik-automation
Copy link
Contributor

⚠️ Cherry-pick to version-2025.12 has conflicts: #20061

dominic-r pushed a commit that referenced this pull request Feb 5, 2026
This cherry-pick has conflicts that need manual resolution.

Original PR: #19217
Original commit: 3fd278e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport/version-2025.12 Add this label to PRs to backport changes to version-2025.12

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants