Guides

These docs are organized by what you are trying to do, not by protocol or source-code module names.

If you are new, start with Getting Started. If the service is already running, jump to the section that matches your role.

First Run

If you just want to get the service running, read:

• Getting Started: start the backend, create the first admin, and verify metadata, profiles, and texture paths
• Deployment Overview: launch checks for public URLs, reverse proxy, persistence, backups, and validation
• Docker Deployment: production deployment, HTTPS, persistence, and reverse proxy setup
• Config and Keys: public URLs, skinDomains, upload policy, and signing keys

Player Usage

Once the service opens, normal users should start here:

• User Guide: accounts, Minecraft profiles, skins/capes, launcher login, and common issues
• Minecraft Profiles: profile names, UUIDs, renames, deletion, and admin inspection
• Textures: wardrobe, profile binding, direct upload, PNG validation, and public reads
• FAQ: short answers to common questions

Launcher and Server Integration

For authlib-injector, launchers, or Minecraft servers, read:

• Launcher Setup: what address, account identifier, and javaagent parameter to use
• Launcher Login: authenticate, refresh, selectedProfile, token lifecycle, and join/hasJoined
• Yggdrasil Forwarding: point the server at AY and forward Yggdrasil-compatible site, Mojang, or other upstream session checks by priority
• Yggdrasil API: ALI, metadata, authserver, sessionserver, profile lookup, texture API, and protocol errors
• Textures: texture property URLs, skinDomains, signatures, and caching concerns
• Troubleshooting: launcher login, server join, skin display, signature verification, and texture 404s

Administrator Maintenance

Administrators need to keep three layers separate: startup config, runtime config, and externally visible protocol behavior.

• Admin Guide: users, profiles, textures, config, audit logs, and tasks
• Capability Bans: restrict user access to Yggdrasil, profiles, texture upload, and public texture library interactions by scope
• Config and Keys: config.toml, system_config, public URLs, and signing key rotation
• Object Storage: local/S3/MinIO backends, storage paths, public URLs, and consistency checks
• Audit and Tasks: audit coverage, runtime tasks, primary/follower mode, and maintenance guidance
• Deployment Overview and Docker Deployment: persistent data, reverse proxy, trusted proxies, multiple instances, and backups

Project Reference

For project scope, fit, and current limits, read About AsterYggdrasil.

Before editing the docs, read Docs Contributing. These docs are for real deployers, players, and server owners, not a prose version of the source tree.