Skip to main content

Installation

Docker Compose stack​

The default stack includes:

  • backend on port 5656
  • frontend on port 5050
  • postgres on host port 5434
  • redis on host port 8946

Current build/runtime status:

  • backend image is built from the Go 1.26 codebase
  • frontend image builds the Angular 21.1 app and serves the static output via nginx

Rotating proxy listener ports are also mapped by default:

  • TCP: 20000-20100
  • UDP: 20000-20100

Required secrets/config​

Set these before starting Magpie:

  • PROXY_ENCRYPTION_KEY
  • JWT_SECRET

Optional DB overrides:

  • DB_USERNAME
  • DB_PASSWORD
  • DB_NAME

If omitted, Docker Compose uses built-in DB defaults. Installer scripts auto-generate strong DB credentials.

Why it matters:

  • It encrypts stored proxy secrets (auth, passwords, and encrypted IP fields).
  • Changing it later prevents old encrypted values from being decrypted.

Local clone workflow​

git clone https://github.com/Kuucheen/magpie.git
cd magpie
cp .env.example .env
# edit .env and set PROXY_ENCRYPTION_KEY and JWT_SECRET
# optional: override DB_USERNAME/DB_PASSWORD/DB_NAME
docker compose up -d

Installer script notes​

Install scripts support environment overrides such as:

  • MAGPIE_INSTALL_DIR
  • MAGPIE_IMAGE_TAG
  • MAGPIE_REPO_OWNER
  • MAGPIE_REPO_NAME
  • MAGPIE_REPO_REF

See Deployment and Environment Variables.