lookshe/uptime-kuma-monitor-configure
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Configure Uptime Kuma monitors with YAML
19 commits 1 branch 0 tags 89 KiB
Find a file
Exact
lookshe 7c87b025da fix bug with multiple monitors when there is no replacement to made
2025-12-17 19:43:34 +01:00
.gitignore initial commit 2025-12-11 23:19:16 +01:00
config.example.yml rename ip address without special naming handling as "default" 2025-12-16 13:04:00 +01:00
eslint.config.mjs add prettier and fix all errors 2025-12-15 19:29:30 +01:00
index.js fix bug with multiple monitors when there is no replacement to made 2025-12-17 19:43:34 +01:00
package-lock.json add prettier and fix all errors 2025-12-15 19:29:30 +01:00
package.json add prettier and fix all errors 2025-12-15 19:29:30 +01:00
prettier.config.mjs adjust line width to 120 2025-12-15 20:21:03 +01:00
README.md add readme 2025-12-16 16:40:51 +01:00

README.md

uptime-kuma-monitor-configure

Configure monitors for Uptime Kuma directly in its SQLite database using a YAML configuration file.

Features

  • define monitors and groups in a simple YAML file
  • supports nested groups and inheritance of defaults
  • automatically creates or updates monitors in the Uptime Kuma SQLite database
  • handles IPv4/IPv6 substitution with $$IP$$ placeholder
  • apply safe defaults (user_id: 1, interval: 60, retry_interval: 60, timeout: 48) if not specified
  • works directly with the database (no need for API calls)

Requirements

  • Node.js 22.x (or later)
  • npm (comes with Node.js)

Installation

Clone the repository and install dependencies:

git clone https://git.fucktheforce.de/lookshe/uptime-kuma-monitor-configure.git
cd uptime-kuma-monitor-configure
npm ci --omit=dev

Usage

Make sure to stop Uptime Kuma before running the script to avoid problems. Run the script with the required arguments:

node index.js --config config.yml --database /path/to/uptime-kuma/kuma.db

Configuration

For an example configuration look at config.example.yml. YAML also supports anchors (&) and references (*) for reusage of monitors. $$IP$$ can be used as placeholder for configured ip addresses from group parents.

Caveats

  • stop Uptime Kuma before execution to avoid database locks
  • always back up your Uptime Kuma database before running the script
  • the script uses REPLACE INTO for database operations, which may overwrite existing rows