mirror of
https://github.com/goauthentik/authentik
synced 2026-04-27 09:57:31 +02:00
b96c477b6a
* Clean up PostgreSQL documentation * Overview * SSL wording * Conn age * Schema text * Replica line * Direct tip * Backup text * Restore text * Access text * Copy text * Issue text * Sentence case * Section intro * Primary reads * Username text * Password text * TLS modes * Health checks * Replica case * Replica intro * Backup guides * Docker intro * Stop stack * Stop wording * Backup alt * Dump wording * Remove alt * Network note * Verify login * Dump safety * Log names
3.6 KiB
3.6 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
The PostgreSQL database is the most important part of an authentik backup. Without it, authentik cannot be restored to a usable state.
Backup
- The PostgreSQL database stores all persistent authentik data, including users, policies, flows, and configuration.
- Loss of this database means full application data loss.
- Use PostgreSQL-native tooling such as
pg_dump,pg_dumpall, or continuous archiving. - Exclude the PostgreSQL system databases
template0andtemplate1. - Keep backups somewhere other than the database host when possible.
Restore
- Restore the PostgreSQL database before bringing authentik back into service.
- Use PostgreSQL-native restore tooling such as
pg_restoreorpsql, depending on how the backup was created. - Verify that the restored database is complete before reconnecting authentik.
For deployment-specific PostgreSQL upgrade guides, see:
For PostgreSQL connection settings, TLS, replicas, and pooler compatibility, see the PostgreSQL configuration reference.
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 |
|---|---|---|
/data |
Stores application icons, flow backgrounds, uploaded files, and CSV reports. | 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. |