Your_spotify (stack)
YourSpotify is a self-hosted application that tracks what you listen and offers you a dashboard to explore statistics about it!
Services
server
Configuration
Imageyooooomi/your_spotify_server8884:8080API_ENDPOINT=http://localhost:8884CLIENT_ENDPOINT=http://localhost:3084SPOTIFY_PUBLIC=__your_spotify_client_id__SPOTIFY_SECRET=__your_spotify_secret__CORS=http://localhost:3084,http://localhost:3085alwaysImage details
mongo
Configuration
Imagemongo:4.4.8/data/db : /portainer/Files/AppData/Config/your_spotify/dbImage details
web
Configuration
Imageyooooomi/your_spotify_client3084:3000API_ENDPOINT=http://localhost:8884alwaysImage details
Standalone Install
Select an install method, to see config/commands for deploying Your_spotify (stack)
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Your_spotify (stack), fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
Original stackfile
The compose file this template deploys, straight from its repo:
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 deploy it directly from the source:
git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/your_spotify.yml up -dMore install options in our documentation.
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:
137means killed, usually out of memory.126or127means 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:8080only 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 loginto 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
noso 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.
- Bug within the app: Open an issue within your_spotify's repo
- Template not working: Open an issue on xneo1/portainer_templates
- This website not working: Open an issue on lissy93/portainer-templates
A Compose stack
Your_spotify (stack) is a Compose stack, a set of containers (3 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 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:
serverrunsyooooomi/your_spotify_server, starts after mongomongorunsmongo:4.4.8webrunsyooooomi/your_spotify_client
Ports
A port is the door the app answers on. A mapping like 8884:8080 means it's reachable on port 8884 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8884 in a browser. It opens:
8884:8080, likely the web interface3084:3000, likely the web interface
Volumes
A volume is where Your_spotify (stack) 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:
/data/dbfrom/portainer/Files/AppData/Config/your_spotify/dbon the host
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Your_spotify (stack) takes 5 of them, all with defaults you can leave alone or tweak:
API_ENDPOINT, defaults tohttp://localhost:8884CLIENT_ENDPOINT, defaults tohttp://localhost:3084SPOTIFY_PUBLIC, defaults to__your_spotify_client_id__SPOTIFY_SECRET, defaults to__your_spotify_secret__CORS, defaults tohttp://localhost:3084,http://localhost:3085
Restart policy
The restart policy here is always, so Docker brings Your_spotify (stack) back up after a crash and again when the server reboots. Good for anything you want running around the clock. 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 server) 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 Your_spotify (stack) up. Add the template list to Portainer once, then deploying Your_spotify (stack) is a click rather than a wall of config.