01. Setup

🚀 Setup Guide

This guide will walk you through the process of setting up the Custom Format Sync tool for your Radarr and Sonarr instances.

📋 Prerequisites

• GitHub account
• Access to Radarr and/or Sonarr instances
• API keys for your Radarr and Sonarr instances

🍴 Step 1: Fork the Repository

1. Go to the Servarr Custom Format Sync repository.
2. Click on the "Fork" button in the top-right corner.
3. Select the template-fork branch as the basis for your fork.

🔐 Step 2: Configure GitHub Secrets

1. In your forked repository, go to "Settings" > "Secrets and variables" > "Actions".
2. Add the following secrets for each of your Radarr and Sonarr instances:
   • RADARR_001_URL: The URL of your first Radarr instance
   • RADARR_001_API_KEY: The API key for your first Radarr instance
   • SONARR_001_URL: The URL of your first Sonarr instance
   • SONARR_001_API_KEY: The API key for your first Sonarr instance
   • Repeat for additional instances (002, 003, etc.)

▶️ Step 3: Enable GitHub Actions

1. In your repository, go to the "Actions" tab.
2. Click on "I understand my workflows, go ahead and enable them".
3. Go to "Settings" > "Actions" > "General".
4. Under "Workflow permissions", select "Read and write permissions".

📁 Step 4: Customize Custom Formats

1. Navigate to the custom_formats/ directory in your repository.
2. Modify existing JSON files or add new ones to define your custom formats.
3. Ensure each custom format file includes the necessary sync fields (see 📘 Usage for details).

✅ Step 5: Verify Setup

1. Go to the "Actions" tab in your repository.
2. Click on the "Sync Custom Formats" workflow.
3. Click "Run workflow" and select the main branch.
4. Check the workflow logs to ensure the sync process completes successfully.

🎉 Conclusion

You've now set up the Custom Format Sync tool! The workflow will run automatically on pushes to the main branch that affect the custom_formats/ directory, daily at midnight UTC, and can also be triggered manually.

For more information on using and configuring the tool, please refer to the 📘 Usage and ⚙️ Configuration pages.