docs: add install instructions and Kuma migration guide to README
CI / test (pull_request) Successful in 4m37s
CI / lint (pull_request) Successful in 1m12s

This commit is contained in:
2026-05-24 14:16:06 -04:00
parent 09e1bec9a3
commit d1bd66deb3
+31 -1
View File
@@ -2,7 +2,7 @@
Self-hosted uptime monitor with a TUI you can access over SSH. No browser, no install on the client — just `ssh -p 23234 your-server`. Self-hosted uptime monitor with a TUI you can access over SSH. No browser, no install on the client — just `ssh -p 23234 your-server`.
Originally forked from [RDGames/go-upkeep](https://github.com/RDGames/go-upkeep). This is an independent fork with significant additions. Built on the foundation of [RDGames/go-upkeep](https://github.com/RDGames/go-upkeep).
## What it does ## What it does
@@ -28,6 +28,25 @@ Seed some demo data to see it in action:
go run cmd/goupkeep/main.go -demo go run cmd/goupkeep/main.go -demo
``` ```
## Install
### From source
```bash
go install gitea.lerkolabs.com/lerko/uptime/cmd/goupkeep@latest
```
### Docker
```bash
docker pull lerko/go-upkeep:latest
docker run -p 23234:23234 -p 8080:8080 -v ./data:/data lerko/go-upkeep
```
### Binary
Download from [Releases](https://gitea.lerkolabs.com/lerko/uptime/releases).
## Config as code ## Config as code
Export your current monitors: Export your current monitors:
@@ -85,6 +104,17 @@ First run: attach to the container (`docker attach go-upkeep`), go to the Users
| `UPKEEP_CLUSTER_SECRET` | | Shared key for cluster + API auth | | `UPKEEP_CLUSTER_SECRET` | | Shared key for cluster + API auth |
| `UPKEEP_INSECURE_SKIP_VERIFY` | `false` | Skip TLS verification for checks | | `UPKEEP_INSECURE_SKIP_VERIFY` | `false` | Skip TLS verification for checks |
## Migrating from Uptime Kuma
Export your Kuma backup JSON, then:
```bash
curl -X POST http://localhost:8080/api/import/kuma \
-H "X-Upkeep-Secret: your-secret" \
-H "Content-Type: application/json" \
-d @kuma-backup.json
```
## License ## License
MIT — see [LICENSE](LICENSE). MIT — see [LICENSE](LICENSE).