Skip to content

quickstart.md

Latest commit

 

History

History
107 lines (80 loc) · 2.13 KB

quickstart.md

File metadata and controls

107 lines (80 loc) · 2.13 KB

Quick Start

Get SatGate running in under 2 minutes.

1. Download

# macOS (Apple Silicon)
curl -L https://github.com/SatGate-io/satgate/releases/latest/download/satgate-darwin-arm64 -o satgate

# macOS (Intel)
curl -L https://github.com/SatGate-io/satgate/releases/latest/download/satgate-darwin-amd64 -o satgate

# Linux (x86_64)
curl -L https://github.com/SatGate-io/satgate/releases/latest/download/satgate-linux-amd64 -o satgate

chmod +x satgate

Or build from source:

git clone https://github.com/SatGate-io/satgate.git
cd satgate
go build -o satgate ./cmd/satgate/

2. Configure

Create gateway.yaml:

version: 1

server:
  listen: ":8080"

admin:
  token: "my-admin-token"

lightning:
  provider: mock

upstreams:
  httpbin:
    url: "https://httpbin.org"

routes:
  - name: public-health
    match:
      pathPrefix: /health
    upstream: httpbin
    policy:
      kind: public

  - name: protected-api
    match:
      pathPrefix: /api
    upstream: httpbin
    policy:
      kind: capability

  - name: paid-endpoint
    match:
      pathPrefix: /premium
    upstream: httpbin
    policy:
      kind: l402
      priceSats: 10

3. Run

export ADMIN_TOKEN=my-admin-token
./satgate --config gateway.yaml

SatGate starts on port 8080.

4. Test

# Public route — no auth needed
curl http://localhost:8080/health

# Mint a capability token
TOKEN=$(curl -s -X POST http://localhost:8080/api/capability/mint \
  -H "Authorization: Bearer my-admin-token" \
  -H "Content-Type: application/json" \
  -d '{}' | jq -r '.token')

# Use the token on a protected route
curl http://localhost:8080/api/anything \
  -H "Authorization: Bearer $TOKEN"

# L402 route — returns 402 Payment Required with Lightning invoice
curl -i http://localhost:8080/premium/anything

Next Steps