🛠️ Installation & Setup

Welcome to the installation guide for iPlayarr — your automated DVR for BBC iPlayer.

---

🚀 Requirements

• Docker (recommended)
• UK-accessible IP address (for iPlayer access)
• Sonarr/Radarr for integration
• Optional: external Redis instance

---

🐳 Option 1: Run with Docker (Recommended)

docker run -d --name iplayarr \
  -v ./cache:/data \
  -v ./config:/config \
  -v /path/to/incomplete:/incomplete \
  -v /path/to/complete:/complete \
  --env-file=env-file \
  -p 4404:4404 \
  nikorag/iplayarr:latest

Replace /path/to/... with your local directories.

🧱 Option 2: Build Locally from Source

1. Clone the repository:

git clone https://github.com/Nikorag/iplayarr.git
cd iplayarr

2. Build the image:

docker build -t iplayarr .

3. Run it:

docker run -d --name iplayarr \
  -v ./cache:/data \
  -v ./config:/config \
  -v /your/incomplete:/incomplete \
  -v /your/complete:/complete \
  --env-file=env-file \
  -p 4404:4404 \
  iplayarr

⚙️ Option 3: Use Docker Compose

Create a docker-compose.yml file:

services:
  iplayarr:
    image: "nikorag/iplayarr:latest"
    container_name: "iplayarr"
    environment:
      - "API_KEY=1234"
      - "DOWNLOAD_DIR=/mnt/media/iplayarr/incomplete"
      - "COMPLETE_DIR=/mnt/media/iplayarr/complete"
      - "PUID=1000"
      - "PGID=1000"
    ports:
      - "4404:4404"
    volumes:
      - "/mnt/media:/mnt/media"
      - "./cache:/data"
      - "./config:/config"

Then run:

docker compose up -d

🔐 Environment Variables

You can predefine these in your .env file or use the Settings page in the web UI.

Property	Description
API_KEY	Api key to secure your iplayarr instance
DOWNLOAD_DIR	Download directory for in progress pulls
COMPLETE_DIR	Directory to move completed files to

Optional Variables

Property	Description
ACTIVE_LIMIT	How many downloads are allowed simultaneously, defaults to 3
REFRESH_SCHEDULE	Cron expression for when to pro-actively refresh schedule, defaults to hourly, on the hour
HIDE_DONATE	If you don't like the Kofi donate links you can hide them
PUID	Host User ID for file permissions
PGID	Host Group ID for file permissions

🌍 Accessing the Web Interface

Once running, open your browser and navigate to:

http://<Your_Docker_Host>:4404

Log in with the default credentials:

Username	Password
admin	password

You can now configure iPlayarr, set up integrations, and start downloading content!