{
  "schema_version": 1,
  "generated_at": "2026-10-22T00:00:00.000Z",
  "canonical_url": "https://openlogs.fyi/tools/uptime-kuma",
  "slug": "uptime-kuma",
  "name": "Uptime Kuma",
  "tagline": "Checks your websites, ports and services on a schedule and sends an alert when one goes down.",
  "replaces": {
    "summary": "Hosted uptime monitoring services, such as UptimeRobot.",
    "products": [
      {
        "slug": "uptimerobot",
        "name": "UptimeRobot",
        "vendor": null,
        "url": "https://openlogs.fyi/alternatives/uptimerobot"
      }
    ]
  },
  "stack": [
    {
      "kind": "runtime",
      "name": "Node.js"
    }
  ],
  "deployment_methods": [
    "docker_compose",
    "docker",
    "manual"
  ],
  "requirements": {
    "min_ram_mb": null,
    "min_cpu_cores": null,
    "source_url": null
  },
  "license": {
    "spdx": "MIT",
    "class": "osi",
    "source_url": "https://github.com/louislam/uptime-kuma/blob/2adb5bc32cb53a93722a7c348364a8290acd74d4/LICENSE"
  },
  "business_model": {
    "value": "unknown",
    "notes": "The README asks for support through GitHub Sponsors and Open Collective. We found no paid plan in the README, so the business model stays unknown.",
    "source_url": "https://github.com/louislam/uptime-kuma/blob/2adb5bc32cb53a93722a7c348364a8290acd74d4/README.md",
    "checked_at": "2026-10-21"
  },
  "difficulty": {
    "value": "easy",
    "reason": "One container. Its data is a ./data folder next to the compose file, and it needs no outside services."
  },
  "repository": {
    "owner": "louislam",
    "name": "uptime-kuma",
    "url": "https://github.com/louislam/uptime-kuma"
  },
  "compose_check": {
    "status": "config_ok",
    "validated_at": "2026-10-21",
    "summary": "config_ok on 2026-10-21"
  },
  "recipe": {
    "version": 1,
    "source_path": "compose.yaml",
    "source_repo": "louislam/uptime-kuma",
    "source_commit_sha": "2adb5bc32cb53a93722a7c348364a8290acd74d4",
    "source_kind": "app_repo",
    "source_url": "https://github.com/louislam/uptime-kuma/blob/2adb5bc32cb53a93722a7c348364a8290acd74d4/compose.yaml"
  },
  "install_steps": [
    {
      "order": 1,
      "kind": "prerequisite",
      "language": "text",
      "label": "Docker with the Compose plugin",
      "body": "A host with Docker and the Docker Compose plugin.",
      "source_url": "https://github.com/louislam/uptime-kuma/blob/2adb5bc32cb53a93722a7c348364a8290acd74d4/README.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 2,
      "kind": "compose",
      "language": "yaml",
      "label": "Save the compose file as compose.yaml",
      "body": "services:\n  uptime-kuma:\n    image: louislam/uptime-kuma:2\n    restart: unless-stopped\n    volumes:\n      - ./data:/app/data\n    ports:\n      # <Host Port>:<Container Port>\n      - \"3001:3001\"\n",
      "source_url": "https://github.com/louislam/uptime-kuma/blob/2adb5bc32cb53a93722a7c348364a8290acd74d4/compose.yaml",
      "validation_status": "config_ok"
    },
    {
      "order": 3,
      "kind": "shell",
      "language": "bash",
      "label": "Start it",
      "body": "docker compose up -d",
      "source_url": "https://github.com/louislam/uptime-kuma/blob/2adb5bc32cb53a93722a7c348364a8290acd74d4/README.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 4,
      "kind": "verify",
      "language": "text",
      "label": "Check that it answers",
      "body": "Open http://localhost:3001 or http://your-ip:3001. The README says it listens on all network interfaces.",
      "source_url": "https://github.com/louislam/uptime-kuma/blob/2adb5bc32cb53a93722a7c348364a8290acd74d4/README.md",
      "validation_status": "unvalidated"
    }
  ],
  "notes": [
    {
      "kind": "gotcha",
      "title": "NFS is not supported for the data folder",
      "body": "The README says file systems like NFS are not supported. The data folder must be a local directory or a Docker volume.",
      "source_url": "https://github.com/louislam/uptime-kuma/blob/2adb5bc32cb53a93722a7c348364a8290acd74d4/README.md",
      "checked_at": "2026-10-21"
    },
    {
      "kind": "gotcha",
      "title": "Port 3001 is open on all interfaces",
      "body": "The README says the app listens on all network interfaces. For the docker run form it shows -p 127.0.0.1:3001:3001 to listen on localhost only. The compose file publishes 3001:3001.",
      "source_url": "https://github.com/louislam/uptime-kuma/blob/2adb5bc32cb53a93722a7c348364a8290acd74d4/README.md",
      "checked_at": "2026-10-21"
    },
    {
      "kind": "upgrade",
      "title": "Upgrade steps are in the project wiki",
      "body": "The README points to the wiki page \"How to Update\" for upgrades.",
      "source_url": "https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update",
      "checked_at": "2026-10-21"
    },
    {
      "kind": "requirement",
      "title": "Node.js for a non-Docker install",
      "body": "The README lists Node.js 20.4 or newer as a requirement for the non-Docker install. The Docker image does not need it on the host.",
      "source_url": "https://github.com/louislam/uptime-kuma/blob/2adb5bc32cb53a93722a7c348364a8290acd74d4/README.md",
      "checked_at": "2026-10-21"
    }
  ],
  "signals": {
    "captured_at": "2026-10-21",
    "stars": 92690,
    "forks": 8581,
    "open_issues": 848,
    "last_push": "2026-10-21",
    "days_since_push": 0,
    "latest_release": "2.5.6",
    "latest_release_date": "2026-10-09",
    "days_since_release": 12
  },
  "links": {
    "html": "https://openlogs.fyi/tools/uptime-kuma",
    "markdown": "https://openlogs.fyi/tools/uptime-kuma.md",
    "json": "https://openlogs.fyi/tools/uptime-kuma.json"
  },
  "updated_at": "2026-10-22"
}