Skip to main content

Self-Hosted Installer Backup Recommendations

This document outlines where critical data is stored and suggests high-level industry best practices without delving into the technical details of backup strategies.

Section 1: Application Deployment Configuration​

  • Name: config.yaml
  • Why: Contains the core application configuration; used for re-installation and re-configuration.
  • Where: Downloadable from the application (e.g., via “Download” in the UI or CLI).
  • Suggested Industry Best Practices (in brief):
    • Version control for config files.
    • Store backups securely (encrypted, off-site).
    • Automate regular snapshots.

Section 2: Evidence Uploads and Cookbooks​

  • Why: Stores critical objects, such as files users upload for verification, plus “cookbooks” the application requires.
  • Where: S3 Bucket
  • Suggested Industry Best Practices (in brief):
    • Use lifecycle policies (versioning, retention, cross-region replication).
    • Encrypt data at rest and in transit.
    • Enforce proper access controls (IAM policies, role-based restrictions).

Section 3: Core Application Data​

  • Why: Includes the database schema, user records, and all other essential application information that is not in S3.
  • Where: PostgreSQL
  • Suggested Industry Best Practices (in brief):
    • Maintain redundancy through replication (e.g., hot standby).
    • Take regular database snapshots for quick restore in case of data corruption or other failures.

Putting It All Together​

When executing the backup strategy for your self-hosted environment:

  1. Identify each component (configuration, evidence uploads and cookbooks, core application data).
  2. Regularly back up data according to your chosen frequency and retention policies.
  3. Secure your backups with encryption and appropriate access controls.
  4. Test restorations periodically to ensure backups are valid and restorable.

By following these industry practices, you can help ensure your self-hosted application remains recoverable in the event of a disaster or for rollback purposes.