Plex-Automatic-Pre-roll-GUI/README.md

# Rollarr
This is the new and improved Automatic Pre-roll script with a GUI for Plex now called Rollarr! It should be stable but if you find a bug please let me know

## Docker Edition

## What is this?
This is a python script with web GUI that allows you to automate your Plex Server Pre-roll.
You can find out more about Plex Pre-roll here: https://support.plex.tv/articles/202920803-extras/
You can specify if you would like your pre-roll updated monthly, weekly, daily, or for specific holidays.
For example you can have this setup to apply a standard Pre-roll during regular times of the year and then during holidays update the pre-roll automatically!

## Requirements
-[Python 3.7+](https://www.python.org/)
(Probably works on a lower version haven't tested)

-[PlexAPI](https://github.com/pkkid/python-plexapi)


## Installation

Simply install like any other docker and expose the port 3100 and map the location of your pre-roll files

```
docker pull thehumanrobot/rollarr:latest
```

## Usage

### Setting Plex Preroll

~~You need to schedule a job for updating the preroll each day, week, or month depending how you want your pre-rolls updated.
You will now point this at the PrerollUpdate.py script~~ This is no longer required for the docker container since I have written some code to ensure the pre-roll is synced every 60s

##### Docker Command
```
docker run -v /data.json:/docker/configs/rollarr/data.json -p 3100:3100 rollarr 
```
/data.json can be changed to anywhere you want to store you data.json file
ex: /home/media/data.json:/docker/configs/rollarr/data.json

## Running For The First Time
Connect to the IP of your docker system on port 3100

The first time you run it you will see this:


![image](https://user-images.githubusercontent.com/75536101/147721648-bbd89cc5-dfba-4736-9998-37e8473dbecb.png)



Fill in all the fields for your plex IP and Token

How to get token: https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/ 

You can then setup a default pre-roll if you want or leave it blank

To set specific pre-roll fuctions select which type you want (Monthly, Weekly, Daily, Holiday Custom), You will then see more fields on the right
### *The path to the videos must be reachable by your Plex Server!*

Monthly:
![image](https://user-images.githubusercontent.com/75536101/147721694-24749a2f-e3ca-43e4-80b6-c858297064e7.png)


Weekly:
![image](https://user-images.githubusercontent.com/75536101/147721730-9181aeca-8347-4b19-8e46-2484cea477e2.png)

Daily:
![image](https://user-images.githubusercontent.com/75536101/147721754-8ea2ed1e-1e07-4868-a91d-49b61de22ee2.png)


Holiday (If you want another holiday you can add that by using the weekly function and setting a date) :
![image](https://user-images.githubusercontent.com/75536101/147721767-9f56834e-7330-4752-bde8-fad438c90573.png)

Custom:
![image](https://user-images.githubusercontent.com/75536101/147721789-8569ff67-e4b6-4573-9f8e-576333f89416.png)


### Once you finish setting that up whatever you select in the Schedule section will be what the script will run on

For example in this photo

![image](https://user-images.githubusercontent.com/75536101/146993632-4decbe1e-d942-4c4a-b431-2bc68568f7c0.png)

I have selected Holiday and enabled the Christmas list therefore it will run through my Christmas list. If it does not find one enabled, finds empty strings, or does not match the holiday dates set in the system it will attempt to pull from the Default files.

I hope this is useful for some people and feel free to post any ideas or bugs