Portainer Templates logo

Portainer Templates

AudioMuse-AI AudioMuse-AI

Stack

MusicMediaAI

Automatic playlist generation for self-hosted music servers. Analyses your library locally to group tracks by how they sound. Works with Navidrome, Jellyfin, LMS, Lyrion, Emby and Plex. GitHub: NeptuneHub/AudioMuse-AI

Source details

Stars: 2k
Forks: 140
Language: Python
License: AGPL-3.0
Updated: 2 days ago

Configuration

Type
Compose
Platform
linux
Env vars
AUDIOMUSE_TAG=latestFRONTEND_PORT=8000TZ=UTCPOSTGRES_USER=audiomusePOSTGRES_PASSWORD=audiomusepassword
Restart
unless-stopped
Source

Source

Notes

Deploys the web app, an analysis worker, PostgreSQL 15 and Redis. Open http://<host>:8000 and complete the Setup Wizard to connect your music server(s) - since v1.0.0 everything except the database, Redis and timezone is configured in the browser and stored in the database. Then run Analysis and Clustering → Start Analysis to scan your library before using the other features; a first analysis is CPU-heavy and can take hours on a large library. API docs are at /apidocs/. Needs 4+ CPU cores, 8GB RAM and SSD storage. PostgreSQL and Redis are internal to the stack and are not published on the host. For NVIDIA GPU acceleration, use the AudioMuse-AI (NVIDIA GPU) template instead.

Services

audiomuse-ai-flask

Configuration

Image
ghcr.io/neptunehub/audiomuse-ai:${AUDIOMUSE_TAG:-latest}
Ports
${FRONTEND_PORT:-8000}:8000
Volumes
/app/temp_audio : temp-audio-flask/app/plugin/installed : plugins-flask
Env vars
SERVICE_TYPE=flaskTZ=${TZ:-UTC}POSTGRES_HOST=postgresPOSTGRES_PORT=5432POSTGRES_USER=${POSTGRES_USER:-audiomuse}POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-audiomusepassword}POSTGRES_DB=audiomusedbREDIS_URL=redis://redis:6379/0TEMP_DIR=/app/temp_audio
Restart
unless-stopped

audiomuse-ai-worker

Configuration

Image
ghcr.io/neptunehub/audiomuse-ai:${AUDIOMUSE_TAG:-latest}
Volumes
/app/temp_audio : temp-audio-worker/app/plugin/installed : plugins-worker
Env vars
SERVICE_TYPE=workerTZ=${TZ:-UTC}POSTGRES_HOST=postgresPOSTGRES_PORT=5432POSTGRES_USER=${POSTGRES_USER:-audiomuse}POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-audiomusepassword}POSTGRES_DB=audiomusedbREDIS_URL=redis://redis:6379/0TEMP_DIR=/app/temp_audio
Restart
unless-stopped

postgres

Configuration

Image
postgres:15-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
TZ=${TZ:-UTC}POSTGRES_USER=${POSTGRES_USER:-audiomuse}POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-audiomusepassword}POSTGRES_DB=audiomusedb
Restart
unless-stopped

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 day ago
Status: active

redis

Configuration

Image
redis:7-alpine
Volumes
/data : redis-data
Env vars
TZ=${TZ:-UTC}
Restart
unless-stopped

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 day ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying AudioMuse-AI

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 AudioMuse-AI, 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:

# AudioMuse-AI - sonic analysis + automatic playlist generation for self-hosted music servers
# Mirrors https://github.com/NeptuneHub/AudioMuse-AI/blob/main/deployment/docker-compose.yaml
# The flask + worker containers share one image; SERVICE_TYPE decides which role each runs.
# Music servers are connected from the browser Setup Wizard on first run, not via env vars.

services:
  audiomuse-ai-flask:
    image: ghcr.io/neptunehub/audiomuse-ai:${AUDIOMUSE_TAG:-latest}
    restart: unless-stopped
    ports:
      - "${FRONTEND_PORT:-8000}:8000"
    environment:
      SERVICE_TYPE: flask
      TZ: ${TZ:-UTC}
      POSTGRES_HOST: postgres
      POSTGRES_PORT: "5432"
      POSTGRES_USER: ${POSTGRES_USER:-audiomuse}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-audiomusepassword}
      POSTGRES_DB: audiomusedb
      REDIS_URL: redis://redis:6379/0
      TEMP_DIR: /app/temp_audio
    volumes:
      - temp-audio-flask:/app/temp_audio
      # Plugins are installed to disk (code + pip deps), so each container keeps its own copy
      - plugins-flask:/app/plugin/installed
    depends_on:
      postgres:
        condition: service_healthy
      redis:
        condition: service_healthy

  audiomuse-ai-worker:
    image: ghcr.io/neptunehub/audiomuse-ai:${AUDIOMUSE_TAG:-latest}
    restart: unless-stopped
    environment:
      SERVICE_TYPE: worker
      TZ: ${TZ:-UTC}
      POSTGRES_HOST: postgres
      POSTGRES_PORT: "5432"
      POSTGRES_USER: ${POSTGRES_USER:-audiomuse}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-audiomusepassword}
      POSTGRES_DB: audiomusedb
      REDIS_URL: redis://redis:6379/0
      TEMP_DIR: /app/temp_audio
    volumes:
      - temp-audio-worker:/app/temp_audio
      - plugins-worker:/app/plugin/installed
    depends_on:
      postgres:
        condition: service_healthy
      redis:
        condition: service_healthy

  # AudioMuse-AI is built against PostgreSQL 15 - other majors are known to error
  postgres:
    image: postgres:15-alpine
    restart: unless-stopped
    environment:
      TZ: ${TZ:-UTC}
      POSTGRES_USER: ${POSTGRES_USER:-audiomuse}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-audiomusepassword}
      POSTGRES_DB: audiomusedb
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER:-audiomuse} -d audiomusedb"]
      interval: 10s
      timeout: 5s
      retries: 6

  # Task queue for the analysis/clustering jobs
  redis:
    image: redis:7-alpine
    restart: unless-stopped
    environment:
      TZ: ${TZ:-UTC}
    volumes:
      - redis-data:/data
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 10s
      timeout: 5s
      retries: 6

volumes:
  postgres-data:
  redis-data:
  temp-audio-flask:
  temp-audio-worker:
  plugins-flask:
  plugins-worker:

Or deploy it directly from the source:

git clone https://github.com/lissy93/portainer-templates
cd portainer-templates
docker compose -f sources/stacks/audiomuse-ai.yml up -d

More install options in our documentation, or see NeptuneHub/AudioMuse-AI for app-specific guidance.

Container Documentation

postgres Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

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.

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/neptunehub/audiomuse-ai:${AUDIOMUSE_TAG:-latest}

  • "manifest unknown" means the tag no longer exists.
  • "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

AudioMuse-AI is a Compose stack, a set of containers (4 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 4 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • audiomuse-ai-flask runs ghcr.io/neptunehub/audiomuse-ai:latest, starts after postgres, redis
  • audiomuse-ai-worker runs ghcr.io/neptunehub/audiomuse-ai:latest, starts after postgres, redis
  • postgres runs postgres:15-alpine
  • redis runs redis:7-alpine

Volumes

A volume is where AudioMuse-AI 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/temp_audio kept in the temp-audio-flask volume Docker manages
  • /app/plugin/installed kept in the plugins-flask volume Docker manages
  • /app/temp_audio kept in the temp-audio-worker volume Docker manages
  • /app/plugin/installed kept in the plugins-worker volume Docker manages
  • /var/lib/postgresql/data kept in the postgres-data volume Docker manages
  • /data kept in the redis-data volume Docker manages

Environment variables

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

  • SERVICE_TYPE, defaults to worker
  • TZ, defaults to UTC
  • POSTGRES_HOST, defaults to postgres
  • POSTGRES_PORT, defaults to 5432
  • POSTGRES_USER, defaults to audiomuse
  • POSTGRES_PASSWORD, defaults to audiomusepassword
  • POSTGRES_DB, defaults to audiomusedb
  • REDIS_URL, defaults to redis://redis:6379/0
  • TEMP_DIR, defaults to /app/temp_audio

Restart policy

The restart policy here is unless-stopped, so Docker restarts AudioMuse-AI 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 audiomuse-ai-flask) 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.

Open source license

AudioMuse-AI is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

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