Skip to content

Installation

Jump to bottom
RetroIPTVGuide Wiki Sync edited this page Apr 26, 2026 · 1 revision

Installation

This page covers all supported installation methods for RetroIPTVGuide.

Docker (Recommended)

Docker is the recommended and best-supported deployment method.

Pull and Run

docker pull ghcr.io/thehack904/retroiptvguide:latest
docker run -d -p 5000:5000 ghcr.io/thehack904/retroiptvguide:latest

Open http://<server-ip>:5000.

Docker Compose

A ready-to-use docker-compose.yml is included in the docker/ directory.

git clone https://github.com/thehack904/RetroIPTVGuide.git
cd RetroIPTVGuide/docker
cp .env.example .env
# Edit .env to set your timezone and secret key
docker compose up -d

For full Docker Compose documentation see docker/README_DOCKER.md.

Updating (Docker)

docker compose pull && docker compose up -d

Uninstalling (Docker)

docker compose down -v

Linux

Install — Option A: From a downloaded release archive

Download the .zip or .tar.gz from the Releases page, extract it, and run the installer from inside the extracted directory:

# Example using v4.9.4
wget https://github.com/thehack904/RetroIPTVGuide/archive/refs/tags/v4.9.4.tar.gz
tar -xzf v4.9.4.tar.gz
cd RetroIPTVGuide-4.9.4
sudo bash retroiptv_linux.sh install --agree

The installer detects that app.py and requirements.txt are present alongside the script and uses those files directly — no git clone is performed.

Install — Option B: curl one-liner (clones from GitHub)

curl -sSL https://raw.githubusercontent.com/thehack904/RetroIPTVGuide/main/retroiptv_linux.sh \
  | sudo bash -s install --agree --yes

If the full repository is not detected in the current directory the installer will ask for confirmation before cloning from GitHub. Pass --yes to skip the prompt in non-interactive environments.

Default install location: /home/iptv/iptv-server

Update

sudo /home/iptv/iptv-server/retroiptv_linux.sh update --yes

Uninstall

sudo /home/iptv/iptv-server/retroiptv_linux.sh uninstall --yes

Raspberry Pi

Supported hardware: Raspberry Pi 3, 4, and 5.

Install — Option A: From a downloaded release archive

wget https://github.com/thehack904/RetroIPTVGuide/archive/refs/tags/v4.9.4.tar.gz
tar -xzf v4.9.4.tar.gz
cd RetroIPTVGuide-4.9.4
sudo bash retroiptv_rpi.sh install --agree

The installer detects the local release files and skips the GitHub clone step.

Install — Option B: curl one-liner (clones from GitHub)

curl -sSL https://raw.githubusercontent.com/thehack904/RetroIPTVGuide/main/retroiptv_rpi.sh \
  | sudo bash -s install --agree --yes

If the full repository is not detected in the current directory the installer will ask for confirmation before cloning. Pass --yes to skip the prompt.

Update

sudo /home/iptv/iptv-server/retroiptv_rpi.sh update --yes

Uninstall

sudo /home/iptv/iptv-server/retroiptv_rpi.sh uninstall --yes

Windows

⚠️ Deprecation Notice: The Windows installer will be discontinued in v5.0. Docker is the recommended deployment method going forward. See Docker above.

Install — Option A: From a downloaded release archive

Download the .zip from the Releases page, extract it, then open PowerShell as Administrator inside the extracted folder and run:

Set-ExecutionPolicy Bypass -Scope Process -Force
.\retroiptv_windows.ps1 install --agree

The installer detects that app.py and requirements.txt are present and uses those files directly — no git clone is performed.

Install — Option B: Download script and run (clones from GitHub if needed)

Set-ExecutionPolicy Bypass -Scope Process -Force
Invoke-WebRequest https://raw.githubusercontent.com/thehack904/RetroIPTVGuide/main/retroiptv_windows.bat `
  -OutFile retroiptv_windows.bat
.\retroiptv_windows.bat install

If the full repository is not detected in the current directory the installer will ask for confirmation before cloning from GitHub. Pass --yes to skip the prompt.

Default Login

Field Value
Username admin
Password strongpassword123

You are required to change the password immediately after the first login.

Admin Password Recovery

If the admin password is lost it can be reset from the command line.

python3 /home/iptv/iptv-server/scripts/reset_admin_password.py \
  --db /home/iptv/iptv-server/config/users.db

Run as the user that owns the database file to avoid permission errors:

sudo -u iptv python3 /home/iptv/iptv-server/scripts/reset_admin_password.py \
  --db /home/iptv/iptv-server/config/users.db

On success the admin password is reset and the account is flagged to require a password change on next login.

For full recovery steps see INSTALL.md.

System Requirements

Component Minimum
Python 3.10+
RAM 512 MB
Disk 500 MB (plus EPG cache)
Network Local LAN access to IPTV source

Stream playback requires HLS segmented streams from your IPTV backend. RetroIPTVGuide does not transcode streams.

Next Steps

Clone this wiki locally