Skip to content

About

Self-hosted uptime monitoring tool with a beautiful dashboard, status pages, and multi-channel notifications.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Uptime Kuma

Build Status Last Commit OCI Pulls

Self-hosted uptime monitoring tool with a beautiful dashboard, status pages, and multi-channel notifications.

Port 3001
Registry ghcr.io/daemonless/uptime-kuma
Source https://github.com/louislam/uptime-kuma
Website https://uptime.kuma.pet/

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  uptime-kuma:
    image: "ghcr.io/daemonless/uptime-kuma:latest"
    container_name: uptime-kuma
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - UPTIME_KUMA_IS_CONTAINER=1
      - UPTIME_KUMA_ALLOW_ALL_CHROME_EXEC=1
      - PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
      - DATA_DIR=/config
    volumes:
      - "/containers/uptime-kuma:/config"
    ports:
      - "3001:3001"
    annotations:
      org.freebsd.jail.allow.raw_sockets: "true"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=uptime-kuma
PUID=1000
PGID=1000
TZ=UTC
UPTIME_KUMA_IS_CONTAINER=1
UPTIME_KUMA_ALLOW_ALL_CHROME_EXEC=1
PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
DATA_DIR=/config

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  uptime-kuma:
    name: uptime_kuma
    options:
      - container: 'args:--pull'
      - expose: '3001:3001 proto:tcp'
      - template: !ENV '${PWD}/template.conf'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - UPTIME_KUMA_IS_CONTAINER: !ENV '${UPTIME_KUMA_IS_CONTAINER}'
        - UPTIME_KUMA_ALLOW_ALL_CHROME_EXEC: !ENV '${UPTIME_KUMA_ALLOW_ALL_CHROME_EXEC}'
        - PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: !ENV '${PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD}'
        - DATA_DIR: !ENV '${DATA_DIR}'
    volumes:
      - uptime-kuma: /config
volumes:
  uptime-kuma:
    device: '/containers/uptime-kuma'

Makejail:

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/uptime-kuma:${tag}

template.conf:

# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.raw_sockets

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  uptime-kuma:
    name: uptime-kuma
    image: "ghcr.io/daemonless/uptime-kuma:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - UPTIME_KUMA_IS_CONTAINER=1
      - UPTIME_KUMA_ALLOW_ALL_CHROME_EXEC=1
      - PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
      - DATA_DIR=/config
    volumes:
      - "/containers/uptime-kuma:/config"

Save as bastille-compose.yml, then run bastille up.

Access at: http://localhost:3001

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container
UPTIME_KUMA_IS_CONTAINER 1
UPTIME_KUMA_ALLOW_ALL_CHROME_EXEC 1
PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD 1
DATA_DIR /config

Volumes

Path Description
/config Data directory (database, settings)

Ports

Port Protocol Description
3001 TCP Web UI

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15


Need help? Join our Discord community.

About

Self-hosted uptime monitoring tool with a beautiful dashboard, status pages, and multi-channel notifications.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages