Installation Overview

LinkPeek ships as a complete traffic debugging environment that spans capture hooks, payload mutation labs, retry scenarios, scanner jobs, tunnel monitoring, and realtime telemetry. Before you launch the stack you should align on the following fundamentals:

Prerequisites

• Infrastructure basics: Docker 24+, Docker Compose 2.20+, and a TLS-enabled reverse proxy if you expose LinkPeek outside your LAN.
• Access policy: Decide which operators need dashboard access and how you will rotate the shared admin credential after the first login.
• Storage layout: Provision a persistent volume or host directory for DATA_DIR to store payload artefacts, capture transcripts, and audit logs.
• Optional integrations: Gather secrets for DB-IP lookups, SMTP delivery, or webhook relays if you plan to enable them during the initial rollout.

Components in the stack

Service	Purpose	Notes
linkpeek (Go app)	Renders the UI, serves APIs, manages WebSocket hub	Exposes port 9009 by default; requires the admin credential.
postgres	Persists metadata, payloads, and session caches	Optional in simple demos but required for production workloads.
cloudflared	Provides Quick Tunnel exposure for remote preview bots	Needs Docker socket access to support restart automation.
pagefind (docs)	Powers the built-in documentation search	Bundled automatically with this site when deployed.

First-run checklist

1. Clone or pull the Abbas-Hoseiny/linkpeek repository to a secure location.
2. Copy .env.example to .env and adjust the admin password, DATA_DIR, and any rate-limit thresholds.
3. Allocate DNS or a Cloudflare Tunnel hostname that operators can reach.
4. Run the target deployment workflow (Docker image or Compose stack) and watch docker logs for startup confirmation.
5. Log in via https://<host>:9009/login, rotate the default credential, and invite teammates to review the dashboard layout.

Continue with the quickstart checklist to validate the labs end to end.