Skip to content

README.md

Latest commit

 

History

History
186 lines (151 loc) · 4.62 KB

README.md

File metadata and controls

186 lines (151 loc) · 4.62 KB

Uptime Kuma

Build Status Last Commit

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. Matches Linux Docker behavior.

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
      - 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:
      - "/path/to/containers/uptime-kuma:/config"
    ports:
      - 3001:3001
    annotations:
      org.freebsd.jail.allow.raw_sockets: "true"
    restart: unless-stopped

AppJail Director

.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:

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  uptime-kuma:
    name: uptime_kuma
    options:
      - container: 'boot args:--pull'
    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: '/path/to/containers/uptime-kuma'

Makejail:

ARG tag=latest

OPTION overwrite=force
OPTION from=ghcr.io/daemonless/uptime-kuma:${tag}
SET allow.raw_sockets=1

Podman CLI

podman run -d --name uptime-kuma \
  -p 3001:3001 \
  --annotation 'org.freebsd.jail.allow.raw_sockets=true' \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e UPTIME_KUMA_IS_CONTAINER=1 \
  -e UPTIME_KUMA_ALLOW_ALL_CHROME_EXEC=1 \
  -e PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 \
  -e DATA_DIR=/config \
  -v /path/to/containers/uptime-kuma:/config \
  ghcr.io/daemonless/uptime-kuma:latest

Ansible

- name: Deploy uptime-kuma
  containers.podman.podman_container:
    name: uptime-kuma
    image: ghcr.io/daemonless/uptime-kuma:latest
    state: started
    restart_policy: always
    env:
      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"
    ports:
      - "3001:3001"
    volumes:
      - "/path/to/containers/uptime-kuma:/config"
    annotation:
      org.freebsd.jail.allow.raw_sockets: "true"

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.0

Need help? Join our Discord community.