Portainer Templates logo

Portainer Templates

DashMachine DashMachine

Container

ToolsDashboard

Another application bookmark , with fun features.

Image details

Pulls: 11.3M
Architecture: amd64
Image size: 67 MB
Latest: v0.5-4
User: rmountjoy
Created: Feb 01, 2020
Updated: 6 years ago
Status: active

Configuration

Type
Container
Platform
linux
Image
rmountjoy/dashmachine:latest
Ports
5000:5000/tcp
Volumes
/dashmachine/dashmachine/user_data : /portainer/Files/AppData/Config/Dashmachine
Restart
unless-stopped

Template by xneo1

Standalone Install

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

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 DashMachine, fill in any config options, and hit Deploy

Template Import URL

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

More install options in our documentation.

DashMachine

Another web application bookmark dashboard, with fun features.

Subreddit subscribers
GitHub last commit Docker Cloud Build Status
Docker Pulls GitHub Repo stars
GitHub repo size Docker Image Size (tag) Lines of code
GPLv3 License Awesome
Donate Bountysource
Want a feature added now? Open a bounty

Screenshots

screenshot
screenshot
screenshot
screenshot

Installation

Docker

docker create \
  --name=dashmachine \
  -p 5000:5000 \
  -v path/to/data:/dashmachine/dashmachine/user_data \
  --restart unless-stopped \
  rmountjoy/dashmachine:latest
To run in a subfolder, use a CONTEXTPATH environment variable. For example, to run at localhost:5000/dash: 
docker create \
  --name=dashmachine \
  -p 5000:5000 \
  -e CONTEXT_PATH=/dash
  -v path/to/data:/dashmachine/dashmachine/user_data \
  --restart unless-stopped \
  rmountjoy/dashmachine:latest

Synology

Check out this awesome guide: https://nashosted.com/manage-your-self-hosted-applications-using-dashmachine/

Python

Instructions are for linux. 
virtualenv --python=python3 DashMachineEnv
cd DashMachineEnv && source bin/activate
git clone https://github.com/rmountjoy92/DashMachine.git
cd DashMachine && pip install -r requirements.txt
python3 run.py
Then open a web browser and go to localhost:5000

Default user/password

User: admin
Password: admin

Updating

For python, use git. For docker, just pull the latest image and recreate the container.

Configuration

The user data folder is located at DashMachine/dashmachine/userdata. This is where the config.ini, custom backgrounds/icons, and the database file live. A reference for what can go into the config.ini file can be found on the settings page of the dashmachine by clicking the info icon next to 'Config'.

Note

If you change the config.ini file, you either have to restart the container (or python script) or click the 'save' button in the config section of settings for the config to be applied. Pictures added to the backgrounds/icons folders are available immediately.

Want to contribute?

Please use the pull request template at: https://github.com/rmountjoy92/DashMachine/blob/master/pullrequesttemplate.md
See this link for how to create a pull request: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request

Tech used

  • Flask (Python 3)
  • SQLalchemy w/ SQLite database
  • HTML5/Jinja2
  • Materialize css
  • JavaScript/jQuery/jQueryUI
  • .ini (for configuration)

FAQs

  1. application does not work in iframe
see https://github.com/rmountjoy92/DashMachine/issues/6

Serve DashMachine 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 dashmachine.example.com to http://dashmachine:5000

Add this to your Caddyfile

dashmachine.example.com {
	reverse_proxy http://dashmachine:5000
}

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

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

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/Dashmachine

Image won't pull

Test the pull directly on the host: docker pull rmountjoy/dashmachine: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.

  • This image supports: amd64
  • 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 dashmachine --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

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

A single container

DashMachine runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything DashMachine needs bundled into one download. This template pulls rmountjoy/dashmachine:latest, which Docker fetches once (about 67 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. DashMachine's comes from Docker Hub, published by rmountjoy.

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 v0.5-4. 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, so it runs on regular x86 PCs and servers, though not ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 5000:5000 means it's reachable on port 5000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 5000:5000

Volumes

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

  • /dashmachine/dashmachine/user_data from /portainer/Files/AppData/Config/Dashmachine on the host

Restart policy

The restart policy here is unless-stopped, so Docker restarts DashMachine 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

Nothing custom is set, so DashMachine 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 dashmachine. That's what you'll spot in the containers list and use in commands like docker logs dashmachine.

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 DashMachine up. Add the template list to Portainer once, then deploying DashMachine is a click rather than a wall of config.