Installation

aMuTorrent can be installed using Docker (recommended) or natively.

Prerequisites: At least one of: aMule with External Connections enabled, or rTorrent with XML-RPC over HTTP.

Docker Installation (Recommended)

Available on Docker Hub. Supports linux/amd64 and linux/arm64.

1. Pull the image

docker pull g0t3nks/amutorrent:latest

2. Create directories

mkdir -p data logs
sudo chown -R 1000:1000 data logs

3. Create docker-compose.yml

services:
  amutorrent:
    image: g0t3nks/amutorrent:latest
    user: "1000:1000"
    container_name: amutorrent
    ports:
      - "4000:4000"
    environment:
      - NODE_ENV=production
      - PORT=4000
    extra_hosts:
      - "host.docker.internal:host-gateway"
    volumes:
      - ./logs:/usr/src/app/server/logs
      - ./data:/usr/src/app/server/data
    restart: unless-stopped

4. Start and configure

docker compose up -d

Open http://localhost:4000 and follow the setup wizard to configure your download clients.

All-in-One Setup: For a complete setup with aMule and rTorrent in Docker, see docker-compose.all-in-one.yml.

Native Installation

Prerequisites

• Node.js 18 or later
• npm

Steps

1. Clone the repository:

git clone https://github.com/got3nks/amutorrent.git
cd amutorrent

2. Install dependencies and build:

cd server && npm install && cd ..
npm install && npm run build

3. Start the server:

node server/server.js

4. Open http://localhost:4000 and complete the setup wizard

First Run Setup

On first launch, aMuTorrent will display a setup wizard to configure:

• Download clients - Enable at least one: aMule, rTorrent, or both
• Web authentication (optional) - Protect the web interface with a password

Next Steps

After completing the setup wizard, explore additional features:

Configuration: Settings, environment variables, and Docker networking. See Configuration.

Download Clients: Detailed setup for aMule and rTorrent.

Prowlarr: Search torrents directly from the web UI. See Prowlarr Setup.

*arr Apps: Use aMuTorrent as an indexer and download client for Sonarr, Radarr, and other *arr apps. See *arr Integration.

Notifications: Get notified when downloads complete. See Notifications.

Scripting: Run custom scripts on download events. See Scripting.

GeoIP: Display peer locations on a map. See GeoIP Setup.