Getting started

Quick ways to run BeaconAuth locally or in production.

Using Docker (recommended)

# Pull the latest image
docker pull ghcr.io/summpot/beacon_auth:latest

# Run the server
docker run -d --name beaconauth \
  -p 8080:8080 \
  -v $(pwd)/data:/app/data \
  -e DATABASE_URL=sqlite:///app/data/beacon_auth.db \
  ghcr.io/summpot/beacon_auth:latest

The server will be available at http://localhost:8080.

Using pre-built binaries

Download the server archive for your operating system and CPU from the official project release page, then extract it locally.

Linux / macOS:

tar -xzf beaconauth-<platform>.tar.gz
chmod +x beacon
./beacon serve

Windows (amd64):

# Download and extract the zip file
# Run in PowerShell:
.\beacon.exe serve

Building from source

Prerequisites

Rust (stable)
Node.js (LTS)
pnpm

Build steps

# Clone the repository
git clone https://github.com/Summpot/beacon_auth.git
cd beacon_auth

# Install frontend dependencies
pnpm install

# Build the Rust workspace
cargo build --workspace --release

The binary will be at target/release/beacon.

On this page

Using Docker (recommended)Using pre-built binaries Building from source Prerequisites Build steps