Skip to content

Installation

J_Brns edited this page Mar 11, 2026 · 4 revisions

Installation Guide

This guide covers installing NeXroll on different platforms.

System Requirements

  • Plex Media Server, Jellyfin (10.10+), or Emby (4.8+)
  • Network access between NeXroll and your media server
  • Storage space for preroll videos
  • FFmpeg (required for thumbnail generation, video scaling, and Coming Soon List Generator)

Installation Options

Platform Recommended For
Docker Most users, servers, NAS devices
Windows Windows desktop users
Python Developers, advanced users

Docker

Docker is the easiest and recommended installation method.

Quick Start

docker run -d \
  --name nexroll \
  -p 9393:9393 \
  -e TZ=America/New_York \
  -v ./nexroll-data:/data \
  -v /path/to/prerolls:/data/prerolls \
  jbrns/nexroll:latest

Docker Compose

version: '3.8'
services:
  nexroll:
    image: jbrns/nexroll:latest
    container_name: nexroll
    ports:
      - "9393:9393"
    environment:
      - TZ=America/New_York
    volumes:
      - ./nexroll-data:/data
      - /path/to/prerolls:/data/prerolls
    restart: unless-stopped

See the Docker Setup guide for detailed configuration options.


Windows

Windows Installer

  1. Download the latest installer from GitHub Releases
  2. Run the NeXroll_Installer_v*.exe file
  3. Follow the installation wizard
  4. Launch NeXroll from the Start Menu

Windows Service (Optional)

To run NeXroll as a background service:

  1. Open the NeXroll installation folder
  2. Run install-service.bat as Administrator
  3. The service starts automatically on boot

System Tray App

The installer includes a system tray application:

  • Right-click the tray icon for quick access
  • Start/stop the server
  • Open the web interface

Python (Manual)

For developers or advanced users who want to run from source.

Prerequisites

  • Python 3.10 or higher
  • pip (Python package manager)
  • FFmpeg (for thumbnails, video scaling, and Coming Soon List generation)
  • Git (optional, for cloning)

Installation Steps

# Clone the repository
git clone https://github.com/JFLXCLOUD/NeXroll.git
cd NeXroll

# Create virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # Linux/Mac
# or: venv\Scripts\activate  # Windows

# Install dependencies
pip install -r requirements.txt

# Run NeXroll
cd NeXroll/backend
python main.py

Running as a Service (Linux)

Create a systemd service file /etc/systemd/system/nexroll.service:

[Unit]
Description=NeXroll Preroll Manager
After=network.target

[Service]
Type=simple
User=your-user
WorkingDirectory=/path/to/NeXroll/NeXroll/backend
ExecStart=/path/to/venv/bin/python main.py
Restart=always

[Install]
WantedBy=multi-user.target

Enable and start:

sudo systemctl enable nexroll
sudo systemctl start nexroll

Unraid

NeXroll is available in Unraid Community Applications.

  1. Go to Apps in Unraid
  2. Search for "NeXroll"
  3. Click Install
  4. Configure paths and ports
  5. Click Apply

See Docker Setup for Unraid-specific configuration.


Post-Installation

After installing:

  1. Open NeXroll at http://localhost:9393 (or your server's IP)
  2. (Optional) Set up Authentication if you want to secure access
  3. Go to the Connect tab
  4. Connect to your Plex, Jellyfin, or Emby server
  5. For Jellyfin/Emby: Install the NeXroll Intros plugin — see Jellyfin Setup or Emby Setup
  6. Configure Path Mappings if needed
  7. Start adding prerolls!

Updating

Docker

docker pull jbrns/nexroll:latest
docker stop nexroll
docker rm nexroll
# Re-run your docker run command

Or with Docker Compose:

docker compose pull
docker compose up -d --force-recreate

Windows

Download and run the latest installer — it will update your existing installation.

Python

git pull
pip install -r requirements.txt --upgrade

Next Steps

Clone this wiki locally