From 9fdd6ac9a129613cfb4829d6a81d2557370db792 Mon Sep 17 00:00:00 2001 From: Haitao Pan Date: Wed, 4 Feb 2026 18:30:09 +0800 Subject: [PATCH] docs: clarify agent install endpoint behavior and add clawdbot SSH example --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7a53763..0f24124 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,32 @@ To install observability agents (Node Exporter, Process Exporter, Vector) on a c curl -fsSL https://raw.githubusercontent.com/cloud-neutral-toolkit/observability.svc.plus/main/scripts/agent-install.sh \ | bash -s -- --endpoint https://observability.svc.plus/ingest/otlp ``` -> **Note**: The script automatically verifies the installation after setup. +> **Note** +> - `--endpoint` supports both: +> - `https://observability.svc.plus` +> - `https://observability.svc.plus/ingest/otlp` +> - The installer auto-derives: +> - metrics endpoint: `/ingest/metrics/api/v1/write` +> - logs endpoint: `/ingest/logs/insert` +> - The script automatically verifies installation after setup. + +### Install on a remote host (example: clawdbot.svc.plus) + +```bash +ssh root@clawdbot.svc.plus \ + 'curl -fsSL https://raw.githubusercontent.com/cloud-neutral-toolkit/observability.svc.plus/main/scripts/agent-install.sh \ + | bash -s -- --endpoint https://observability.svc.plus/ingest/otlp' +``` + +### Optional SSH manager env example + +```bash +SSH_SERVER_CLAWBOT_HOST=clawdbot.svc.plus +SSH_SERVER_CLAWBOT_USER=root +SSH_SERVER_CLAWBOT_KEYPATH=~/.ssh/id_rsa +SSH_SERVER_CLAWBOT_PORT=22 +SSH_SERVER_CLAWBOT_DESCRIPTION=clawdbot_server +``` ## Features @@ -146,12 +171,6 @@ curl -fsSL https://raw.githubusercontent.com/cloud-neutral-toolkit/observability > [**Single-Node Setup**](https://svc.plus/docs/setup/install) | [**Production Deploy**](https://svc.plus/docs/deploy) | [**Offline Install**](https://svc.plus/docs/setup/offline) | [**Minimal Install**](https://svc.plus/docs/setup/slim) | [**Docker Install**](https://svc.plus/docs/setup/docker) | [**Run Supabase**](https://svc.plus/docs/app/supabase) - - - - - - Integrated as a platform. [![INFRA](https://img.shields.io/badge/INFRA-%23009639?style=flat&logo=nginx&labelColor=009639&logoColor=white)](https://svc.plus/docs/infra) Nginx, Local Repo, DNSMasq, and the entire Victoria & Grafana observability stack.