Reading the repo

Opening the box…

Assembly instructions

louislam/uptime-kuma

A fancy self-hosted monitoring tool

Node.jsVite#docker#monitor#monitoring#responsive

Difficulty: Involved
Time: 30 min or more
Stars: ★ 93,267
Activity: Updated this month
License: MIT
Open issues: 861
Got it running: Be the first
Looked up: 2 h ago

Saved setup from 2 h ago

Start here

Website ↗uptime.kuma.petThe project's own site.

Will it work on my device?

Yes, with Docker on macOS

It's a self-hosted app: the README runs it with Docker, and you open it in your browser.
On macOS that means installing Docker Desktop first.

Checking for

Run it with Docker

A self-hosted app: Docker runs it on your computer and you open it in the browser. Needs Docker Desktop (or Docker Engine on Linux). Run docker compose commands inside the cloned repo folder.

Docker

docker compose up -d

From the README, exactly as the maintainers wrote it.

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 10 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js >= 26.2.0runtime
1×npm package manager
1×MongoDB service
1×MySQL service
1×PostgreSQL service
1×Redis service

Share this manual

Good to know

Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: extra/docker-latest-warning/package.json, extra/kuma-pr/package.json, extra/push-examples/javascript-fetch/package.json, extra/push-examples/typescript-fetch/package.json and 1 more

package.json scripts (59)

lint:jseslint --ext ".js,.vue" --ignore-path .gitignore .
lint:js-prodnode --run lint:js
lint-fix:jseslint --ext ".js,.vue" --fix --ignore-path .gitignore .
lint:stylestylelint "**/*.{vue,css,scss}" --ignore-path .gitignore
lint-fix:stylestylelint "**/*.{vue,css,scss}" --fix --ignore-path .gitignore
lintnode --run lint:js && node --run lint:style
fmtprettier --write "**/*.{js,ts,vue,css,scss,json,md,yml,yaml}"
lint:prodnode --run lint:js-prod && node --run lint:style
devconcurrently -k -r "wait-on tcp:3000 && node --run start-server-dev " "node --run start-frontend-dev"
start-frontend-devcross-env NODE_ENV=development vite --host
startnode --run start-server
start-servernode --import=tsx server/server.js
start-server-devcross-env NODE_ENV=development tsx server/server.js
start-server-dev:watchcross-env NODE_ENV=development tsx --watch server/server.js
buildvite build
precompile-servernode extra/precompile-server.js
testnode --run test-backend && node --run test-e2e
test-with-buildnode --run build && npm test
test-backendcross-env TEST_BACKEND=1 node extra/run-backend-tests.mjs --experimental-test-coverage --test-coverage-exclude="test/**" --test-reporter=spec
test-e2eplaywright test
test-e2e-localcross-env SKIP_TESTCONTAINER=1 npm run build && npm run test-e2e
test-e2e-uiplaywright test --ui --ui-port=51063
playwright-codegenplaywright codegen localhost:3000 --save-storage=./private/e2e-auth.json
playwright-show-reportplaywright show-report ./private/playwright-report
vite-preview-distvite preview --host

Files we read (10)

.github/workflows/ai-slop.yml

.github/workflows/auto-test.yml

.github/workflows/build-docker-base.yml

.github/workflows/build-docker-pr-test.yml

.github/workflows/build-docker-push.yml

.github/workflows/pr-description-check.yml

CONTRIBUTING.md

README.md

compose.yaml

package.json

Branch master · 919 files in the repo