Skip to content
LinkPeek Documentation

LinkPeek Documentation

Everything you need to stand up LinkPeek and master every lab.
Start the setup guide Explore the LinkPeek repo

Where to begin

Section titled “Where to begin”

Install LinkPeek

Work through prerequisites, environment configuration, and first login in the installation overview.

Pick a deployment path

Compare the single-container image and full Docker Compose stack in deployment options.

Learn each lab

Review workflows, payload formats, and exports for every module in the labs overview.

Integrate with automation

Call the HTTP APIs and realtime topics documented in API reference.

Resolve incidents fast

Troubleshoot tunnel health, auth lockouts, and payload limits in the support section.

LinkPeek at a glance

Section titled “LinkPeek at a glance”
  • Unified traffic debugging dashboard for capture, payload, retry, scanner, tunnel, and realtime labs.
  • Pure Go backend with WebSocket hub; deployable via Docker image or full Compose stack.
  • Authenticated UI and APIs with rate limiting, audit trails, and export tools for incident response.
  • Documentation authored in English only to keep the product and knowledge base consistent.