Function create_backup

apps/backups/services.py:229–280

Create a backup archive containing database dump and data directories. Returns the path to the created backup file.

()

def create_backup() -> Path:
    """
    Create a backup archive containing database dump and data directories.
    Returns the path to the created backup file.
    """
    backup_dir = get_backup_dir()

    # Use system timezone for filename (user-friendly), but keep internal timestamps as UTC
    system_tz_name = CoreSettings.get_system_time_zone()
    try:
        system_tz = pytz.timezone(system_tz_name)
        now_local = datetime.datetime.now(datetime.UTC).astimezone(system_tz)
        timestamp = now_local.strftime("%Y.%m.%d.%H.%M.%S")
    except Exception as e:
        logger.warning(f"Failed to use system timezone {system_tz_name}: {e}, falling back to UTC")
        timestamp = datetime.datetime.now(datetime.UTC).strftime("%Y.%m.%d.%H.%M.%S")

    backup_name = f"dispatcharr-backup-{timestamp}.zip"
    backup_file = backup_dir / backup_name

    logger.info(f"Creating backup: {backup_name}")

    with tempfile.TemporaryDirectory(prefix="dispatcharr-backup-") as temp_dir:
        temp_path = Path(temp_dir)

        # Determine database type and dump accordingly
        if _is_postgresql():
            db_dump_file = temp_path / "database.dump"
            _dump_postgresql(db_dump_file)
            db_type = "postgresql"
        else:
            db_dump_file = temp_path / "database.sqlite3"
            _dump_sqlite(db_dump_file)
            db_type = "sqlite"

        # Create ZIP archive with compression and ZIP64 support for large files
        with ZipFile(backup_file, "w", compression=ZIP_DEFLATED, allowZip64=True) as zip_file:
            # Add database dump
            zip_file.write(db_dump_file, db_dump_file.name)

            # Add metadata
            metadata = {
                "format": "dispatcharr-backup",
                "version": 2,
                "database_type": db_type,
                "database_file": db_dump_file.name,
                "created_at": datetime.datetime.now(datetime.UTC).isoformat(),
            }
            zip_file.writestr("metadata.json", json.dumps(metadata, indent=2))

    logger.info(f"Backup created successfully: {backup_file}")
    return backup_file


def restore_backup(backup_file: Path) -> None: