https://github.com/nickheyer/discoflix
A simple media-requesting, Radarr/Sonarr-interfacing, movie and tv show-listing Chat Bot web-app for your media server.
https://github.com/nickheyer/discoflix
discord emby-server javascript media plex python radarr sonarr telegram
Last synced: over 1 year ago
JSON representation
A simple media-requesting, Radarr/Sonarr-interfacing, movie and tv show-listing Chat Bot web-app for your media server.
- Host: GitHub
- URL: https://github.com/nickheyer/discoflix
- Owner: nickheyer
- Created: 2021-07-12T03:20:08.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-02T04:54:10.000Z (over 1 year ago)
- Last Synced: 2025-03-02T05:26:30.774Z (over 1 year ago)
- Topics: discord, emby-server, javascript, media, plex, python, radarr, sonarr, telegram
- Language: Python
- Homepage:
- Size: 103 MB
- Stars: 52
- Watchers: 1
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DiscoFlix
### The ideal way for you and your users to request media via Discord.
Compatible with Radarr & Sonarr. Includes a [REST API](https://www.postman.com/galactic-equinox-215583/workspace/discoflixpublic/documentation/23251960-1f000df7-56aa-495e-9a00-fd0eeefe33ab).
## General Requirements
Running the discord bot requires a [discord developer account](https://discord.com/developers/applications), and a bot created/invited (via your developer account) to your chosen discord server.
As this application is intended to interface with [Sonarr](https://sonarr.tv) and [Radarr](https://radarr.video), you will need one or both installed. If you are installing to a machine that is not also hosting your Radarr/Sonarr, you must be able to access Radarr/Sonarr from the host (locally or remotely).
## Installation (Recommended Method)
### Linux (Fully Automated)
```bash
wget https://raw.githubusercontent.com/nickheyer/DiscoFlix/main/auto_install_update.sh
sudo ./auto_install_update.sh
```
### Installation Using Docker CLI (All Operating Systems)
#### Download Docker Image
To get the latest version of Discoflix, run:
```bash
docker image pull nickheyer/discoflix:latest
```
#### Run Docker Container
To run Discoflix in a container, use the following command. Make sure to mount a volume to `/app/data` in the container so that your data persists across container restarts. Here's how to do it:
**Example**:
```bash
docker run -d -p 5454:5454 --name discoflix -v /opt/discoflix/data:/app/data nickheyer/discoflix
```
**On Other Platforms**:
You can replace `/opt/discoflix/data` with an appropriate path on your local system. For Windows and macOS, specify the full path you want to use for data storage.
This allows DiscoFlix's database to remain on your pc even if you delete or update your container!
##### The server within the docker container can be accessed locally at [http://127.0.0.1:5454](http://127.0.0.1:5454)
### Installation Using Docker-Compose
#### Prep
First, get the compose file:
```bash
mkdir -p /opt/discoflix/data && cd /opt/discoflix
wget https://raw.githubusercontent.com/nickheyer/DiscoFlix/main/docker-compose.yml
```
#### Start the Container Using Docker Compose
With Docker Compose installed on your system, you can start Discoflix by running:
```bash
docker-compose -f /opt/discoflix/docker-compose.yml up -d
```
This will pull the latest Discoflix image and run it, mounting the volume specified in the `docker-compose.yml` file. This will use the default /opt/discoflix/data, so modify this path if needed.
##### The server within the docker container can be accessed locally at [http://127.0.0.1:5454](http://127.0.0.1:5454)
**To stop the service**, use:
```bash
docker-compose -f /opt/discoflix/docker-compose.yml down
```
## Installation From Source (Not Recommended)
### Prerequisites, Dependencies, and Requirements
**_NOTE:_** Installation from source using Windows has been deprecated with the introduction of web-socket functionality, gevent, and other integral parts of this application that are not currently supported by Microsoft.
1. Python - Download and install Python [here](https://www.python.org/downloads/). Make sure that you choose "Add Python to environmental variables" during installation.
2. Git - Download and install Git [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
### Next Steps
1. Change directory to preferred install location
```bash
cd /where/you/want/this/installed
```
2. Clone DiscoFlix
```bash
git clone https://github.com/nickheyer/DiscoFlix
```
3. Change directory to DiscoFlix
```bash
cd ./DiscoFlix
```
4. Install Requirements
```bash
pip install -r requirements.txt
```
5. Run Migrations
```bash
python manage.py migrate
```
6. Run DiscoFlix
```bash
sh ./run.sh
```
## General Instructions
### Accessing The Web-UI
#### *You will need to get the IP address of the computer hosting DiscoFlix. On Windows, you would typically type `ipconfig` on the host machine and look for your `ipv4`.*
> If you are hosting DiscoFlix (using Docker) on the same machine that you are hosting Radarr & Sonarr, you might not be able to access your Radarr & Sonarr using `http://localhost:`, as that would be referencing the localhost of the docker container itself. Instead, use `http://host.docker.internal:` - consider this the `localhost` of the machine hosting the docker container. In some cases, this may not be an issue.
#### *If you would like to access DiscoFlix remotely, as in not on the same network as the host machine, you will need to do some port forwarding to expose port 5454 to the internet. Run into trouble? Feel free to join the [Discord](https://discord.com/invite/6Z9yKTbsrP)!*
### Configuration
#### *DiscoFlix requires a small amount of configuration before you can begin making requests. Discord Token + Radarr and/or Sonarr URL and Token, depending on your use case. If you plan to only use Radarr, disable the Sonarr switch in your configuration menu. Same goes for only using Sonarr.*
#### *To get your Discord Token, go to the "bot" tab in your developer portal. You may need to click "reset Token" and/or enter authentication code if you have 2FA enabled. Make sure to enable all `Privileged Gateway Intents`)*
#### *If you haven't already, now is also a good time to invite the bot to the server or servers you would like to monitor, you can do that via the Discord Developer Portal. Admin access is the only level we have tested. Anything less may result in errors.*
## Usage
### Add Yourself As An Admin
### Test That The Bot Is Running
Type the following into a discord chat message that the bot can see:
```
!df test
```
### Your First Request
Test that the bot is able to access Radarr/Sonarr by making your first test request. Let's use "Dark Phoenix" as an example.
```
!df movie Dark Phoenix
```
We can also test our Sonarr requests. Let's try "Cyberpunk Edgerunners".
```
!df show Cyberpunk Edgerunners
```
*Looks like we already have that on our server, or it's already being monitored!*
### Available Commands
To see the commands available to you, type `!df help`. DiscoFlix should respond with a table containing some or all of the below commands.
| Command | Aliases | Description | Usage |
|---------|-------------------------------|-------------------------------------------|---------------------------|
| Test | test | Confirm bot is on and listening | `!df test` |
| Help | help | Display all authorized commands. | `!df help` |
| Echo | echo | Confirm bot is handling input as intended.| `!df echo `|
| Error | error, err, raise | Confirm bot is handling errors as intended| `!df error [-s]` |
| Log | log, add-log | Confirm bot is logging information to console as intended | `!df log `|
| Movie | movie, add-movie | Request a movie | `!df movie ` |
| Show | show, add-show, tv-show, add-tv-show, tv, tvshow | Request a tv-show | `!df show ` |
| User | user, add-user, add | Add a user | `!df user ` |
> The above commands assume that your command prefix is set to the default `!df`. Adjust accordingly.
> Keep in mind that you will need to mark yourself as "server owner" in the user control panel to use the debug commands.
## API
[](https://app.getpostman.com/run-collection/23251960-1f000df7-56aa-495e-9a00-fd0eeefe33ab?action=collection%2Ffork&collection-url=entityId%3D23251960-1f000df7-56aa-495e-9a00-fd0eeefe33ab%26entityType%3Dcollection%26workspaceId%3Ded14656f-43d1-4444-affa-ebb323d67835)
Or just view the [docs](https://www.postman.com/galactic-equinox-215583/workspace/discoflixpublic/documentation/23251960-1f000df7-56aa-495e-9a00-fd0eeefe33ab).
## Further Notes
- For any other comments or questions, feel free to reach me on discord via NicholasHeyer#4212
- Feel free to join the [Discord](https://discord.com/invite/6Z9yKTbsrP)!
## Authors
- [@nickheyer](https://www.github.com/nickheyer)
## Contributing
Contributions are always welcome!
Email `nick@heyer.app` for ways to get started.