Skip to content

Installation

TheMRX13 edited this page Jun 12, 2026 · 2 revisions

Installation

🌐 English · Deutsch

Requirements

Component Requirement
Python ≥ 3.9
FFmpeg Must be installed and available in PATH
Operating system Windows, macOS, Linux (or Docker)

FFmpeg is mandatory — downloads will not work without it. On Windows the app downloads mpv.exe automatically when needed; FFmpeg can be installed e.g. via winget install Gyan.FFmpeg.

On first start the app also automatically downloads a Patchright Chromium browser. It is required for solving captchas (see Download System).

Install via pip (recommended)

# Latest stable release
pip install mrx-aniworld

# Update to the latest version
pip install --upgrade mrx-aniworld

Development version (models branch)

pip install --upgrade "mrx-aniworld @ git+https://github.com/TheMRX13/MRX-AniWorld-Downloader.git@models"

Dev installs show a version like 2.5.3-dev+abc1234 in the UI (base version + commit hash). The built-in update checker compares the commit hash against the latest commit on the models branch for dev installs, and the version number against the latest GitHub release for release installs.

Launching

# Default: WebUI on http://localhost:8080, browser opens automatically
aniworld

# Custom port
aniworld -wP 9090

# Listen on all interfaces (LAN, Docker, reverse proxy)
aniworld -wH 0.0.0.0

# Combined
aniworld -wH 0.0.0.0 -wP 9090

All launch flags

Flag Description
-wP / --web-port Web UI port (default: 8080)
-wH / --web-host Host/IP to bind (default: 127.0.0.1)
-wN / --no-browser Don't open the browser automatically on startup
-d / --debug Enable debug logging

That's all there is — every other setting is configured in the WebUI (Configuration).

Security note: If you bind to anything other than 127.0.0.1, the UI becomes reachable from the network. Authentication is enabled by default; still, never expose an instance unprotected to the internet (Authentication).

Docker

For container deployment see the dedicated Docker page.

Data directory

All configuration data, the SQLite database and helper files live under ~/.aniworld/:

File Purpose
aniworld.db SQLite database (settings, queue, users, …)
.flask_secret Secret key for sessions & settings encryption
aniworld.pid Instance lock (warns on double start)
vapid_keys.json Auto-generated Web Push keys
keyword_ids.json TMDB keyword export (only with advanced search enabled)

Next step

Getting Started: setup token, admin account and your first download.

Clone this wiki locally