UptimeMonitor-Server - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #machine-learning #deep-learning #docker #nodejs #cli #kubernetes #pytorch #security #ios #openai

UptimeMonitor-Server

(★ 65)

Enterprise-grade uptime monitoring system

File Explorer

Download Latest Version (.zip)

- - docker-latest.yml
  - docker-release.yml
- FUNDING.yml
- low-resources.xml
- admin-api.md
- api.md
- configuration.md
- custom-metrics.md
- dependencies.md
- groups.md
- notifications.md
- pulsemonitor.md
- pulses.md
- reports.md
- - config.ts
  - groups.ts
  - helpers.ts
  - incidents.ts
  - index.ts
  - maintenances.ts
  - monitors.ts
  - notifications.ts
  - pulse-monitors.ts
  - reports.ts
  - status-pages.ts
- - channel-manager.ts
  - index.ts
  - manager.ts
- - index.ts
  - schemas.ts
- - group-history.ts
  - group-reports.ts
  - helpers.ts
  - incidents.ts
  - index.ts
  - maintenances.ts
  - monitor-history.ts
  - monitor-reports.ts
  - pulse.ts
  - status-pages.ts
- - incident.ts
  - maintenance.ts
- aggregation.ts
- cache.ts
- clickhouse.ts
- config.ts
- database.ts
- group-state-tracker.ts
- group-updater.ts
- incidents.ts
- index.ts
- logger.ts
- maintenances.ts
- missing-pulse-detector.ts
- pulse-buffer.ts
- pulsemonitor.ts
- selfmonitor.ts
- status-updater.ts
- statuspage.ts
- times.ts
- types.ts
- uptime-updater.ts
- times.test.ts
.editorconfig
.gitignore
.prettierrc.json
bun.lock
config.example.toml
docker-compose.override.yml
docker-compose.yml
Dockerfile
LICENSE
package.json
README.md
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/Rabbit-Company/UptimeMonitor-Server

Downloads the entire project code from GitHub to your computer.

cd UptimeMonitor-Server

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

sudo docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Uptime Monitor

A high-performance uptime monitoring system built with Bun and ClickHouse. Receive heartbeat pulses from your services, organize them into groups, track custom metrics, and get notified when things go down.

## Features

- **Pulse-Based Monitoring** - Services send heartbeats; missing pulses trigger alerts
- **Hierarchical Groups** - Organize monitors with flexible health strategies (any-up, all-up, percentage)
- **Custom Metrics** - Track up to 3 numeric values per monitor (player count, connections, etc.)
- **Multi-Channel Notifications** - Discord, Email, Ntfy, Telegram and Webhook support with per-monitor control
- **Dependency-Based Notification Suppression** - Define dependencies between monitors/groups to avoid notification storms when infrastructure fails
- **Real-Time Status Pages** - WebSocket-powered live updates
- **Self-Healing** - Automatic backfill when the monitor itself recovers from downtime

## Quick Start

### 1. Start the Services

```bash
wget https://github.com/Rabbit-Company/UptimeMonitor-Server/releases/latest/download/uptime-monitor.tar.xz
tar -xf uptime-monitor.tar.xz
cd uptime-monitor

sudo docker compose up -d
```

This starts:

- **Uptime Monitor** on port `3000`
- **ClickHouse** database (internal)

### 2. Configure Your Monitors

**Option A: Visual Configuration Editor (Recommended)**

Visit https://uptime-monitor.org/configurator to visually create and edit your configuration with a user-friendly interface. You can:

- Import your existing config.toml file
- Visually create monitors, groups, and status pages
- Configure custom metrics and notification channels
- Export your configuration back to TOML format

**Option B: Manual Configuration**

Edit `config.toml` to add your monitors:

```toml
[[monitors]]
id = "my-api"
name = "My API"
token = "secret-token-here"
interval = 30              # Expect pulse every 30 seconds
maxRetries = 0             # Mark down immediately on miss
resendNotification = 0     # Don't resend notifications
```

### 3. Send Pulses

From your service, send a GET request when healthy:

```bash
curl http://localhost:3000/v1/push/secret-token-here
```

Or with latency tracking:

```bash
curl "http://localhost:3000/v1/push/secret-token-here?latency=125"
```

See [Pulses](docs/pulses.md) for timing parameters, best practices, and how pulse windows work.

### 4. Check Status

```bash
curl http://localhost:3000/v1/status/:slug
```

## Documentation

| Document                                                               | Description                                          |
| ---------------------------------------------------------------------- | ---------------------------------------------------- |
| [Pulses](docs/pulses.md)                                               | How pulses work, timing, and best practices          |
| [Configuration Guide](docs/configuration.md)                           | Complete config.toml reference                       |
| [API Reference](docs/api.md)                                           | All endpoints and WebSocket events                   |
| [Admin API Reference](docs/admin-api.md)                               | CRUD endpoints for managing configuration via API    |
| [Notifications](docs/notifications.md)                                 | Setting up Discord, Email, Ntfy, Telegram, Webhook   |
| [Groups & Strategies](docs/groups.md)                                  | Organizing monitors hierarchically                   |
| [Dependencies](docs/dependencies.md)                                   | Notification suppression via dependencies            |
| [Custom Metrics](docs/custom-metrics.md)                               | Tracking additional data points                      |
| [PulseMonitor Integration](docs/pulsemonitor.md)                       | Automated monitoring from multiple regions           |
| [Reports](docs/reports.md)                                             | Export monitor and group history data in CSV or JSON |
| [Visual Configuration Editor](https://uptime-monitor.org/configurator) | Web-based UI for configuring monitors                |

## Related Projects

- [UptimeMonitor-StatusPage](https://github.com/Rabbit-Company/UptimeMonitor-StatusPage) - Frontend status page
- [PulseMonitor](https://github.com/Rabbit-Company/PulseMonitor) - Automated pulse sender for multiple protocols
- [Visual Configuration Editor](https://uptime-monitor.org/configurator) - Web-based UI for configuring monitors

## Architecture

```
┌─────────────────┐      ┌──────────────────┐      ┌─────────────┐
│  Your Services  │─────▶│  Uptime Monitor  │─────▶│  ClickHouse │
│  (send pulses)  │      │   (Bun server)   │      │  (storage)  │
└─────────────────┘      └──────────────────┘      └─────────────┘
                                  │
                                  ▼
                       ┌──────────────────────┐
                       │    Notifications     │
                       │  Discord/Email/Ntfy  │
                       └──────────────────────┘
```

## License

[GPL-3.0](https://github.com/Rabbit-Company/UptimeMonitor-Server/blob/main/LICENSE)