ShieldGate Docs

Get started

Prerequisites

Tools and services you need before a local or container install.

Goal

Confirm your machine has everything required to run ShieldGate locally.

Prerequisites checklist

Requirement Notes
.NET 10 SDK Build and dotnet run all hosts
PostgreSQL 16+ Control-plane database
Redis (recommended) Config sync, rate limits, bans; local in-memory works with Redis:Enabled=false (single node)
Git Clone the repository
Docker (optional) Use Compose instead of installing Postgres/Redis yourself

Useful ports (local defaults)

Service HTTPS HTTP
API 7279 —
Admin Web 7280 —
Marketing 7281 5301
Docs (this site) 7282 5302
Proxy see launchSettings / Compose Compose often 8081

Tips

  • Keep a password manager entry for the seed admin (default is for dev only).
  • For GeoIP later, you will need MaxMind .mmdb files; missing DBs fail open.
  • ACME HTTP-01 needs the Worker and a Proxy reachable on the challenge path.

Verify

dotnet --version
# expect 10.x

PostgreSQL and Redis should accept connections on the hosts/ports you will put in appsettings or .env.

Next