Docker setup

Aurral runs in Docker. It needs two mounts:

/config for Aurral’s database, settings, users, and jobs.
A shared media mount for the Lidarr library, completed downloads, and Aurral output.

Read Filesystem and mounts before you create the Compose file. Aurral must share a media mount with Lidarr, your download clients, and Navidrome or Plex.

Minimal Compose file

services:
  aurral:
    image: ghcr.io/lklynet/aurral:latest
    restart: unless-stopped
    ports:
      - "3001:3001"
    environment:
      - PUID=${PUID:-1000}
      - PGID=${PGID:-1000}
    volumes:
      - ${MEDIA_ROOT:-/srv/media}:/data
      - ./config:/config

Replace /srv/media with the host directory that Lidarr already uses. Keep :/data as the container side of the mount if the other services use the recommended layout.

For example, the host folder /srv/media/downloads/aurral is /data/downloads/aurral inside Aurral. Set the Downloads Folder to the container path in Settings > Download Clients, not to the host path.

/config is only for Aurral. Do not share it with another service.

Start Aurral

docker compose up -d

Open http://localhost:3001.
Create the admin account.
Connect Lidarr.
Set the Downloads Folder path and run the storage checks.

Continue with First run.

Which image tag to use

Tag	Contents	Use it when
`latest`	The newest stable release	You want a tested release.
`2.1.0`, `2.1`, `2`	An exact version, or the newest release in that line	You pin versions or need to roll back.
`nightly`	Every change merged since the last release	You want fixes and features early and can report bugs.
`pr-<number>`	The preview image for an open pull request	You were asked to test a proposed change.

Aurral checks for a newer build in your channel and shows a banner when one exists. Non-stable channels also mark the sidebar.

Test a pull request preview

When a pull request has a preview image, its GitHub conversation contains the exact pr-<number> image tag and test instructions.

Back up ./config.
Temporarily change the Aurral image to the preview tag.
Run docker compose pull aurral && docker compose up -d aurral.
Test the behavior changed by the pull request.
Restore the image reference that you used before testing.

Full stack example

Use docker-compose.example.yml for Aurral, Lidarr, slskd, and Navidrome. It uses one ${MEDIA_ROOT:-/srv/media}:/data mount for the media services.

For Plex, see the Plex setup guide.

Next: Filesystem and mounts