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

docs: sys mgmt: document authentik backups #12943

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dominic-r
Copy link
Contributor

Details

What?

This PR documents the process of backing up authentik by providing commands for K8s deployments as well as docker compose deployments. It includes commands to dump the postgres database to a .sql file on disk (which the user will then backup normally), mentions backup of /media, /certs, /custom-templates which are all supposed to be mounted on host system or as a volume thingy. More details TBD. I'll go with the flow

Closes

Closes #8411


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)

Signed-off-by: Dominic R <[email protected]>
Copy link

netlify bot commented Feb 6, 2025

Deploy Preview for authentik-docs canceled.

Name Link
🔨 Latest commit 178eb49
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67a4ea97eb1aa20008cb379b

Copy link

netlify bot commented Feb 6, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 178eb49
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67a4ea97eb1aa20008cb3799

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.69%. Comparing base (26a08fc) to head (178eb49).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12943      +/-   ##
==========================================
- Coverage   92.70%   92.69%   -0.01%     
==========================================
  Files         785      785              
  Lines       39580    39580              
==========================================
- Hits        36692    36689       -3     
- Misses       2888     2891       +3     
Flag Coverage Δ
e2e 48.42% <ø> (-0.06%) ⬇️
integration 24.54% <ø> (ø)
unit 90.43% <ø> (+<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.

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.

docs: How to backup and restore Authentik
1 participant