Skip to content
engels74 edited this page Oct 13, 2024 · 3 revisions

Welcome to the Servarr Custom Format Sync Wiki

This wiki provides detailed information about the Custom Format Sync tool for Radarr and Sonarr. Here you'll find comprehensive guides on setup, configuration, usage, and troubleshooting.

🧭 Navigation

  • Setup: Step-by-step instructions for setting up the Custom Format Sync tool
  • Configuration: Details on environment variables and GitHub Secrets
  • Usage: How to use the system, including custom format JSON structure
  • Troubleshooting: Common issues and their solutions

πŸ“‹ Project Overview

The Custom Format Sync tool automates the process of synchronizing custom formats across multiple Radarr and Sonarr instances. It uses GitHub Actions to periodically check for updates and apply them to your specified instances.

✨ Key Features

  • Sync custom formats to multiple Radarr and Sonarr instances
  • Control which instances receive each custom format
  • Set custom format scores for each quality profile
  • Version tracking to ensure only updated formats are synced
  • Automated syncing using GitHub Actions

🎬 Getting Started

To get started with the Custom Format Sync tool, we recommend following these steps:

  1. Review the Setup guide to fork the repository and configure your environment.
  2. Follow the Configuration instructions to set up your instances and GitHub Secrets.
  3. Read through the Usage guide to understand how to create and manage custom formats.
  4. If you encounter any issues, consult the Troubleshooting page.

If you have any questions or need further assistance, please don't hesitate to open an issue on the GitHub repository.

πŸ“š Additional Resources

Thank you for using the Custom Format Sync tool! We hope it helps streamline your media management workflow.