overseerr Installation Guide Installation Guide

overseerr is a free and open-source request management for Plex. Overseerr manages media requests with Plex integration and a modern UI

Hardware Requirements:

CPU: 1 core minimum

RAM: 512MB minimum

Storage: 500MB for app

Network: HTTP/HTTPS access

Operating System:

Linux: Any modern distribution (RHEL, Debian, Ubuntu, CentOS, Fedora, Arch, Alpine, openSUSE)

macOS: 10.14+ (Mojave or newer)

Windows: Windows Server 2016+ or Windows 10

FreeBSD: 11.0+

Network Requirements:

Port 5055 (default overseerr port)

None

Dependencies:

See official documentation for specific requirements

System Access: root or sudo privileges required

This guide supports installation on:

RHEL 8/9 and derivatives (CentOS Stream, Rocky Linux, AlmaLinux)

Debian 11/12

Ubuntu 20.04/22.04/24.04 LTS

Arch Linux (rolling release)

Alpine Linux 3.18+

openSUSE Leap 15.5+ / Tumbleweed

SUSE Linux Enterprise Server (SLES) 15+

macOS 12+ (Monterey and later)

FreeBSD 13+

Windows 10/11/Server 2019+ (where applicable)

bash

# Install EPEL repository if needed
sudo dnf install -y epel-release

# Install overseerr
sudo dnf install -y overseerr

# Enable and start service
sudo systemctl enable --now overseerr

# Configure firewall
sudo firewall-cmd --permanent --add-port=5055/tcp
sudo firewall-cmd --reload

# Verify installation
overseerr --version

bash

# Update package index
sudo apt update

# Install overseerr
sudo apt install -y overseerr

# Enable and start service
sudo systemctl enable --now overseerr

# Configure firewall
sudo ufw allow 5055

# Verify installation
overseerr --version

bash

# Install overseerr
sudo pacman -S overseerr

# Enable and start service
sudo systemctl enable --now overseerr

# Verify installation
overseerr --version

bash

# Install overseerr
apk add --no-cache overseerr

# Enable and start service
rc-update add overseerr default
rc-service overseerr start

# Verify installation
overseerr --version

bash

# Install overseerr
sudo zypper install -y overseerr

# Enable and start service
sudo systemctl enable --now overseerr

# Configure firewall
sudo firewall-cmd --permanent --add-port=5055/tcp
sudo firewall-cmd --reload

# Verify installation
overseerr --version

bash

# Using Homebrew
brew install overseerr

# Start service
brew services start overseerr

# Verify installation
overseerr --version

bash

# Using pkg
pkg install overseerr

# Enable in rc.conf
echo 'overseerr_enable="YES"' >> /etc/rc.conf

# Start service
service overseerr start

# Verify installation
overseerr --version

bash

# Using Chocolatey
choco install overseerr

# Or using Scoop
scoop install overseerr

# Verify installation
overseerr --version

bash

# Create configuration directory
sudo mkdir -p /etc/overseerr

# Set up basic configuration
# See official documentation for detailed configuration options

# Test configuration
overseerr --version

bash

# Enable service
sudo systemctl enable overseerr

# Start service
sudo systemctl start overseerr

# Stop service
sudo systemctl stop overseerr

# Restart service
sudo systemctl restart overseerr

# Check status
sudo systemctl status overseerr

# View logs
sudo journalctl -u overseerr -f

bash

# Enable service
rc-update add overseerr default

# Start service
rc-service overseerr start

# Stop service
rc-service overseerr stop

# Restart service
rc-service overseerr restart

# Check status
rc-service overseerr status

bash

# Enable in /etc/rc.conf
echo 'overseerr_enable="YES"' >> /etc/rc.conf

# Start service
service overseerr start

# Stop service
service overseerr stop

# Restart service
service overseerr restart

# Check status
service overseerr status

bash

# Using Homebrew services
brew services start overseerr
brew services stop overseerr
brew services restart overseerr

# Check status
brew services list | grep overseerr

powershell

# Start service
net start overseerr

# Stop service
net stop overseerr

# Using PowerShell
Start-Service overseerr
Stop-Service overseerr
Restart-Service overseerr

# Check status
Get-Service overseerr

See the official documentation for advanced configuration options.

nginx

upstream overseerr_backend {
    server 127.0.0.1:5055;
}

server {
    listen 80;
    server_name overseerr.example.com;
    return 301 https://$server_name$request_uri;
}

server {
    listen 443 ssl http2;
    server_name overseerr.example.com;

    ssl_certificate /etc/ssl/certs/overseerr.example.com.crt;
    ssl_certificate_key /etc/ssl/private/overseerr.example.com.key;

    location / {
        proxy_pass http://overseerr_backend;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

apache

<VirtualHost *:80>
    ServerName overseerr.example.com
    Redirect permanent / https://overseerr.example.com/
</VirtualHost>

<VirtualHost *:443>
    ServerName overseerr.example.com
    
    SSLEngine on
    SSLCertificateFile /etc/ssl/certs/overseerr.example.com.crt
    SSLCertificateKeyFile /etc/ssl/private/overseerr.example.com.key
    
    ProxyRequests Off
    ProxyPreserveHost On
    
    ProxyPass / http://127.0.0.1:5055/
    ProxyPassReverse / http://127.0.0.1:5055/
</VirtualHost>

haproxy

frontend overseerr_frontend
    bind *:80
    bind *:443 ssl crt /etc/ssl/certs/overseerr.pem
    redirect scheme https if !{ ssl_fc }
    default_backend overseerr_backend

backend overseerr_backend
    balance roundrobin
    server overseerr1 127.0.0.1:5055 check

bash

# Set appropriate permissions
sudo chown -R overseerr:overseerr /etc/overseerr
sudo chmod 750 /etc/overseerr

# Configure firewall
sudo firewall-cmd --permanent --add-port=5055/tcp
sudo firewall-cmd --reload

# Enable SELinux policies (if applicable)
sudo setsebool -P httpd_can_network_connect on

See official documentation for database configuration requirements.

bash

# Basic system tuning
echo 'net.core.somaxconn = 65535' | sudo tee -a /etc/sysctl.conf
echo 'net.ipv4.tcp_max_syn_backlog = 65535' | sudo tee -a /etc/sysctl.conf
sudo sysctl -p

bash

# Check service status
sudo systemctl status overseerr

# View logs
sudo journalctl -u overseerr -f

# Monitor resource usage
top -p $(pgrep overseerr)

bash

#!/bin/bash
# Basic backup script
BACKUP_DIR="/backup/overseerr"
DATE=$(date +%Y%m%d_%H%M%S)

mkdir -p "$BACKUP_DIR"
tar -czf "$BACKUP_DIR/overseerr-backup-$DATE.tar.gz" /etc/overseerr /var/lib/overseerr

echo "Backup completed: $BACKUP_DIR/overseerr-backup-$DATE.tar.gz"

bash

# Stop service
sudo systemctl stop overseerr

# Restore from backup
tar -xzf /backup/overseerr/overseerr-backup-*.tar.gz -C /

# Start service
sudo systemctl start overseerr

1. Service won't start:

bash

# Check logs
sudo journalctl -u overseerr -n 100
sudo tail -f /var/log/overseerr/overseerr.log

# Check configuration
overseerr --version

# Check permissions
ls -la /etc/overseerr

2. Connection issues:

bash

# Check if service is listening
sudo ss -tlnp | grep 5055

# Test connectivity
telnet localhost 5055

# Check firewall
sudo firewall-cmd --list-all

3. Performance issues:

bash

# Check resource usage
top -p $(pgrep overseerr)

# Check disk I/O
iotop -p $(pgrep overseerr)

# Check connections
ss -an | grep 5055

yaml

version: '3.8'
services:
  overseerr:
    image: overseerr:latest
    ports:
      - "5055:5055"
    volumes:
      - ./config:/etc/overseerr
      - ./data:/var/lib/overseerr
    restart: unless-stopped

Maintenance

bash

# RHEL/CentOS/Rocky/AlmaLinux
sudo dnf update overseerr

# Debian/Ubuntu
sudo apt update && sudo apt upgrade overseerr

# Arch Linux
sudo pacman -Syu overseerr

# Alpine Linux
apk update && apk upgrade overseerr

# openSUSE
sudo zypper update overseerr

# FreeBSD
pkg update && pkg upgrade overseerr

# Always backup before updates
tar -czf /backup/overseerr-pre-update-$(date +%Y%m%d).tar.gz /etc/overseerr

# Restart after updates
sudo systemctl restart overseerr

Regular Maintenance

bash

# Log rotation
sudo logrotate -f /etc/logrotate.d/overseerr

# Clean old logs
find /var/log/overseerr -name "*.log" -mtime +30 -delete

# Check disk usage
du -sh /var/lib/overseerr

Official Documentation: https://docs.overseerr.org/

GitHub Repository: https://github.com/overseerr/overseerr

Community Forum: https://forum.overseerr.org/

Best Practices Guide: https://docs.overseerr.org/best-practices

---

Note: This guide is part of the HowToMgr collection. Always refer to official documentation for the most up-to-date information.

1. Prerequisites

2. Supported Operating Systems

3. Installation

RHEL/CentOS/Rocky Linux/AlmaLinux

Debian/Ubuntu

Arch Linux

Alpine Linux

openSUSE/SLES

macOS

FreeBSD

Windows

Initial Configuration

Basic Configuration

5. Service Management

systemd (RHEL, Debian, Ubuntu, Arch, openSUSE)

OpenRC (Alpine Linux)

rc.d (FreeBSD)

launchd (macOS)

Windows Service Manager

Advanced Configuration

Reverse Proxy Setup

nginx Configuration

Apache Configuration

HAProxy Configuration

Security Configuration

Basic Security Setup

Database Setup

Performance Optimization

System Tuning

Monitoring

Basic Monitoring

9. Backup and Restore

Backup Script

Restore Procedure

6. Troubleshooting

Common Issues

Integration Examples

Docker Compose Example

Maintenance

Update Procedures

Regular Maintenance

Additional Resources

Related Miscellaneous Guides

ackee Installation Guide

Appwrite Installation Guide

arangodb Installation Guide