mirror of
https://github.com/Dictionarry-Hub/profilarr.git
synced 2026-01-22 10:51:02 +01:00
feat: add preview image and update README with new badges and installation instructions
This commit is contained in:
Sam Chau
BIN
.github/images/preview.png
vendored
Normal file
BIN
.github/images/preview.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 863 KiB |
102
README.md
102
README.md
@@ -1,11 +1,17 @@
|
||||
# Profilarr
|
||||
|
||||
[](https://hub.docker.com/r/santiagosayshey/profilarr)
|
||||
[](https://hub.docker.com/r/santiagosayshey/profilarr)
|
||||
[](https://github.com/Dictionarry-Hub/profilarr/issues)
|
||||
[](https://github.com/Dictionarry-Hub/profilarr/releases)
|
||||
[](https://hub.docker.com/r/santiagosayshey/profilarr)
|
||||
[](https://github.com/Dictionarry-Hub/profilarr/blob/main/LICENSE)
|
||||
[](https://dictionarry.dev/)
|
||||
[](https://discord.com/invite/Y9TYP6jeYZ)
|
||||
[](https://www.buymeacoffee.com/santiagosayshey)
|
||||
[](https://github.com/sponsors/Dictionarry-Hub)
|
||||
|
||||
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
|
||||
@@ -14,95 +20,53 @@ Configuration management tool for Radarr/Sonarr that automates importing and ver
|
||||
- ⚡ Preserve local customizations during updates
|
||||
- 🛠️ Built-in conflict resolution
|
||||
|
||||
## Tech Stack
|
||||
## Getting Started
|
||||
|
||||
- **Frontend**: React + Vite
|
||||
- **Backend**: Flask + Gunicorn
|
||||
- **Database**: SQLite
|
||||
|
||||
## Installation
|
||||
|
||||
### Docker Compose (recommended)
|
||||
### Quick Installation
|
||||
|
||||
```yaml
|
||||
services:
|
||||
profilarr:
|
||||
image: santiagosayshey/profilarr:beta # we're still in beta!
|
||||
image: santiagosayshey/profilarr:latest # Use :beta for early access to new features
|
||||
container_name: profilarr
|
||||
ports:
|
||||
- 6868:6868
|
||||
volumes:
|
||||
- /path/to/your/data:/config
|
||||
- /path/to/your/data:/config # Replace with your actual path
|
||||
environment:
|
||||
- TZ=UTC # Set your timezone
|
||||
env_file:
|
||||
- .env # Optional: Only needed if contributing to a database
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## Configuration
|
||||
After deployment, access the web UI at `http://[address]:6868` to begin setup.
|
||||
|
||||
If you want to contribute to the a database, create a `.env` file:
|
||||
> **Note for Windows users:** The database is case-sensitive. Use a docker volume or the WSL file system to avoid issues:
|
||||
>
|
||||
> - Docker volume example: `profilarr_data:/config`
|
||||
> - WSL filesystem example: `/home/username/docker/profilarr:/config`
|
||||
|
||||
```
|
||||
GIT_USER_NAME=your_username
|
||||
GIT_USER_EMAIL=your_email
|
||||
PROFILARR_PAT=your_github_pat
|
||||
```
|
||||
### Complete Documentation
|
||||
|
||||
### Port
|
||||
Visit our comprehensive documentation at [dictionarry.dev/wiki/profilarr-setup](https://dictionarry.dev/wiki/profilarr-setup) for detailed installation instructions and usage guides.
|
||||
|
||||
The web interface is accessible on port 6868 by default.
|
||||
## Support
|
||||
|
||||
### Volumes
|
||||
### Need Help?
|
||||
|
||||
| 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
|
||||
|
||||
1. Access the web interface at http://localhost:6868
|
||||
2. Clone a configuration database and/or setup your own custom formats / quality profiles
|
||||
3. Configure your Radarr/Sonarr instances, set what / when configuations should be imported
|
||||
|
||||
## Development
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Docker and Docker Compose
|
||||
|
||||
### Local Setup
|
||||
|
||||
```bash
|
||||
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
|
||||
|
||||
<img src="https://invidget.switchblade.xyz/Y9TYP6jeYZ" alt="Discord Invite">
|
||||
|
||||
## Support Development
|
||||
|
||||
- 💖 [GitHub Sponsors](https://github.com/sponsors/Dictionarry-Hub)
|
||||
- ☕ [Buy Me A Coffee](https://www.buymeacoffee.com/santiagosayshey)
|
||||
- **Bug Reports & Issues**: Submit technical issues via our [GitHub Issues tracker](https://github.com/Dictionarry-Hub/profilarr/issues)
|
||||
- **Community Support**: Join our [Discord community](https://discord.com/invite/Y9TYP6jeYZ) for help from developers and other users
|
||||
- **Database Issues**: Please direct database-specific issues to their respective repositories, as this repository focuses exclusively on Profilarr development
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||
We welcome contributions from the community! Here's how you can help improve Profilarr:
|
||||
|
||||
- **Pull Requests**: Feel free to submit PRs for bug fixes or new features
|
||||
- **Feature Suggestions**: Share your ideas through GitHub issues
|
||||
- **Documentation**: Help improve our guides and documentation
|
||||
- **Testing**: Try new features and report any issues
|
||||
|
||||
Detailed contributing guidelines will be available soon. Join our Discord to discuss potential contributions with the development team.
|
||||
|
||||
## Status
|
||||
|
||||
|
||||
Reference in New Issue
Block a user