Files
authentik/website/docs/sys-mgmt/ops/backup-restore.md
Marc 'risson' Schmitt 23357f45e9 *: remove Redis leftovers (#17146)
* *: remove Redis leftovers

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* more removal

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* fix leftover

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* more removal

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* lint

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* fix broken anchor

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* re-add redis for previous version migrations

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

---------

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Co-authored-by: Jens Langhammer <jens@goauthentik.io>
2025-10-11 01:46:53 +02:00

2.9 KiB
Raw Blame History

title, sidebar_label
title sidebar_label
Backup and restore your authentik instance Backup & Restore

This guide outlines the critical components to back up and restore in authentik.

PostgreSQL database

Backup

  • Role: Stores all persistent data (users, policies, configurations, etc.).
  • Impact of Loss: Complete data loss, requiring full restoration to recover functionality.
  • Backup Guidance:
  • Official Documentation: PostgreSQL Backup and Restore

Restore

  • Restoration Importance: Essential for full recovery; authentik will not function without it.
  • Restoration Guidance:
    • Use PostgreSQL's pg_restore or other official methods.

Static directories

These directories are mounted as volumes in containerized installations and must be restored if they were part of the backup to maintain authentiks expected functionality.

Directory Purpose Backup and Restore Notes
/media Stores application icons, flow backgrounds, and uploaded files. Only required if not using S3 external storage. External storage should be backed up using the AWS S3 Sync utility.
/certs Stores TLS certificates in the filesystem. Backup if you rely on these certificates present in the filesystem. Not needed if authentik has already imported them, as certificates are stored in the database.
/custom-templates Stores custom changes to the authentik UI. Required if you modified authentik's default appearance.
/blueprints Stores blueprints. Optional but recommended if using custom blueprints.