Portainer Templates logo

Portainer Templates

Dashy (stack) Dashy (stack)

ToolsDashboard

Helps you organize your self-hosted services by making them accessible from a single place.

Image details

Pulls: 18.7M
Architecture: amd64, arm64, arm/v7
Image size: 111 MB
Latest: 4.5
User: lissy93
Created: May 22, 2021
Updated: 14 hours ago
Status: active

Source details

Repo: lissy93/dashy
Stars: 26.2k
Forks: 2k
Language: Vue
License: MIT
Latest: 4.5.0 · 20 days ago
Updated: 14 hours ago
Website: dashy.to/

Configuration

Type
Compose
Platform
linux
Image
lissy93/dashy
Ports
4000:80
Volumes
/app/public/conf.yml : /portainer/Files/AppData/Config/Dashy/conf.yml/app/public/item-icons : /portainer/Files/AppData/Config/Dashy/icons
Env vars
NODE_ENV=productionUID=1000GID=1000PUID=1000PGID=1000PORT=''
Restart
always
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying Dashy (stack)

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 Dashy (stack), 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:

services:
  dashy:
    # To build from source, replace 'image: lissy93/dashy' with 'build: .'
    # build: .
    image: lissy93/dashy
    container_name: Dashy
    # Pass in your config file below, by specifying the path on your host machine
    volumes:
       - /portainer/Files/AppData/Config/Dashy/conf.yml:/app/public/conf.yml
       - /portainer/Files/AppData/Config/Dashy/icons:/app/public/item-icons
    ports:
      - 4000:80
    # Set any environmental variables
    environment:
      - NODE_ENV=production
    # Specify your user ID and group ID. You can find this by running `id -u` and `id -g`
      - UID=1000
      - GID=1000
    # Specify restart policy
    restart: always
    # Configure healthchecks
    healthcheck:
      test: ['CMD', 'node', '/app/services/healthcheck']
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 40s

Or deploy it directly from the source:

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

More install options in our documentation, or see lissy93/dashy for app-specific guidance.

Dashy

Dashy helps you organize your self-hosted services by making them accessible from a single place

<br/>

User Showcase | Live Demo | Getting Started | Documentation | GitHub

Serve Dashy (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 dashy-stack.example.com to http://dashy:80

Add this to your Caddyfile

dashy-stack.example.com {
	reverse_proxy http://dashy:80
}

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:4000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :4000
  • Stop the other service, or pick a different host port. In 4000:80 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:4000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, dashy can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 4000

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/Dashy/conf.yml (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull lissy93/dashy

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

  • This image supports: amd64, arm64, arm/v7
  • 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.

Required settings are blank

PORT has no default value, and dashy may crash or misbehave if left empty.

  • Fill it in on the deploy screen before hitting deploy.

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

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

The app image

An image is the app packed up ready to go, everything Dashy (stack) needs bundled into one download. This template pulls lissy93/dashy, which Docker fetches once (about 111 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Dashy (stack)'s comes from Docker Hub, published by lissy93.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 4.5. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 4000:80 means it's reachable on port 4000 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:4000 in a browser. It opens:

  • 4000:80, likely the web interface

Volumes

A volume is where Dashy (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:

  • /app/public/conf.yml from /portainer/Files/AppData/Config/Dashy/conf.yml on the host
  • /app/public/item-icons from /portainer/Files/AppData/Config/Dashy/icons on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Dashy (stack) takes 6 of them, and one needs a value before it'll start properly:

  • NODE_ENV, defaults to production
  • UID, defaults to 1000
  • GID, defaults to 1000
  • PUID, defaults to 1000
  • PGID, defaults to 1000
  • PORT, needs a value

Restart policy

The restart policy here is always, so Docker brings Dashy (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).

Health check

A health check is how Docker tells whether Dashy (stack) is really working, not just switched on. It runs node /app/services/healthcheck every 1m30s and flags the container as unhealthy if that keeps failing.

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Dashy (stack) sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container dashy. That's what you'll spot in the containers list and use in commands like docker logs dashy.

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

Dashy (stack) is open source, released under the MIT 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 Dashy (stack) up. Add the template list to Portainer once, then deploying Dashy (stack) is a click rather than a wall of config.