Skip to content
AurralAurral

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

Section titled “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 so every media service sees the same paths.

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

Section titled “Start Aurral”
Terminal window
docker compose up -d
  1. Open http://localhost:3001.
  2. Create the admin account.
  3. Connect Lidarr.
  4. Set the Downloads Folder path and run the storage checks.

Continue with First run.

Which image tag to use

Section titled “Which image tag to use”
Tag Contents Use it when
latest The newest stable release You want a tested release.
2.4.0, 2.4, 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. When one exists, an update icon appears in the top-right area. Select it to preview the release changes and open the GitHub release or commit list.

Non-stable channels also mark the sidebar.

For the current Nightly scope, see the Release Readiness issues. The latest issue is pinned at the top and lists the current Nightly candidate and included changes.

Test a pull request preview

Section titled “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.

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

Full stack example

Section titled “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