From fb4e14ecd115091658b73c0417313f440e09d8eb Mon Sep 17 00:00:00 2001 From: Tyler Koenig Date: Fri, 12 Jun 2026 19:38:55 -0400 Subject: [PATCH] docs(readme): fix broken quick start, stale binary targets, canonical origin MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - go run cmd/uptop/main.go broke when PR #108 split config.go out of main.go — use ./cmd/uptop package path (same fix #104 applied to Dockerfile and goreleaser) - binary section claimed Linux amd64 only; goreleaser ships linux/darwin/windows x amd64/arm64 + deb/rpm since #104 - state canonical repo (Gitea) vs mirror (GitHub) up front - UPTOP_ADMIN_KEY is the only documented first-run path --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index aa374cb..99fa857 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ An uptime monitor you manage entirely from the terminal. It runs as a server, ex Built on [RDGames/go-upkeep](https://github.com/RDGames/go-upkeep). Rewritten for clustering, config-as-code, and a proper dashboard. +Canonical repo: [gitea.lerkolabs.com/lerkolabs/uptop](https://gitea.lerkolabs.com/lerkolabs/uptop) — [GitHub](https://github.com/lerkolabs/uptop) is a mirror; releases are published to both. + ## Features - **6 check types** — HTTP, Push (heartbeat), Ping, Port, DNS, Groups @@ -51,14 +53,14 @@ Built on [RDGames/go-upkeep](https://github.com/RDGames/go-upkeep). Rewritten fo ## Quick start ```bash -go run cmd/uptop/main.go +go run ./cmd/uptop ssh -p 23234 localhost ``` Want some data to look at first: ```bash -go run cmd/uptop/main.go -demo +go run ./cmd/uptop -demo ``` ## Install @@ -85,16 +87,16 @@ services: - net.ipv4.ping_group_range=0 2147483647 ``` -First run: set `UPTOP_ADMIN_KEY` to your SSH public key, or attach to the container and add it in the Users tab. +First run: set `UPTOP_ADMIN_KEY` to your SSH public key. The `sysctls` line enables unprivileged ICMP inside the container — without it, ping monitors get no response and silently report DOWN.
-Binary (Linux amd64) +Binary (Linux, macOS, Windows) -Download from [Releases](https://github.com/lerkolabs/uptop/releases). +Download from [Releases](https://github.com/lerkolabs/uptop/releases) — amd64 and arm64 tarballs (zip for Windows), plus `.deb`/`.rpm` packages and `checksums.txt`.