graham/towerops-agent
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

remove TOWEROPS_API_URL from public docs and fix outdated references

Browse source 
remove API URL from docker-compose example, config table, and
troubleshooting. update language references from Rust to Go.
This commit is contained in:
Graham McIntire 2026-03-17 16:12:47 -05:00
parent 49fd0d8457
commit 1be6392e24
No known key found for this signature in database
1 changed files with 5 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -1,6 +1,6 @@
# Towerops Agent # Towerops Agent
A lightweight Rust-based remote polling agent for Towerops SNMP monitoring. A lightweight remote polling agent for Towerops network monitoring.
## Overview ## Overview
@ -14,7 +14,7 @@ The Towerops agent enables customers to deploy SNMP polling infrastructure on th
- **Real-time Updates**: Server pushes configuration changes instantly via persistent WebSocket connection - **Real-time Updates**: Server pushes configuration changes instantly via persistent WebSocket connection
- **Automatic Reconnection**: Exponential backoff reconnection on network failures - **Automatic Reconnection**: Exponential backoff reconnection on network failures
- **Automatic Updates**: Checks for new versions hourly and self-updates when available (requires Docker socket access) - **Automatic Updates**: Checks for new versions hourly and self-updates when available (requires Docker socket access)
- **Low Resource Usage**: Built in Rust for minimal memory and CPU footprint (< 256 MB RAM typical) - **Low Resource Usage**: Minimal memory and CPU footprint (< 256 MB RAM typical)
- **Docker Ready**: Pre-built Docker images for easy deployment - **Docker Ready**: Pre-built Docker images for easy deployment
## Quick Start ## Quick Start
@ -39,7 +39,6 @@ services:
image: ghcr.io/towerops-app/towerops-agent:latest image: ghcr.io/towerops-app/towerops-agent:latest
restart: unless-stopped restart: unless-stopped
environment: environment:
- TOWEROPS_API_URL=https://towerops.net
- TOWEROPS_AGENT_TOKEN=your-agent-token-here - TOWEROPS_AGENT_TOKEN=your-agent-token-here
- LOG_LEVEL=info - LOG_LEVEL=info
# Optional: Enable SNMP trap listener # Optional: Enable SNMP trap listener
@ -62,7 +61,6 @@ The agent is configured via environment variables:
| Variable | Description | Default | | Variable | Description | Default |
|----------|-------------|---------| |----------|-------------|---------|
| `TOWEROPS_API_URL` | Towerops API endpoint | Required |
| `TOWEROPS_AGENT_TOKEN` | Agent authentication token | Required | | `TOWEROPS_AGENT_TOKEN` | Agent authentication token | Required |
| `LOG_LEVEL` | Logging level (error, warn, info, debug) | info | | `LOG_LEVEL` | Logging level (error, warn, info, debug) | info |
| `TRAP_ENABLED` | Enable SNMP trap listener | false | | `TRAP_ENABLED` | Enable SNMP trap listener | false |
@ -104,16 +102,14 @@ When enabled (`TRAP_ENABLED=true`), the agent listens for SNMP traps:
### Prerequisites ### Prerequisites
- Rust 1.91 or later - Go 1.25 or later
### Build ### Build
```bash ```bash
cargo build --release go build -o towerops-agent .
``` ```
The binary will be in `target/release/towerops-agent`.
### Docker Build ### Docker Build
```bash ```bash
@ -124,9 +120,8 @@ docker build -t towerops-agent .
### Agent Not Connecting ### Agent Not Connecting
- Verify the API URL is correct (accepts http://, https://, ws://, or wss://) - Verify network connectivity to the Towerops API
- Check that the agent token is valid and hasn't been revoked - Check that the agent token is valid and hasn't been revoked
- Ensure network connectivity to the Towerops API
- Check logs for connection errors: `docker logs towerops-agent` - Check logs for connection errors: `docker logs towerops-agent`
### No Metrics Appearing ### No Metrics Appearing