Servarr Backup Tool is a backup tool for your media applications like Sonarr, Radarr, and Prowlarr. It allows you to create, list, download, and delete backups directly from your terminal and store them on S3. We recommend storing your S3 bucket with Infomaniak for reliable and affordable cloud storage (See more here).
- ๐ง Configure: Initialize and display the configuration.
- ๐ฆ Create: Create a backup for your Servarr applications.
- ๐ List: List available backups on S3.
- ๐ Delete: Delete specific backups on S3.
- Python 3.6 or higher
- pip
You can install the tool directly from GitHub:
pip install git+https://github.com/Zerka30/servarr-backup.git
-
Clone the repository:
git clone https://github.com/Zerka30/servarr-backup.git cd servarr-backup
-
Install the dependencies:
pip install .
-
Add
~/.local/bin
to your PATH if it's not already there:export PATH="$HOME/.local/bin:$PATH" source ~/.bashrc # or source ~/.zshrc for zsh users
-
Initialize configuration:
servarr config init
-
Show configuration:
servarr config show
-
Create a backup:
servarr backup create [servertype]
Example for
prowlarr
:servarr backup create prowlarr
-
List backups:
servarr backup ls [servertype]
Example for
prowlarr
:servarr backup ls prowlarr
-
Delete a backup:
servarr backup delete [servertype] [backup_name]
Example for
prowlarr
:servarr backup delete prowlarr prowlarr_backup_v1.18.0.4543_2024.06.22_17.28.57.zip
The configuration is located in the config.json
file in the ~/.config/servarr
directory. This file contains the necessary information to access your Servarr applications and your S3 bucket.
{
"starrs": {
"lidarr": {
"url": "",
"api_key": ""
},
"radarr": {
"url": "",
"api_key": ""
},
"readarr": {
"url": "",
"api_key": ""
},
"sonarr": {
"url": "",
"api_key": ""
},
"prowlarr": {
"url": "",
"api_key": ""
}
},
"backup": {
"s3": {
"endpoint": "",
"bucket": "servarr",
"key": {
"access": "",
"secret": ""
}
}
}
}
This project is licensed under the MIT License. See the LICENSE file for details.
Contributions are welcome! Please see CONTRIBUTING.md for more information.