Skip to main content

Quick Start

Prerequisites​

  • Docker Desktop, or Docker Engine + Compose
  • Internet access to pull container images

macOS/Linux​

curl -fsSL https://raw.githubusercontent.com/Kuucheen/magpie/refs/heads/master/scripts/install.sh | bash

Windows (PowerShell)​

iwr -useb https://raw.githubusercontent.com/Kuucheen/magpie/refs/heads/master/scripts/install.ps1 | iex

Manual install​

git clone https://github.com/Kuucheen/magpie.git
cd magpie
cp .env.example .env
# set PROXY_ENCRYPTION_KEY in .env
docker compose up -d

Access URLs​

  • UI: http://localhost:5050
  • API base: http://localhost:5656/api

First account behavior​

By default, the first registered user is auto-assigned the admin role.

In production-oriented deployments, public registration is often restricted; see First Login for controlled bootstrap options.