Portainer Templates logo

Portainer Templates

Aurral Aurral

Stack

Media

Streamlined Artist Request Manager for Lidarr. Search for artists using the MusicBrainz database and seamlessly add them to your Lidarr music library. Features personalized recommendations, genre analysis, and one-click requests.

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

aurral-backend

Configuration

Image
ghcr.io/lklynet/aurral-backend:latest
Ports
${BACKEND_PORT:-3001}:3001
Volumes
/app/data : /portainer/Files/AppData/Config/aurral/backend-data
Env vars
PORT=3001LIDARR_URL=${LIDARR_URL:-http://lidarr:8686}LIDARR_API_KEY=${LIDARR_API_KEY}LASTFM_API_KEY=${LASTFM_API_KEY}CONTACT_EMAIL=${CONTACT_EMAIL:-user@example.com}DEBUG=${DEBUG:-false}AUTH_PASSWORD=${AUTH_PASSWORD}
Restart
unless-stopped

aurral-frontend

Configuration

Image
ghcr.io/lklynet/aurral-frontend:latest
Ports
${FRONTEND_PORT:-3000}:80
Env vars
NODE_ENV=production
Restart
unless-stopped

Standalone Install

Select an install method, to see config/commands for deploying Aurral

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Aurral, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

version: '3.8'

services:
  aurral-backend:
    image: ghcr.io/lklynet/aurral-backend:latest
    container_name: aurral-backend
    restart: unless-stopped
    ports:
      - ${BACKEND_PORT:-3001}:3001
    environment:
      - PORT=3001
      - LIDARR_URL=${LIDARR_URL:-http://lidarr:8686}
      - LIDARR_API_KEY=${LIDARR_API_KEY}
      - LASTFM_API_KEY=${LASTFM_API_KEY}
      - CONTACT_EMAIL=${CONTACT_EMAIL:-user@example.com}
      - DEBUG=${DEBUG:-false}
      - AUTH_PASSWORD=${AUTH_PASSWORD}
    volumes:
      - /portainer/Files/AppData/Config/aurral/backend-data:/app/data
    security_opt:
      - no-new-privileges:true
    cap_drop:
      - ALL
    cap_add:
      - SETUID
      - SETGID
      - CHOWN
    networks:
      - aurral-network

  aurral-frontend:
    image: ghcr.io/lklynet/aurral-frontend:latest
    container_name: aurral-frontend
    restart: unless-stopped
    ports:
      - ${FRONTEND_PORT:-3000}:80
    environment:
      - NODE_ENV=production
    depends_on:
      - aurral-backend
    security_opt:
      - no-new-privileges:true
    cap_drop:
      - ALL
    cap_add:
      - CHOWN
      - SETUID
      - SETGID
      - NET_BIND_SERVICE
    networks:
      - aurral-network

networks:
  aurral-network:
    driver: bridge

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/aurral.yml up -d

More install options in our documentation.

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/aurral/backend-data

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/lklynet/aurral-backend:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Aurral is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • aurral-backend runs ghcr.io/lklynet/aurral-backend:latest
  • aurral-frontend runs ghcr.io/lklynet/aurral-frontend:latest, starts after aurral-backend

Volumes

A volume is where Aurral keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /app/data from /portainer/Files/AppData/Config/aurral/backend-data on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Aurral takes 8 of them, all with defaults you can leave alone or tweak:

  • PORT, defaults to 3001
  • LIDARR_URL, defaults to http://lidarr:8686
  • LIDARR_API_KEY, pulled from your own environment
  • LASTFM_API_KEY, pulled from your own environment
  • CONTACT_EMAIL, defaults to user@example.com
  • DEBUG, defaults to false
  • AUTH_PASSWORD, pulled from your own environment
  • NODE_ENV, defaults to production

Restart policy

The restart policy here is unless-stopped, so Docker restarts Aurral after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like aurral-backend) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Aurral up. Add the template list to Portainer once, then deploying Aurral is a click rather than a wall of config.