README.md

Arrchive

Arrchive uploads mirrors of your *Arr app database backups to Google Drive.

It's lightweight, runs in Docker, features a configurable retention limit, and optionally sends notifications via Discord.

Supported *Arr Apps:

• Radarr
• Sonarr
• Prowlarr
• Bazarr
• Profilarr

Features

• Uploads compressed .zip backups from your *Arr apps to Google Drive.
• Automatically removes old backup mirrors based on your retention limit.
• Optional Discord integration for logs and backup notifications.
• Easy to deploy via Docker or run standalone with Python.

Getting Started

Quick Start: Docker Compose

Note

Arrchive is designed to run on a schedule to periodically mirror backups. cron is recommended.

Here's an example compose.yaml to get started. Run it with docker compose up.

services:
  arrchive:
    container_name: arrchive
    image: ethanchrisp/arrchive:latest
    environment:
      LOG_LEVEL: INFO
      LOG_DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/YYYYYYYY/YYYYYYYY
      LOG_DISCORD_WEBHOOK_LEVEL: WARNING
      DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/XXXXXXXX/XXXXXXXX
      BAZARR_BACKUP_PATH: /container/path/to/bazarr/backups
      PROFILARR_BACKUP_PATH: /container/path/to/profilarr/backups
      PROWLARR_BACKUP_PATH: /container/path/to/prowlarr/backups
      RADARR_BACKUP_PATH: /container/path/to/radarr/backups
      SONARR_BACKUP_PATH: /container/path/to/sonarr/backups
      GOOGLE_SERVICE_EMAIL: [email protected]
      GOOGLE_SERVICE_CLIENT_ID: 000000000000000000000
      GOOGLE_SERVICE_PRIVATE_KEY_ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      GOOGLE_SERVICE_PRIVATE_KEY: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      GOOGLE_DRIVE_FOLDER_ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      BACKUP_RETAIN_LIMIT: 3
    volumes:
      - /local/path/to/bazarr/backups:/container/path/to/bazarr/backups:ro
      - /local/path/to/profilarr/backups:/container/path/to/profilarr/backups:ro
      - /local/path/to/prowlarr/backups:/container/path/to/prowlarr/backups:ro
      - /local/path/to/radarr/backups:/container/path/to/radarr/backups:ro
      - /local/path/to/sonarr/backups:/container/path/to/sonarr/backups:ro

Standalone: Python

Note

Python 3.13 or later required.

1. Install dependencies.

   uv sync

2. Rename .env.example to .env and configure your environment.

3. Run Arrchive

   uv run arrchive.py

Google Drive (Required)

1. Create a new Project in the Google Cloud console.
   • (Recommended) Project Name: Arrchive
   • After creation, select the Project.
2. Enable the Google Drive API for the Arrchive project.
3. Create a new Service Account for the Arrchive project.
   • (Recommended) Servive Account Name: Arrchive
   • (Recommended) Service Account Description: https://github.com/EthanC/Arrchive
   • Create and Continue
4. Grant the Arrchive Service Account access to the Arrchive project.
   • (Recommended) Service Account Role: Owner
   • Continue -> Done
5. Obtain a Private Key for the Service Account.
   • Actions -> Manage Keys -> Add Key -> Create a new Key -> JSON -> Private Key saved to your Computer
6. Set the corresponding environment variables using the values in the JSON file.
7. Open Google Drive and create a folder for *Arr application backups to be stored.
   • (Recommended) Folder Name: Arrchive
8. Share the backup folder to the Service Account email address with Editor permissions.
9. Open the Arrchive folder and copy its ID from the page URL.
   • Example: https://drive.google.com/drive/folders/ARRCHIVE_FOLDER_ID
   • Set the GOOGLE_DRIVE_FOLDER_ID environment variable to this value.

Environment Variables

Variable	Description	Required?
LOG_LEVEL	Loguru console log level.	No
DISCORD_WEBHOOK_URL	Notifications for backup success/failure.	No
LOG_DISCORD_WEBHOOK_URL	For sending log events to Discord.	No
LOG_DISCORD_WEBHOOK_LEVEL	Minimum log level for Discord logs.	No
BAZARR_BACKUP_PATH	Local path to Bazarr backup .zip files.	No
PROFILARR_BACKUP_PATH	Local path to Profilarr backup .zip files.	No
PROWLARR_BACKUP_PATH	Local path to Prowlarr backup .zip files.	No
RADARR_BACKUP_PATH	Local path to Radarr backup .zip files.	No
SONARR_BACKUP_PATH	Local path to Sonarr backup .zip files.	No
GOOGLE_SERVICE_EMAIL	Google Service Account Email Address.	Yes
GOOGLE_SERVICE_CLIENT_ID	Google Service Account Client ID.	Yes
GOOGLE_SERVICE_PRIVATE_KEY_ID	Google Service Account Private Key ID.	Yes
GOOGLE_SERVICE_PRIVATE_KEY	Google Service Account Private key	Yes
GOOGLE_DRIVE_FOLDER_ID	Folder ID from Google Drive URL.	Yes
BACKUP_RETAIN_LIMIT	Maximum number of backups to keep per app.	No

Thanks

• Pirate icon courtesy of Adrien Coquet via Noun Project.