Skip to content

website/docs: configuration: cleanup postgres section#14544

Merged
tanberry merged 29 commits into
goauthentik:mainfrom
dominic-r:sdko/config-cleanup-pg
Jul 4, 2025
Merged

website/docs: configuration: cleanup postgres section#14544
tanberry merged 29 commits into
goauthentik:mainfrom
dominic-r:sdko/config-cleanup-pg

Conversation

@dominic-r
Copy link
Copy Markdown
Member

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)

@dominic-r dominic-r requested a review from a team as a code owner May 18, 2025 00:48
@netlify
Copy link
Copy Markdown

netlify Bot commented May 18, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 8ac467b
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/68681ccb698cfa000747233a
😎 Deploy Preview https://deploy-preview-14544--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
Copy Markdown

netlify Bot commented May 18, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 8ac467b
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/68681ccbf2950b0008bfb5d7

@codecov
Copy link
Copy Markdown

codecov Bot commented May 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.04%. Comparing base (262ca4a) to head (8ac467b).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14544      +/-   ##
==========================================
- Coverage   93.05%   93.04%   -0.01%     
==========================================
  Files         824      824              
  Lines       42755    42755              
==========================================
- Hits        39787    39783       -4     
- Misses       2968     2972       +4     
Flag Coverage Δ
e2e 47.53% <ø> (-0.05%) ⬇️
integration 24.19% <ø> (+<0.01%) ⬆️
unit 91.04% <ø> (ø)

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.

Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
dominic-r and others added 3 commits May 20, 2025 09:57
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>
@tanberry tanberry marked this pull request as draft June 11, 2025 17:21
Copy link
Copy Markdown
Member

@rissson rissson left a comment

Choose a reason for hiding this comment

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

few nits, otherwise lgtm

Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
@rissson
Copy link
Copy Markdown
Member

rissson commented Jun 12, 2025

FYI this will conflict with #15023 but we should get that one merged asap because it's advertising an option that doesn't exist.

@dominic-r
Copy link
Copy Markdown
Member Author

I'll rebase this one once the one liked is merged

Copy link
Copy Markdown
Member

@rissson rissson left a comment

Choose a reason for hiding this comment

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

One small nit, otherwise LGTM

Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Co-authored-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Dominic R <dominic@sdko.org>
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
- `AUTHENTIK_POSTGRESQL__NAME`: The name of the database for authentik to use.

:::info Hot-reloading
The `AUTHENTIK_POSTGRESQL__HOST`, `AUTHENTIK_POSTGRESQL__PORT`, `AUTHENTIK_POSTGRESQL__USER`, and `AUTHENTIK_POSTGRESQL__PASSWORD` settings support hot-reloading and can be changed without restarting authentik. However, adding or removing read replicas requires a restart.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We could link "read replicas" to our docs on that topic... though not essential.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

we have read replica docs?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes I mean the same ones you worked on below, on this page, line 93. ;-)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

oh

Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx
Comment thread website/docs/install-config/configuration/configuration.mdx Outdated
Comment thread website/docs/install-config/configuration/configuration.mdx
Copy link
Copy Markdown
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.

It's great to have so much more info and details in this page! Thanks @dominic-r, so much.

Some minor points, some changes that need to be made (capitalization), but approving now so I am not the blocker.

dominic-r and others added 6 commits July 4, 2025 14:17
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Dominic R <dominic@sdko.org>
Signed-off-by: Dominic R <dominic@sdko.org>
@dominic-r
Copy link
Copy Markdown
Member Author

63 comments; horror

@tanberry tanberry merged commit 12847d9 into goauthentik:main Jul 4, 2025
104 checks passed
@dominic-r dominic-r deleted the sdko/config-cleanup-pg branch July 4, 2025 20:13
@dominic-r dominic-r self-assigned this Mar 28, 2026
@github-project-automation github-project-automation Bot moved this from Todo to Done in authentik Core Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants