Skip to content

website/docs: Password Uniqueness Policy#13686

Merged
melizeche merged 14 commits intomainfrom
docs/policies/unique_password
Apr 29, 2025
Merged

website/docs: Password Uniqueness Policy#13686
melizeche merged 14 commits intomainfrom
docs/policies/unique_password

Conversation

@melizeche
Copy link
Member

Details

Documentation for #13453


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)

@melizeche melizeche requested a review from a team as a code owner March 27, 2025 18:29
@netlify
Copy link

netlify bot commented Mar 27, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 571d2a3
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/6810e1d15823c20008144c04

@netlify
Copy link

netlify bot commented Mar 27, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 571d2a3
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/6810e1d103bf0c0008ea8985
😎 Deploy Preview https://deploy-preview-13686--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.

@melizeche melizeche changed the title Docs/policies: Password Uniqueness Policy docs/policies: Password Uniqueness Policy Mar 27, 2025
@melizeche
Copy link
Member Author

@tanberry I added a separate file for this feature so it's easier to set the tags

@codecov
Copy link

codecov bot commented Mar 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.75%. Comparing base (8c7d4d2) to head (571d2a3).
Report is 400 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #13686      +/-   ##
==========================================
- Coverage   92.76%   92.75%   -0.01%     
==========================================
  Files         794      809      +15     
  Lines       40545    41533     +988     
==========================================
+ Hits        37610    38525     +915     
- Misses       2935     3008      +73     
Flag Coverage Δ
e2e 47.85% <ø> (-0.09%) ⬇️
integration 24.39% <ø> (+0.11%) ⬆️
unit 90.56% <ø> (+0.02%) ⬆️

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.

@melizeche melizeche changed the title docs/policies: Password Uniqueness Policy website/docs: Password Uniqueness Policy Mar 27, 2025
Copy link
Member

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

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

Marcelo, Thank you for this doc page! Here are my little suggestions. Please do LMK if you need any clarifications!

@github-actions
Copy link
Contributor

github-actions bot commented Mar 27, 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-571d2a32155e82a00798b09edda923f4ef5598e8
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-571d2a32155e82a00798b09edda923f4ef5598e8

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

@melizeche melizeche requested a review from dominic-r March 27, 2025 20:39
Copy link
Member

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

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

@melizeche Marcelo, thanks for this PR! I added a little suggestion to conform to the style guide, otherwise LGTM!

Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Marcelo Elizeche Landó <marce@melizeche.com>
@melizeche
Copy link
Member Author

@dominic-r this shouldn't be merged until we release 2025.4 because that's when this feature will be released
If we merge now it could cause confusion because it's going to be shown in the documentation

1. In the Admin interface, navigate to **Customization** -> **Policies**.
2. Create a **Password Uniqueness Policy**
3. Set **Number of Historical Passwords** to 3
4. Bind the policy to your **password prompt stage**
Copy link
Contributor

Choose a reason for hiding this comment

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

@melizeche is the password prompt stage either a custom one that created or also the default-password-change-prompt stage?

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's give them a bit more help on how to do the binding.

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 @melizeche great docs, just a few questions (about the prompt stage) and a suggestion for one of the sections, and of course nit-pics. :-) Let me know if you want to meet to go over these suggestions!

melizeche and others added 3 commits April 29, 2025 14:59
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Marcelo Elizeche Landó <marce@melizeche.com>
@melizeche melizeche requested a review from tanberry April 29, 2025 13:40
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.

Thank you so much for these excellent docs @melizeche ! Cool feature, too. ;-)

@melizeche melizeche merged commit 8b6ac3c into main Apr 29, 2025
91 checks passed
@melizeche melizeche deleted the docs/policies/unique_password branch April 29, 2025 18:29
melizeche added a commit that referenced this pull request Apr 29, 2025
* First draft docs for policies/unique_password

* simplify documentation

* fix styling

* Add clarification about when this policy takes effect

* change wording in how it works

Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Marcelo Elizeche Landó <marce@melizeche.com>

* Take the user by the hand and tell them where to go

* Improve wording in Configuration options

* add suggestion from PR

Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Marcelo Elizeche Landó <marce@melizeche.com>

* Update website/docs/customize/policies/unique_password.md

Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>

* Apply suggestions from code review

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

* fix linting and wording

* Add instructions for binding

* Remove conf options section, add to sidebar

* Update website/docs/customize/policies/unique_password.md

Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>

---------

Signed-off-by: Marcelo Elizeche Landó <marce@melizeche.com>
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
Co-authored-by: Dominic R <dominic@sdko.org>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
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