Ramkin Docs
Sign In
Quickstart

Quickstart

Deploy the collector

The Ramkin collector is a lightweight binary that captures metadata from your API traffic.

Prerequisites

  • Linux or macOS environment
  • Network access to your API traffic
  • Root or sudo access (optional, depending on deployment)

Installation

curl -fsSL https://get.ramkin.net/install.sh | sh

Configuration

Create a ramkin.yaml configuration file:

api_key: "your-api-key"
endpoint: "https://api.ramkin.net"

Start the collector

ramkin start --config ramkin.yaml

Your endpoints will begin appearing in the Ramkin dashboard within minutes.

Platform