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

stages/authenticator_email: Email Authenticator Stage Documentation (cherry-pick #12853) #13218

Merged
merged 2 commits into from
Feb 24, 2025

Conversation

rissson
Copy link
Member

@rissson rissson commented Feb 24, 2025

#12853)

  • stages/authenticator_email: Add initial documentation for Email Authenticator Stage

  • fix linting/styling

  • Apply suggestions from code review

  • Apply suggestions from code review

  • rearranged to match the UI

  • fix my broken links

  • Tweak Emil Authenticator stage, also capitalize names of other stages

  • final tweaks

  • Add authenticator_validate for Email Authenticator in authenticator_validate documentation

  • add version badge

  • Fix broken links (.md -> .mdx)


Details

REPLACE ME


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)

…12853)

* stages/authenticator_email: Add initial documentation for Email Authenticator Stage

* fix linting/styling

* Apply suggestions from code review

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Marcelo Elizeche Landó <marce@melizeche.com>

* Apply suggestions from code review

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Marcelo Elizeche Landó <marce@melizeche.com>

* rearranged to match the UI

* fix my broken links

* Tweak Emil Authenticator stage, also capitalize names of other stages

* final tweaks

* Add authenticator_validate for Email Authenticator in authenticator_validate documentation

* add version badge

* Fix broken links (.md -> .mdx)

---------

Signed-off-by: Marcelo Elizeche Landó <marce@melizeche.com>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Co-authored-by: Tana M Berry <tana@goauthentik.com>
@rissson rissson requested a review from a team as a code owner February 24, 2025 13:44
Copy link

codecov bot commented Feb 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.70%. Comparing base (5c5cc1c) to head (1d85077).
Report is 6 commits behind head on version-2025.2.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@                Coverage Diff                 @@
##           version-2025.2   #13218      +/-   ##
==================================================
+ Coverage           92.65%   92.70%   +0.05%     
==================================================
  Files                 792      792              
  Lines               40229    40229              
==================================================
+ Hits                37273    37296      +23     
+ Misses               2956     2933      -23     
Flag Coverage Δ
e2e 48.10% <ø> (+0.07%) ⬆️
integration 24.12% <ø> (ø)
unit 90.42% <ø> (ø)

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.

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
@rissson rissson merged commit 2ba7962 into version-2025.2 Feb 24, 2025
72 of 73 checks passed
@rissson rissson deleted the cherry-pick-12853 branch February 24, 2025 13:57
Copy link

netlify bot commented Feb 24, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 1d85077
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67bc79706faf3100083f7053
😎 Deploy Preview https://deploy-preview-13218--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
Contributor

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-1d85077102f487d528e0201ec942ac736fa8f547
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-1d85077102f487d528e0201ec942ac736fa8f547

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

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