chore: rename project from go-upkeep to uptop
Module path now gitea.lerkolabs.com/lerko/uptop. Binary moves to cmd/uptop. All imports, display strings, CI config, and docs updated.
This commit is contained in:
@@ -1,8 +1,8 @@
|
||||
# Go-Upkeep
|
||||
# uptop
|
||||
|
||||
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`.
|
||||
|
||||
Built on the foundation of [RDGames/go-upkeep](https://github.com/RDGames/go-upkeep).
|
||||
Built on the foundation of [RDGames/uptop](https://github.com/RDGames/uptop).
|
||||
|
||||
## What it does
|
||||
|
||||
@@ -18,14 +18,14 @@ Built on the foundation of [RDGames/go-upkeep](https://github.com/RDGames/go-upk
|
||||
## Quick start
|
||||
|
||||
```bash
|
||||
go run cmd/goupkeep/main.go
|
||||
go run cmd/uptop/main.go
|
||||
ssh -p 23234 localhost
|
||||
```
|
||||
|
||||
Seed some demo data to see it in action:
|
||||
|
||||
```bash
|
||||
go run cmd/goupkeep/main.go -demo
|
||||
go run cmd/uptop/main.go -demo
|
||||
```
|
||||
|
||||
## Install
|
||||
@@ -33,14 +33,14 @@ go run cmd/goupkeep/main.go -demo
|
||||
### From source
|
||||
|
||||
```bash
|
||||
go install gitea.lerkolabs.com/lerko/uptime/cmd/goupkeep@latest
|
||||
go install gitea.lerkolabs.com/lerko/uptime/cmd/uptop@latest
|
||||
```
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
docker pull lerko/go-upkeep:latest
|
||||
docker run -p 23234:23234 -p 8080:8080 -v ./data:/data lerko/go-upkeep
|
||||
docker pull lerko/uptop:latest
|
||||
docker run -p 23234:23234 -p 8080:8080 -v ./data:/data lerko/uptop
|
||||
```
|
||||
|
||||
### Binary
|
||||
@@ -52,15 +52,15 @@ Download from [Releases](https://gitea.lerkolabs.com/lerko/uptime/releases).
|
||||
Export your current monitors:
|
||||
|
||||
```bash
|
||||
goupkeep export -o monitors.yaml
|
||||
uptop export -o monitors.yaml
|
||||
```
|
||||
|
||||
Apply a config file:
|
||||
|
||||
```bash
|
||||
goupkeep apply -f monitors.yaml
|
||||
goupkeep apply -f monitors.yaml --dry-run # see what would change
|
||||
goupkeep apply -f monitors.yaml --prune # delete anything not in the YAML
|
||||
uptop apply -f monitors.yaml
|
||||
uptop apply -f monitors.yaml --dry-run # see what would change
|
||||
uptop apply -f monitors.yaml --prune # delete anything not in the YAML
|
||||
```
|
||||
|
||||
See [docs/config-as-code.md](docs/config-as-code.md) for the full reference.
|
||||
@@ -87,7 +87,7 @@ services:
|
||||
- UPKEEP_CLUSTER_SECRET=change-me
|
||||
```
|
||||
|
||||
First run: attach to the container (`docker attach go-upkeep`), go to the Users tab, add your SSH public key. Then detach with `Ctrl+P, Ctrl+Q` and connect normally over SSH.
|
||||
First run: attach to the container (`docker attach uptop`), go to the Users tab, add your SSH public key. Then detach with `Ctrl+P, Ctrl+Q` and connect normally over SSH.
|
||||
|
||||
## Environment variables
|
||||
|
||||
|
||||
Reference in New Issue
Block a user