Self-host Sortarr

Deploy Sortarr using Docker Compose for the easiest setup.

• Prepare docker-compose.yaml: Clone the repository or download the docker-compose.yaml file.
• Start the container:

docker compose up -d

Image Sources:

• Default (GHCR): ghcr.io/jaredharper1/sortarr:latest (Recommended for release builds).
• Docker Hub: docker.io/jaredharper1/sortarr:latest.
• Architectures: Supported for linux/amd64 and linux/arm64/v8 (Apple Silicon compatible).
• URL: Open http://:9595 in your browser.
• Initialization: The first visit automatically redirects to /setup, where you can configure your media and history providers and choose who handles login: Basic, Basic (local bypass), or External.

For developers or users who prefer running directly from the source code.

• Prerequisites: Python 3.10+, pip (Python package installer)
• Install Dependencies:

pip install -r requirements.txt

• Run Application:

python app.py

• Access: Open http://localhost:8787 in your browser.
• Local Configuration: Set variables like PORT (default 8787) or HOST (default 0.0.0.0) in your shell before running. On first launch, Sortarr creates a .env file in the project root. Use SORTARR_CONFIG_PATH to point to a specific file. Production Server: By default, Sortarr uses waitress to serve the application. Set SORTARR_USE_WAITRESS=0 only for local development/debugging with the Flask built-in server.

An Unraid template is provided at docs/unraid-template.xml to simplify deployment.

• Copy Template: Place the template file into Unraid's user templates directory:
  • Source: docs/unraid-template.xml
  • Destination: /boot/config/plugins/dockerMan/templates-user/sortarr.xml
• Add Container: In the Unraid WebUI, go to Docker → Add Container.
• Select Template: Choose sortarr from the Template dropdown.
• Configure Fields:
  • WebUI Port: Default is 9595 (maps to internal 8787).
  • Appdata Path: Recommended /mnt/user/appdata/sortarr (mapped to /config).
  • Advanced Settings (Optional): PUID/PGID, ENV_FILE_PATH, SORTARR_PROXY_MODE, SORTARR_WAITRESS_TRUSTED_PROXY, SORTARR_PROXY_HOPS_PREFIX, Session secret key.
• Apply: Start the container and open the WebUI.

Sortarr can be run as a standalone Windows executable. This is ideal for users who prefer not to use Docker.

• Download: Obtain the Sortarr.exe (PyInstaller --onefile build).
• Run: Double-click the EXE to start the application. A terminal window will open, and the web server will start on the default port (8787).
• Setup: Open http://localhost:8787 in your browser.
• Configuration Persistence: On the first launch, Sortarr creates a blank .env file in the same directory as the EXE. When you save settings on the /setup page, they are written to this .env file.
• Path Overrides: Set SORTARR_CONFIG_PATH or ENV_FILE_PATH before running the EXE to store configuration elsewhere.