Developing Custom Formats & Quality Profiles

This page will guide you on setting up development instances of Radarr and Sonarr to be used in the development of profilarr.

Setup

1. Install Docker Containers for Radarr and Sonarr: Run docker-compose up -d to start the containers.

2. Set Authentication for Radarr and Sonarr: Once the containers are up, access Radarr at <your-ip>:7887 and Sonarr at <your-ip>:8998. Set up authentication by navigating to Settings -> General and configuring the security settings.

3. Configure Profilarr: After setting up the instances and noting down their API keys, run py setup.py to generate a config file. Update the the API key settings for the dev instances of Radarr and Sonarr

4. Import Custom Formats and Profile: Run py importarr.py and import the nessecary settings to your development instances of Radarr and Sonarr.

5. Add your indexers: (through prowlarr or otherwise)

Testing

1. Create Custom Formats and Profiles: Inside your dev instances, create and test new custom formats and profiles for the current issue you are tackling.

2. Export Changes: Run py exportarr.py to export any new / changed CFs or profiles.

3. Overrwrite old files: With your exported files, move them into their mirroed location inside the 'imports' folder. For example, if you exported Custom formats for Radarr, you would overwrite the same file inside imports/custom_formats/radarr/<file>

4. Push your changes: Following the contributing guide, commit and push your changes to your chosen branch and submit a PR for review and merge!