Installation

Installation

All methods need the same three required settings — see Getting Started for how to obtain them and Configuration for the full variable reference.

Run with Python

Requires Python 3.12.

python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt
python -m vaultrequestrr

Run with Docker

Using the repo's compose file (builds locally):

docker compose up -d --build

The SQLite link store is persisted to ./data.

To run the pre-built published image instead of building locally:

docker run -d --name vaultrequestrr --restart unless-stopped \
  -e DISCORD_TOKEN=... \
  -e SEERR_URL=http://10.10.0.10:5055 \
  -e SEERR_API_KEY=... \
  -e DISCORD_GUILD_ID=... \
  -v /path/to/data:/data \
  ghcr.io/vancityactivist/vaultrequestrr:latest

Add -e WEB_PASSWORD=... and -p 5056:5056 to enable the Admin Dashboard.

Run on Unraid

The image is published to GHCR and there's a ready-made Unraid template at unraid/vaultrequestrr.xml.

1. Install the template into Unraid's user-templates folder. The Add Container Template field is a dropdown — you cannot paste a URL into it, so the XML has to live in /boot/config/plugins/dockerMan/templates-user/ first. From the Unraid web terminal:

   wget -O /boot/config/plugins/dockerMan/templates-user/my-vaultrequestrr.xml \
     https://raw.githubusercontent.com/vancityactivist/vaultrequestrr/main/unraid/vaultrequestrr.xml

   (Or copy unraid/vaultrequestrr.xml onto the flash share at config/plugins/dockerMan/templates-user/my-vaultrequestrr.xml.) The my- prefix and this folder are what make it appear in the dropdown.

2. On Unraid: Docker tab → Add Container → in the Template dropdown, under User templates, select VaultRequestrr.

3. Fill in the fields the template exposes — Discord Bot Token, Seerr URL, Seerr API Key, and optionally Discord Guild ID — set the Data Directory (defaults to /mnt/user/appdata/vaultrequestrr), then Apply.

Network footprint

The bot makes outbound connections to Discord and Seerr (plus any Radarr/Sonarr instances you add on the dashboard). The only inbound port is the optional admin dashboard (5056, default), which is served only when a dashboard password is set.