![Uptime Kuma (stack)]()
Uptime Kuma (stack)
It is a self-hosted monitoring tool like Uptime Robot
Image details
Source details
Configuration
TypeComposelinuxlouislam/uptime-kuma:13001:3001/app/data : /portainer/Files/AppData/Config/uptime-kuma-data/var/run/docker.sock : /var/run/docker.sockalwaysStandalone Install
Select an install method, to see config/commands for deploying Uptime Kuma (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 Uptime Kuma (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:
# Simple docker-compose.yml
# You can change your port or volume location
services:
uptime-kuma:
image: louislam/uptime-kuma:1
container_name: uptime-kuma
volumes:
- /portainer/Files/AppData/Config/uptime-kuma-data:/app/data
- /var/run/docker.sock:/var/run/docker.sock
ports:
- 3001:3001 # <Host Port>:<Container Port>
restart: always
Or deploy it directly from the source:
git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/uptimekuma.yml up -dMore install options in our documentation, or see louislam/uptime-kuma for app-specific guidance.
Uptime Kuma
<img src="./public/icon.svg" width="128" alt="" />It is a self-hosted monitoring tool.
Tags
⚠️:latest is deprecated and bad practice.Recommended Tags
| Tag | Description |
|---|---|
| 2 | Latest version of v2 (Recommended) |
| 2-slim | (Slim) Latest version of v2 |
Read more: https://github.com/louislam/uptime-kuma/wiki/Docker-Tags
Serve Uptime Kuma (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 uptime-kuma-stack.example.com to http://uptime-kuma:3001
Add this to your Caddyfile
uptime-kuma-stack.example.com {
reverse_proxy http://uptime-kuma:3001
}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:3001 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :3001 - Stop the other service, or pick a different host port. In
3001:3001only 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:3001. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, uptime-kuma can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 3001
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/uptime-kuma-data
Can't reach the Docker socket
uptime-kuma 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 louislam/uptime-kuma:1
- "manifest unknown" means the tag no longer exists.
- "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.
- 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
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 on louislam/uptime-kuma
- Template not working: Open an issue on xneo1/portainer_templates
- This website not working: Open an issue on lissy93/portainer-templates
A Compose stack
Uptime Kuma (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 Uptime Kuma (stack) needs bundled into one download. This template pulls louislam/uptime-kuma:1, which Docker fetches once (about 573 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. Uptime Kuma (stack)'s comes from Docker Hub, published by louislam.
Version tags
The bit after the colon in the image name is the version tag. This one pins 1, so every redeploy gives you that exact build until you bump it yourself.
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 3001:3001 means it's reachable on port 3001 of your server, where the left number is yours to change and the right one belongs to the app. It opens:
3001:3001
Volumes
A volume is where Uptime Kuma (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/datafrom/portainer/Files/AppData/Config/uptime-kuma-dataon the host/var/run/docker.sockfrom/var/run/docker.sockon the host (a socket it talks to, not storage)
Restart policy
The restart policy here is always, so Docker brings Uptime Kuma (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
Nothing custom is set, so Uptime Kuma (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 uptime-kuma. That's what you'll spot in the containers list and use in commands like docker logs uptime-kuma.
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
Uptime Kuma (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 Uptime Kuma (stack) up. Add the template list to Portainer once, then deploying Uptime Kuma (stack) is a click rather than a wall of config.