Capture

An open source hardware monitoring agent

Capture is a hardware monitoring agent that collects hardware information from the host machine and exposes it through a RESTful API. The agent is designed to be lightweight and easy to use.

Quick Start (Docker)

docker run -d \
    -v /etc/os-release:/etc/os-release:ro \
    -p 59232:59232 \
    -e API_SECRET=your-secret-key \
    ghcr.io/bluewave-labs/capture:latest

Configuration

Variable	Description	Default	Required
API_SECRET	Authentication key (Must match the secret you enter on Checkmate)	-	Yes
PORT	Server port number	59232	No
GIN_MODE	Gin(web framework) mode. Debug is for development	release	No

Example configurations:

# Minimal
API_SECRET=your-secret-key ./capture

# Complete
API_SECRET=your-secret-key PORT=59232 GIN_MODE=release ./capture

Installation Options

Docker (Recommended)

Pull and run the official image:

docker run -d \
    -v /etc/os-release:/etc/os-release:ro \
    -p 59232:59232 \
    -e API_SECRET=your-secret-key \
    ghcr.io/bluewave-labs/capture:latest

Or build locally:

docker buildx build -t capture .
docker run -d -v /etc/os-release:/etc/os-release:ro -p 59232:59232 -e API_SECRET=your-secret-key capture

Docker options explained:

• -v /etc/os-release:/etc/os-release:ro: Platform detection
• -p 59232:59232: Port mapping
• -e API_SECRET: Required authentication key
• -d: Detached mode

System Installation

Choose one of these methods:

1. Pre-built Binaries: Download from GitHub Releases

2. Go Package:

   go install github.com/bluewave-labs/capture/cmd/capture@latest

3. Build from Source:

   git clone git@github.com:bluewave-labs/capture
   cd capture
   just build   # or: go build -o dist/capture ./cmd/capture/

API Documentation

Our API is documented in accordance with the OpenAPI spec.

You can find the OpenAPI specifications here

Contributing

We welcome contributions! If you would like to contribute, please read the CONTRIBUTING.md file for more information.

Star History

License

Capture is licensed under AGPLv3. You can find the license here