Portainer Templates logo

Portainer Templates

Your_spotify (stack)

MusicMonitoring

YourSpotify is a self-hosted application that tracks what you listen and offers you a dashboard to explore statistics about it!

Configuration

Type
Compose
Platform
linux
Source

Template by xneo1·Source

Services

server

Configuration

Image
yooooomi/your_spotify_server
Ports
8884:8080
Env vars
API_ENDPOINT=http://localhost:8884CLIENT_ENDPOINT=http://localhost:3084SPOTIFY_PUBLIC=__your_spotify_client_id__SPOTIFY_SECRET=__your_spotify_secret__CORS=http://localhost:3084,http://localhost:3085
Restart
always

Image details

Pulls: 2.7M
User: yooooomi
Created: Feb 10, 2020
Updated: 11 days ago
Status: active

mongo

Configuration

Image
mongo:4.4.8
Volumes
/data/db : /portainer/Files/AppData/Config/your_spotify/db

Image details

Pulls: 4.8B
User: stackbrew
Created: Jun 06, 2014
Updated: 4 days ago
Status: active

web

Configuration

Image
yooooomi/your_spotify_client
Ports
3084:3000
Env vars
API_ENDPOINT=http://localhost:8884
Restart
always

Image details

Pulls: 2.7M
User: yooooomi
Created: Feb 10, 2020
Updated: 11 days ago
Status: active

Installation

  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 the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

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

Service #1 - server

docker run -d --name server \
  -p 8884:8080 \
  -e 'API_ENDPOINT=http://localhost:8884' \
  -e 'CLIENT_ENDPOINT=http://localhost:3084' \
  -e 'SPOTIFY_PUBLIC=__your_spotify_client_id__' \
  -e 'SPOTIFY_SECRET=__your_spotify_secret__' \
  -e 'CORS=http://localhost:3084,http://localhost:3085' \
  --restart=always \
  yooooomi/your_spotify_server

Service #2 - mongo

docker run -d --name mongo \
  -v /portainer/Files/AppData/Config/your_spotify/db:/data/db \
  mongo:4.4.8

Service #3 - web

docker run -d --name web \
  -p 3084:3000 \
  -e 'API_ENDPOINT=http://localhost:8884' \
  --restart=always \
  yooooomi/your_spotify_client

If the stack expects env vars, set them or add them to a .env file first.

services:
  server:
    image: yooooomi/your_spotify_server
    restart: always
    ports:
      - "8884:8080"
    links:
      - mongo
    depends_on:
      - mongo
    environment:
      - API_ENDPOINT=http://localhost:8884 # This MUST be included as a valid URL in the spotify dashboard (see below)
      - CLIENT_ENDPOINT=http://localhost:3084
      - SPOTIFY_PUBLIC=__your_spotify_client_id__
      - SPOTIFY_SECRET=__your_spotify_secret__
      - CORS=http://localhost:3084,http://localhost:3085 # all if you want to allow every origin
  mongo:
    container_name: mongo
    image: mongo:4.4.8
    volumes:
      - /portainer/Files/AppData/Config/your_spotify/db:/data/db

  web:
    image: yooooomi/your_spotify_client
    restart: always
    ports:
      - "3084:3000"
    environment:
      - API_ENDPOINT=http://localhost:8884

Or, use the original compose file, straight from the template repo. Deploy with:

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

For more installation options, see the Documentation in our GitHub repo

Container Documentation

server Documentation

Self hosted Spotify tracking dashboard

mongo Documentation

MongoDB document databases provide high availability and easy scalability.

web Documentation

Self hosted Spotify tracking dashboard

Serve Your_spotify (stack) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying your-spotify-stack.example.com to http://server:8080

Add this to your Caddyfile

your-spotify-stack.example.com {
	reverse_proxy http://server:8080
}

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.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8884 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8884
  • Stop the other service, or pick a different host port. In 8884:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8884. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, your_spotify can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8884

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/your_spotify/db

Image won't pull

Test the pull directly on the host: docker pull yooooomi/your_spotify_server

  • "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 always 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.

Similar apps