跳到内容

AsterYggdrasil官方文档中心

自建 Minecraft 皮肤站与 Yggdrasil/authlib-injector 认证服务器,从本地跑通到真实启动器接入都按一条路径讲清楚。

先认识它

AsterYggdrasil 是自托管的 Minecraft 皮肤站和 Yggdrasil/authlib-injector 认证服务器。它让站点账号、Minecraft profile、skin/cape 材质、启动器登录和服务端进服验证由部署者自己的服务承载。

当前代码已经包含账号认证、外部认证、图形验证码、Minecraft profile、wardrobe 材质库、公共材质库、Yggdrasil 协议端点、材质处理、运行时配置、审计日志和后台维护任务。文档会按这些已经存在的能力写,不把还没落地的路线图写成用户能直接使用的功能。

按目的走

我只是想先跑起来

快速开始 走一遍。它会带你启动后端、创建第一个管理员、确认 /api/yggdrasil metadata、创建 profile,并验证材质上传和公开读取路径。

准备正式上线时,再看 部署总览Docker 部署。生产环境常见问题集中在公开 URL、反向代理响应头、签名公钥缓存和 object storage 备份,建议逐项确认。

我是玩家,想知道怎么用

使用指南 进入。普通用户优先看 用户手册,里面按账号登录、创建 Minecraft profile、管理皮肤/披风、启动器登录和常见问题组织。

如果只关心角色名、UUID、改名或删除,直接看 玩家档案。如果只关心皮肤和披风,看 材质处理

我要接启动器或服务器

先看 启动器填写,再看 启动器登录Yggdrasil API。启动器通常需要协议根路径:

text
https://你的域名/api/yggdrasil

支持 API Location Indication 的启动器也可以填写站点根地址。站点首页会返回:

text
X-Authlib-Injector-API-Location: /api/yggdrasil/

我要管理一个实例

先看 管理员指南配置和密钥,确认 public_site_urlyggdrasil_public_base_urlyggdrasil_texture_public_base_urlyggdrasil_skin_domains 和签名密钥轮换。再看 审计与后台任务,了解 token 清理、材质一致性检查和管理员审计。

遇到启动器登录、进服、皮肤显示或验签问题,直接看 故障排查。短问题看 常见问题速查

材质和上传头像保存位置看 对象存储。当前可用 object storage backend 是 local、S3 和 MinIO;S3/MinIO 使用服务端 streaming 上传,不提供 presigned 上传。

我准备改文档

先看 文档贡献说明。这份文档给真实用户看,不是给源码模块做目录索引。新增页面前先问一句:读者打开这页是为了完成什么任务?

当前边界

  • Minecraft profile name 支持受控改名,必须走用户或管理员 API;不要直接改数据库。
  • 删除 profile 会处理材质绑定、引用计数、相关 Yggdrasil token 和审计记录。
  • Yggdrasil 协议端点返回协议格式;站点和管理 API 才返回 { "code": "success", "msg": "", "data": ... }
  • 当前可用对象存储后端是 local、S3 和 MinIO。材质和上传头像都会走同一个 object storage backend;S3/MinIO 只支持服务端 streaming 上传。
  • 产品前端已经覆盖核心账号、profile、wardrobe、公共材质库和管理后台流程,但当前版本仍是 alpha;公开上线前请按自己的部署场景做完整回归。

Released under the MIT License.