Skip to content

website/docs: update user object doc#14132

Merged
dewi-tik merged 4 commits intomainfrom
website/docs/update-user-object-doc
Apr 23, 2025
Merged

website/docs: update user object doc#14132
dewi-tik merged 4 commits intomainfrom
website/docs/update-user-object-doc

Conversation

@dewi-tik
Copy link
Contributor

Details

Updated the user object/reference doc to newer formatting and fixes a few issues.


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

@netlify
Copy link

netlify bot commented Apr 17, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 28f83c7
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/6807da1b9143c7000806d50f
😎 Deploy Preview https://deploy-preview-14132--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.

@netlify
Copy link

netlify bot commented Apr 17, 2025

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit 28f83c7
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/6807da1b089dea000834477f
😎 Deploy Preview https://deploy-preview-14132--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 site configuration.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 17, 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-28f83c7092df42bad37fec295d54f2a99ebb903b
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-28f83c7092df42bad37fec295d54f2a99ebb903b

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

Co-authored-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
@codecov
Copy link

codecov bot commented Apr 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.80%. Comparing base (1209dd0) to head (28f83c7).
Report is 35 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14132      +/-   ##
==========================================
+ Coverage   92.74%   92.80%   +0.06%     
==========================================
  Files         799      808       +9     
  Lines       41232    41419     +187     
==========================================
+ Hits        38240    38440     +200     
+ Misses       2992     2979      -13     
Flag Coverage Δ
e2e 47.81% <ø> (+0.11%) ⬆️
integration 24.25% <ø> (+0.14%) ⬆️
unit 90.64% <ø> (+0.03%) ⬆️

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.

Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
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 so much @dewi-tik it's really great to have clearly labeled examples in our docs!

@dewi-tik dewi-tik marked this pull request as ready for review April 23, 2025 07:25
@dewi-tik dewi-tik requested a review from a team as a code owner April 23, 2025 07:25
@dewi-tik dewi-tik merged commit 2cc5f4b into main Apr 23, 2025
91 checks passed
@dewi-tik dewi-tik deleted the website/docs/update-user-object-doc branch April 23, 2025 07:26
kensternberg-authentik added a commit that referenced this pull request Apr 25, 2025
* main:
  packages/docusaurus-theme: Fix header alignment, overscroll, vertical padding. (#14120)
  outposts: add support for gateway API (#13272)
  translate: Updates for file web/xliff/en.xlf in fr (#14200)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in fr (#14199)
  website/docs: adds code examples for getting user objects from a group object (#14101)
  translate: Updates for file web/xliff/en.xlf in zh-Hans (#14198)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#14195)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#14197)
  translate: Updates for file web/xliff/en.xlf in zh_CN (#14196)
  website/integrations: mealie add integration (#14188)
  core, web: update translations (#14187)
  core: bump goauthentik.io/api/v3 from 3.2025024.8 to 3.2025024.9 (#14189)
  website/docs: update user object doc (#14132)
  website/docs: dev-docs: style guide: no longer using italic for vars (#14185)
  website/docs: dev docs: style guide: update style conventions for urls (#14184)
  website/integrations: paperless: use <slug>. instead of hardcoded slug value (#14183)
  website/docs: updates style guide code block section (#14088)
  website: components: delete multilinecodeblock src (#14094)
  Revert "policies: buffered policy access view for concurrent authorization attempts when unauthenticated (#13629)" (#14180)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants