Portainer Templates logo

Portainer Templates

Dokemon Dokemon

Stack

Management

Deploy compose files, start/stop containers, delete unused images, view logs

Image details

Pulls: 285k
Architecture: amd64, arm64
Image size: 58 MB
Latest: 1.5.9
User: productiveops
Created: Dec 03, 2023
Updated: 2 years ago
Status: active

Source details

Stars: 769
Forks: 35
Language: TypeScript
License: MIT
Updated: 2 years ago
Website: dokemon.dev/

Configuration

Type
Compose
Platform
linux
Image
productiveops/dokemon:latest
Ports
9090:9090
Volumes
/var/run/docker.sock : /var/run/docker.sock/data : /portainer/Files/AppData/Config/dokemon/data
Restart
unless-stopped
Source

Template by xneo1·Source

Standalone Install

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

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 Dokemon, 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:
  dokemon:
    image: productiveops/dokemon:latest
    container_name: dokemon
    restart: unless-stopped
    ports:
      - 9090:9090
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /portainer/Files/AppData/Config/dokemon/data:/data

Or deploy it directly from the source:

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

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

QuickStart

# Create directory to store Dokemon data
mkdir ./dokemondata

# Run Dokemon
sudo docker run -p 9090:9090 \
            -v ./dokemondata:/data \
            -v /var/run/docker.sock:/var/run/docker.sock \
            --restart unless-stopped \
            --name dokemon -d productiveops/dokemon:latest

Use Traefik as Reverse Proxy with LetsEncrypt SSL certificate

Check https://github.com/ProductiveOps/dokemon

Serve Dokemon 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 dokemon.example.com to http://dokemon:9090

Add this to your Caddyfile

dokemon.example.com {
	reverse_proxy http://dokemon:9090
}

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

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

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/dokemon/data

Can't reach the Docker socket

dokemon talks to Docker through /var/run/docker.sock. If the logs show "permission denied while trying to connect to the Docker daemon socket", the app's user can't access it.

  • Check the socket exists on the host: ls -l /var/run/docker.sock
  • Run the container as root, or add the docker group's id to the container with group_add.

Image won't pull

Test the pull directly on the host: docker pull productiveops/dokemon: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, arm64
  • 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

Dokemon 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 Dokemon needs bundled into one download. This template pulls productiveops/dokemon:latest, which Docker fetches once (about 58 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. Dokemon's comes from Docker Hub, published by productiveops.

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 1.5.9. 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, 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 9090:9090 means it's reachable on port 9090 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 9090:9090

Volumes

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

  • /var/run/docker.sock from /var/run/docker.sock on the host (a socket it talks to, not storage)
  • /data from /portainer/Files/AppData/Config/dokemon/data on the host

Restart policy

The restart policy here is unless-stopped, so Docker restarts Dokemon 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 Dokemon 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 dokemon. That's what you'll spot in the containers list and use in commands like docker logs dokemon.

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

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