Files
authentik/website/docs/sys-mgmt/ops/backup-restore.md
Dominic R 349f66e53c website/docs: sys mgmt: document authentik backups/restoration (#12943)
* init

Signed-off-by: Dominic R <dominic@sdko.org>

* docs: sys mgmt: add backup documentation

* adapt command as you're already as root in postgres from what I tested and this is the easiest no-config-change solution that works

* Marc's comment

* href continuous archiving for pg

* add to sidebar

* restore documentation

* tana is gonna yell at me

* start

* static directories table fix my mess

* Update website/docs/sys-mgmt/ops/backup-restore.md

Signed-off-by: Dominic R <dominic@sdko.org>

* Update website/docs/sys-mgmt/ops/backup-restore.md

Signed-off-by: Dominic R <dominic@sdko.org>

---------

Signed-off-by: Dominic R <dominic@sdko.org>
2025-03-07 15:16:40 -06:00

3.7 KiB

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.

Redis database

Backup

  • Role: Manages temporary data:
    • User sessions (lost data = users must reauthenticate).
    • Pending tasks (e.g., queued emails, outpost syncs).
  • Impact of Loss: Service interruptions (e.g., users logged out), but no permanent data loss.
  • Backup Guidance:
  • Official Documentation: Redis Persistence

Restore

  • Restoration Importance: Service impact but no permanent data loss.
  • Restoration Guidance:

Static directories

These directories are mounted as volumes in containerized installations and must be restored if they were part of the backup to maintain authentik’s 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.