chadwpalm/prerollplus repository overview

Documentation for Preroll Plus can be found at: https://prerollplus.org⁠

⁠Tags

The latest tag will always be the latest stable release. You can also run images that are of a particular version number. These will simple show the version number. The develop tag will be the latest development release. Development releases will have newer features to be tested, but cannot be guaranteed to be stable. Earlier development releases can be also be used and they contain a version number preceded by the word develop.

⁠Usage

⁠docker cli

docker run -d \
  --name=prerollplus \
  --network host
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=America/Los_Angeles \
  -v /path/to/config:/config \
  -v /path/to/preroll/files:/prerolls \
  --restart unless-stopped \
  chadwpalm/prerollplus:latest

Note: Even though the config file is typically not accessed by any other software (though this does not discourage anyone who wants to write one), setting the PUID and GUID variables to match the host's user and group can help resolve any permission issues.

⁠docker compose

  prerollplus:
    image: chadwpalm/prerollplus:latest
    container_name: prerollplus
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/Los_Angeles
    network_mode: "host"
    volumes:
      - /path/to/config:/config
      - /path/to/preroll/files:/prerolls
    restart: unless-stopped

Using --network host (CLI) or network_mode: "host" (Docker Compose) forces the Docker container to use the host's network configuration which includes the host's IP address, Netmask, Gateway, etc. This will allow the Hue Bridge discovery to be able to use mDNS for its search. Otherwise Preroll Plus will use Hue Discovery and grab the bridge IP address from the Hue Cloud.

If you want to use a different port to access Preroll Plus you will not be able to use host mode with the Docker container. Consult with Docker's documentation on how to re-route ports.

⁠Setting Up Webhooks

Preroll Plus is dependent on the use of webhooks coming from a Plex Media Server to function.

You must be a Plex Media Server admin to access the webhooks setting on the server. From you Plex settings under your account name, select the Webhooks menu item to open up the webhooks page. Click the Add Webhook button. You will be prompted to enter a URL. The format for the URL is as follows:

http://<ip_address>:<port>/webhook

The IP address will be the address where Preroll Plus is running. The port number will depend on whether Lumunarr is running natively or within a Docker container. If running natively, the default port will be 4949. If running in a Docker container, the port will be what was set as the external port when the Docker container was initiated. Unless changed this will probably also be port 4949.

It is also important that the URL has /webhook included as that is the landing URL where webhooks are processed within Preroll Plus.

Once changes are saved all webhooks will be sent to Preroll Plus and will start processing client profiles.