mirror of
https://github.com/Dictionarry-Hub/profilarr.git
synced 2026-01-22 10:51:02 +01:00
1272e4009853e47df9fddeae08490dc17464d1da
- feat: add GitHub workflows for building Docker images for beta and release - fix: update notify workflow to trigger on version tags
Profilarr
Configuration management tool for Radarr/Sonarr that automates importing and version control of custom formats and quality profiles.
Features
- 🔄 Automatic synchronization with remote configuration databases
- 🎯 Direct import to Radarr/Sonarr instances
- 🔧 Git-based version control of your configurations
- ⚡ Preserve local customizations during updates
- 🛠️ Built-in conflict resolution
Tech Stack
- Frontend: React + Vite
- Backend: Flask + Gunicorn
- Database: SQLite
Installation
Docker Compose (recommended)
services:
profilarr:
image: santiagosayshey/profilarr:beta # we're still in beta!
container_name: profilarr
ports:
- 6868:6868
volumes:
- /path/to/your/data:/config
environment:
- TZ=UTC # Set your timezone
env_file:
- .env # Optional: Only needed if contributing to a database
restart: unless-stopped
Configuration
If you want to contribute to the a database, create a .env file:
GIT_USER_NAME=your_username
GIT_USER_EMAIL=your_email
PROFILARR_PAT=your_github_pat
Port
The web interface is accessible on port 6868 by default.
Volumes
| Path | Description |
|---|---|
/config |
Contains app database and cloned configuration database |
Environment Variables
| Variable | Description | Required |
|---|---|---|
TZ |
Timezone (e.g., America/New_York) | Yes |
GIT_USER_NAME |
GitHub username for contributing | No |
GIT_USER_EMAIL |
GitHub email for contributing | No |
PROFILARR_PAT |
GitHub Personal Access Token for contributing | No |
Usage
- Access the web interface at http://localhost:6868
- Clone a configuration database and/or setup your own custom formats / quality profiles
- Configure your Radarr/Sonarr instances, set what / when configuations should be imported
Development
Prerequisites
- Docker and Docker Compose
Local Setup
git clone https://github.com/Dictionarry-Hub/profilarr
cd profilarr
docker compose up --build
This will start both the Flask and Vite development servers.
Join the Community
Support Development
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Status
Currently in beta. Part of the Dictionarry project to simplify media automation.
Languages
JavaScript
64.8%
Python
34.8%
CSS
0.2%