Skip to content

Summpot/BeaconAuth

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

240 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BeaconAuth

BeaconAuth is an authentication platform for Minecraft communities. It combines a Rust auth server, a React web UI, and a multi-loader Minecraft mod so servers can require secure web, OAuth, or passkey login before players enter the game.

Build Release Ask DeepWiki

What It Provides

  • ES256 JWT authentication with JWKS distribution for game-server verification.
  • Web UI for registration, login, profile management, OAuth completion, and passkeys.
  • OAuth provider support for GitHub, Google, and Microsoft.
  • Minecraft login flow with PKCE and signed token verification.
  • Server deployment as a native binary, Docker image, or Cloudflare Worker.
  • Localized web and in-game text across the supported languages in this repository.

Repository Layout

  • crates/: Rust server, shared auth logic, database entities, migrations, and serverless runtimes.
  • src/: React web UI and app routes.
  • content/docs/: Fumadocs documentation.
  • messages/: Paraglide localization files for the web UI.
  • modSrc/: Architectury-based Minecraft mod for Fabric, Forge, and NeoForge.

Quick Start

The published container image runs the beacon server and listens on port 8080.

docker run --rm -p 8080:8080 \
  -e BIND_ADDRESS=0.0.0.0:8080 \
  -e BASE_URL=http://localhost:8080 \
  -e DATABASE_URL=sqlite:///app/data/beacon_auth.db?mode=rwc \
  -v beaconauth-data:/app/data \
  ghcr.io/summpot/beaconauth:latest

After startup:

  • Web UI: http://localhost:8080/
  • JWKS endpoint: http://localhost:8080/.well-known/jwks.json

Minecraft Mod

BeaconAuth ships a companion mod that connects Minecraft clients and servers to the auth server. The mod is intended to be installed on both the server and clients that need to complete the in-game login flow.

Supported build targets:

Minecraft Loader
1.20.1 Fabric, Forge
1.21.1 Fabric, NeoForge
1.21.8 Fabric, NeoForge

Release jars are produced by the modSrc Gradle build and by the Mod GitHub Actions workflow. See the mod installation guide for file selection, installation, and server configuration.

Documentation

Documentation is maintained in Fumadocs under content/docs.

Local Development

Requirements:

  • Java 21 for the Minecraft mod build.
  • Rust stable for the server crates.
  • Node.js and pnpm for the web UI and docs.

The web app and docs use Vite:

pnpm install
pnpm dev

Rust server validation:

cargo check --all-targets
cargo build -p beacon-worker --target wasm32-unknown-unknown

Minecraft mod validation:

cd modSrc
./gradlew build

Support

License

MIT. See LICENSE.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors