### Install Overseerr via Swizzin

Source: https://docs.overseerr.dev/getting-started/installation

Installs Overseerr using the Swizzin package manager. This command assumes Swizzin is already installed and configured on the system. This is a third-party installation method.

```bash
box install overseerr
```

--------------------------------

### Run Overseerr Docker Container

Source: https://docs.overseerr.dev/getting-started/installation

Starts an Overseerr Docker container in detached mode. It configures logging, timezone, port mapping, and volume mounting for persistent data. Assumes Docker is installed and running. Requires a named volume like 'overseerr-data' to be pre-created.

```bash
docker run -d --name overseerr -e LOG_LEVEL=debug -e TZ=Asia/Tokyo -p 5055:5055 -v "overseerr-data:/app/config" --restart unless-stopped sctx/overseerr:latest
```

--------------------------------

### Install Overseerr via Portage (Gentoo)

Source: https://docs.overseerr.dev/getting-started/installation

Installs the Overseerr package from the enabled Overseerr Portage overlay using the emerge command. This assumes the overlay has already been enabled. Requires root privileges.

```bash
emerge www-apps/overseerr
```

--------------------------------

### Install Overseerr Development Build via Portage (Gentoo)

Source: https://docs.overseerr.dev/getting-started/installation

Installs the latest development version of Overseerr (version 9999) from the Overseerr Portage overlay. This requires modifying package accept keywords and may lead to instability. Requires root privileges.

```bash
emerge --autounmask --autounmask-write "=www-apps/overseerr-9999"
```

--------------------------------

### Install Overseerr via Snap Package (Linux)

Source: https://docs.overseerr.dev/getting-started/installation

Installs the Overseerr application using the snap package manager on Linux systems. This is the officially supported method for Linux installations outside of Docker. Requires snapd to be installed.

```bash
sudo snap install overseerr
```

--------------------------------

### Upgrade Overseerr via Swizzin

Source: https://docs.overseerr.dev/getting-started/installation

Upgrades the Overseerr application installed via the Swizzin package manager. This command assumes Overseerr is already installed with Swizzin. This is a third-party installation method.

```bash
box upgrade overseerr
```

--------------------------------

### Install Overseerr with Docker CLI

Source: https://docs.overseerr.dev/getting-started/installation

This snippet demonstrates how to run the Overseerr container using the Docker command-line interface. It includes essential environment variables for logging level, time zone, and port, along with volume mapping for configuration persistence and a restart policy. Remember to replace `/path/to/appdata/config` with your actual host directory.

```bash
docker run -d \
  --name overseerr \
  -e LOG_LEVEL=debug \
  -e TZ=Asia/Tokyo \
  -e PORT=5055 `#optional` \
  -p 5055:5055 \
  -v /path/to/appdata/config:/app/config \
  --restart unless-stopped \
  sctx/overseerr
```

--------------------------------

### Example Plex GUID Formats for Media Matching

Source: https://docs.overseerr.dev/support/faq

This snippet illustrates the expected GUID formats for media items in Plex, which Overseerr uses to match and identify content. Verifying these formats is crucial for troubleshooting missing media.

```text
TMDB agent: guid="com.plexapp.agents.themoviedb://1705"
New Plex Movie agent: <Guid id="tmdb://464052"/>
TheTVDB agent: guid="com.plexapp.agents.thetvdb://78874/1/1"
Legacy Plex Movie agent: guid="com.plexapp.agents.imdb://tt0765446"
```

--------------------------------

### Enable Overseerr Portage Overlay (Gentoo)

Source: https://docs.overseerr.dev/getting-started/installation

Enables the Overseerr overlay for the Gentoo package manager (Portage), allowing Overseerr to be installed via emerge. This involves adding the overlay to the system's repository list. Requires root privileges.

```bash
eselect repository enable overseerr-overlay
```

--------------------------------

### Create Docker Volume for Overseerr Data

Source: https://docs.overseerr.dev/getting-started/installation

Creates a named Docker volume to store Overseerr's configuration data. This is essential for persisting data when using Docker. Ensure Docker CLI is installed and configured.

```bash
docker volume create overseerr-data
```

--------------------------------

### Update Live Rebuild Packages (Gentoo)

Source: https://docs.overseerr.dev/getting-started/installation

Updates all packages marked as live or development versions (e.g., version 9999) in the Gentoo Portage system. This is used to update the development build of Overseerr if installed. Requires root privileges.

```bash
emerge @live-rebuild
```

--------------------------------

### Update Overseerr with Docker CLI

Source: https://docs.overseerr.dev/getting-started/installation

These commands show how to update an existing Overseerr Docker container. It involves stopping and removing the current container, pulling the latest image from Docker Hub, and then re-running the container with the same parameters used during the initial installation.

```bash
docker stop overseerr && docker rm overseerr
docker pull sctx/overseerr
docker run -d ...
```

--------------------------------

### Install Overseerr with Docker Compose

Source: https://docs.overseerr.dev/getting-started/installation

This YAML configuration defines the Overseerr service for Docker Compose. It specifies the Docker image, container name, environment variables (log level, time zone, port), port mapping, volume for configuration persistence, and restart policy. This method simplifies managing multiple Docker services.

```yaml
---
version: '3' 

services:
  overseerr:
    image: sctx/overseerr:latest
    container_name: overseerr
    environment:
      - LOG_LEVEL=debug
      - TZ=Asia/Tokyo
      - PORT=5055 #optional
    ports:
      - 5055:5055
    volumes:
      - /path/to/appdata/config:/app/config
    restart: unless-stopped

```

--------------------------------

### Refresh Overseerr Snap Package (Linux)

Source: https://docs.overseerr.dev/getting-started/installation

Forces an update check and application of the latest version for the Overseerr snap package. Snap typically handles updates automatically, but this command allows for manual refresh. Requires Overseerr to be installed via snap.

```bash
sudo snap refresh
```

--------------------------------

### Update Overseerr with Docker Compose

Source: https://docs.overseerr.dev/getting-started/installation

These Docker Compose commands update the Overseerr service. First, `docker-compose pull overseerr` fetches the latest image, and then `docker-compose up -d` recreates the container with the updated image, ensuring the service is running with the latest version.

```bash
docker-compose pull overseerr
docker-compose up -d
```

--------------------------------

### Configure Radarr/Sonarr Server Connection in Overseerr

Source: https://docs.overseerr.dev/using-overseerr/settings

This section outlines the settings required to connect Overseerr to your Radarr or Sonarr instances. It details how to specify server details such as hostname/IP, port, SSL usage, and the API key. Proper configuration allows Overseerr to check media availability and request status from your media management servers. Only v3 Radarr/Sonarr servers are supported.

```text
Server Name: [Friendly name for the server]
Hostname or IP Address: [e.g., radarr.myawesomeserver.com or local IP]
Port: [e.g., 7878 for Radarr, 8989 for Sonarr]
Use SSL: [true/false]
API Key: [Radarr/Sonarr API key from Settings -> General -> Security]
```

--------------------------------

### Nginx Subdomain Reverse Proxy Configuration

Source: https://docs.overseerr.dev/extending-overseerr/reverse-proxy

This Nginx configuration sets up a reverse proxy for Overseerr using a subdomain. It listens on port 443 with SSL and HTTP/2, sets the server name, includes SSL configuration, and directs traffic to the Overseerr application on port 5055. It's suitable for direct subdomain setups.

```nginx
server {
    listen 443 ssl http2;
    listen [::]:443 ssl http2;

    server_name overseerr.*;

    include /config/nginx/ssl.conf;

    client_max_body_size 0;

    location / {
        include /config/nginx/proxy.conf;
        resolver 127.0.0.11 valid=30s;
        set $upstream_app overseerr;
        set $upstream_port 5055;
        set $upstream_proto http;
        proxy_pass $upstream_proto://$upstream_app:$upstream_port;
    }

}
```

--------------------------------

### Configure Plex Server Connection in Overseerr

Source: https://docs.overseerr.dev/using-overseerr/settings

This section describes how to configure the connection details for your Plex Media Server within Overseerr. It covers specifying the hostname or IP address, port, SSL usage, and the optional Web App URL. Correct configuration is crucial for Overseerr to interact with your Plex server for features like 'Play on Plex' links and status updates.

```text
Hostname or IP Address: [e.g., plex.myawesomeserver.com or local IP]
Port: [e.g., 32400, 443]
Use SSL: [true/false]
Web App URL (optional): [e.g., https://plex.myawesomeserver.com/web]
```

--------------------------------

### Bash Command to Enable Nginx Site

Source: https://docs.overseerr.dev/extending-overseerr/reverse-proxy

This bash command creates a symbolic link to enable an Nginx site configuration. It links the configuration file from `/etc/nginx/sites-available/` to `/etc/nginx/sites-enabled/`, making the site active for Nginx to serve.

```bash
sudo ln -s /etc/nginx/sites-available/overseerr.example.com.conf /etc/nginx/sites-enabled/overseerr.example.com.conf
```

--------------------------------

### Nginx Subdomain Reverse Proxy with SSL and Redirect

Source: https://docs.overseerr.dev/extending-overseerr/reverse-proxy

This Nginx configuration handles both HTTP to HTTPS redirection and SSL/HTTP/2 proxying for Overseerr with a specific subdomain. It includes detailed proxy headers for proper request forwarding and is designed for direct server configurations.

```nginx
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/letsencrypt/live/overseerr.example.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/overseerr.example.com/privkey.pem;

    proxy_set_header Referer $http_referer;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Real-Port $remote_port;
    proxy_set_header X-Forwarded-Host $host:$remote_port;
    proxy_set_header X-Forwarded-Server $host;
    proxy_set_header X-Forwarded-Port $remote_port;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Forwarded-Ssl on;

    location / {
        proxy_pass http://127.0.0.1:5055;
    }
}
```

--------------------------------

### Configure Traefik v2 for Overseerr

Source: https://docs.overseerr.dev/extending-overseerr/reverse-proxy

These Docker Compose labels configure Traefik v2 to route incoming HTTP requests for a specific host to the Overseerr service. It enables TLS for secure connections and specifies the internal port Overseerr listens on.

```yaml
labels:
  - "traefik.enable=true"
  ## HTTP Routers
  - "traefik.http.routers.overseerr-rtr.entrypoints=https"
  - "traefik.http.routers.overseerr-rtr.rule=Host(`overseerr.domain.com`)"
  - "traefik.http.routers.overseerr-rtr.tls=true"
  ## HTTP Services
  - "traefik.http.routers.overseerr-rtr.service=overseerr-svc"
  - "traefik.http.services.overseerr-svc.loadbalancer.server.port=5055"
```

--------------------------------

### Nginx Subfolder Reverse Proxy Workaround Configuration

Source: https://docs.overseerr.dev/extending-overseerr/reverse-proxy

This Nginx configuration provides an unsupported workaround for accessing Overseerr via a subfolder URL. It rewrites the URL to remove the subfolder prefix, sets necessary proxy headers, and uses sub_filter directives to correct hardcoded paths within the application's responses. Use with caution as it may break with Overseerr updates.

```nginx
location ^~ /overseerr {
    set $app 'overseerr';

    # Remove /overseerr path to pass to the app
    rewrite ^/overseerr/?(.*)$ /$1 break;
    proxy_pass http://127.0.0.1:5055; # NO TRAILING SLASH

    # Redirect location headers
    proxy_redirect ^ /$app;
    proxy_redirect /setup /$app/setup;
    proxy_redirect /login /$app/login;

    # Sub filters to replace hardcoded paths
    proxy_set_header Accept-Encoding "";
    sub_filter_once off;
    sub_filter_types *;
    sub_filter 'href="/"' 'href="/$app"';
    sub_filter 'href="/login"' 'href="/$app/login"';
    sub_filter 'href:"/"' 'href="/$app"';
    sub_filter '\/_next' '\/$app\/_next';
    sub_filter '/_next' '/$app/_next';
    sub_filter '/api/v1' '/$app/api/v1';
    sub_filter '/login/plex/loading' '/$app/login/plex/loading';
    sub_filter '/images/' '/$app/images/';
    sub_filter '/android-' '/$app/android-';
    sub_filter '/apple-' '/$app/apple-';
    sub_filter '/favicon' '/$app/favicon';
    sub_filter '/logo_' '/$app/logo_';
    sub_filter '/site.webmanifest' '/$app/site.webmanifest';
}
```

--------------------------------

### Overseerr Fail2ban Filter Definition

Source: https://docs.overseerr.dev/extending-overseerr/fail2ban

This filter defines the regular expression used by Fail2ban to identify failed sign-in attempts in Overseerr logs. It captures the IP address of the failed attempt. Ensure Fail2ban is correctly configured to read this filter.

```fail2ban
[Definition]
failregex = .*\[warn\]\[API\]: Failed sign-in attempt.*"ip":"<HOST>"
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.