Parker
87a0bec85d
Some checks are pending
Create and publish a Docker image / build-and-push-image (push) Waiting to run
64 lines
2.4 KiB
Markdown
64 lines
2.4 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
<img src="cordarr.png" width="200" alt="CordArr Logo"></a>
|
|
<br>
|
|
CordArr<br>
|
|
</h1>
|
|
|
|
<h3 align="center">
|
|
Control your Radarr/Sonarr library and create Jellyfin accounts in Discord
|
|
</h3>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/Rapptz/discord.py/">
|
|
<img src="https://img.shields.io/badge/discord-py-blue.svg" alt="discord.py">
|
|
</a>
|
|
<a href="https://github.com/psf/black">
|
|
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style: Black">
|
|
</a>
|
|
<a href="https://makeapullrequest.com">
|
|
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg">
|
|
</a>
|
|
</p>
|
|
|
|
# Overview
|
|
|
|
CordArr is a self-hosted Discord bot that allows you to add new movies or shows to your Radarr/Sonarr libraries, and allow users to create temporary Jellyfin accounts on your server.
|
|
|
|
# Self-hosting
|
|
|
|
## Docker
|
|
To run Cordarr in Docker, use the provided [docker-compose.yaml](docker-compose.yaml) file as a template for the container. Use the configuration section below to fill out the necessary information.
|
|
|
|
## Bare metal
|
|
To run Cordarr on bare metal, follow the steps below.
|
|
|
|
1. Install Python 3 and Pip
|
|
2. Clone this repository
|
|
3. Install the requirements with `pip install -r requirements.txt`
|
|
4. Run the `code/bot.py` file
|
|
5. Input information into the newly created config.yaml file.
|
|
6. Re-run the `code/bot.py` file.
|
|
|
|
# Configuration
|
|
## BOT_INFO
|
|
Field | Description
|
|
--- | ---
|
|
BOT_TOKEN | The token for your bot. Create a bot at [discord.com/developers](https://discord.com/developers)
|
|
|
|
## RADARR / SONARR | OPTIONAL
|
|
Field | Description
|
|
--- | ---
|
|
HOST_URL | URL for your Radarr/Sonarr instance (e.g. http://localhost:7878)
|
|
API_KEY | API key for Radarr/Sonarr, found in `Settings > General > API Key`
|
|
ROOT_FOLDER_PATH | Folder path found at the bottom of the page in `Settings > Media Management`
|
|
QUALITY_PROFILE_ID | ID for the quality profile to download content in. Run the bot once to get a list of profiles and their IDs
|
|
|
|
## JELLYFIN | OPTIONAL
|
|
Field | Description
|
|
--- | ---
|
|
URL | URL for your Jellyfin server (e.g. http://localhost:8096)
|
|
API_KEY | API key for Jellyfin - can be created in `Dashboard > API Keys`
|
|
ACCOUNT_TIME | Amount of time, in hours, accounts should exist before being deleted
|
|
SIMPLE_PASSWORDS | `true/false` : Whether or not to have simple dictionary word passwords for temporary accounts
|
|
PUBLIC_URL | Public URL for your Jellyfin server. Used in the account creation message |