Documentation
ΒΆ
Overview ΒΆ
Package yggdrasil holds the embedded assets (built frontend + bundled gameskills). It lives at the module root because go:embed cannot reference paths outside the embedding file's directory.
Index ΒΆ
Constants ΒΆ
This section is empty.
Variables ΒΆ
var DocsFS embed.FS
DocsFS carries the user documentation (getting started, guides, reference) so the Kvasir chat can ground its guidance in the real docs β retrieval happens per question, only excerpts ever reach the model. Design notes in docs/ are deliberately not embedded.
var GameskillsFS embed.FS
GameskillsFS contains the built-in rune (gameskill) definitions, embedded from the builtin-runes/ folder (community runes live in community-runes/ and are imported, not embedded).
var WebFS embed.FS
WebFS contains the built Svelte frontend under web/dist. `all:` ensures dotfiles (e.g. service worker assets) are included.
Functions ΒΆ
This section is empty.
Types ΒΆ
This section is empty.
Directories
ΒΆ
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
apps-gen
command
apps-gen scans every rune (builtin + community), vendors each app's icon from the dashboard-icons collection into website/icons/, and generates the "Supported apps & games" showcase at website/apps.html.
|
apps-gen scans every rune (builtin + community), vendors each app's icon from the dashboard-icons collection into website/icons/, and generates the "Supported apps & games" showcase at website/apps.html. |
|
docs-gen
command
Command docs-gen renders the markdown in docs/ into the static documentation site under website/docs/.
|
Command docs-gen renders the markdown in docs/ into the static documentation site under website/docs/. |
|
yggdrasil
command
Command yggdrasil is the Yggdrasil control plane: a single static binary that serves the web UI + REST/WebSocket API and drives game servers via Docker.
|
Command yggdrasil is the Yggdrasil control plane: a single static binary that serves the web UI + REST/WebSocket API and drives game servers via Docker. |
|
internal
|
|
|
backup
Package backup creates and restores server archives and ships them to storage targets (local/NFS/CIFS mount, SFTP, SMB, S3, GCS, Azure).
|
Package backup creates and restores server archives and ships them to storage targets (local/NFS/CIFS mount, SFTP, SMB, S3, GCS, Azure). |
|
cloudflare
Package cloudflare is a minimal client for the Cloudflare API, used to route a subdomain to a local game/app server through a *remotely-managed* Cloudflare Tunnel.
|
Package cloudflare is a minimal client for the Cloudflare API, used to route a subdomain to a local game/app server through a *remotely-managed* Cloudflare Tunnel. |
|
compose
Package compose translates a docker-compose file into a Yggdrasil rune (gameskill) so an operator can bring a plain docker-compose app into the panel without hand-writing a rune.
|
Package compose translates a docker-compose file into a Yggdrasil rune (gameskill) so an operator can bring a plain docker-compose app into the panel without hand-writing a rune. |
|
crypto
Package crypto provides authenticated symmetric encryption (AES-256-GCM) for secrets stored at rest: backup-target and Steam credentials.
|
Package crypto provides authenticated symmetric encryption (AES-256-GCM) for secrets stored at rest: backup-target and Steam credentials. |
|
docker
Package docker wraps the official Docker Engine SDK with the narrow set of operations Yggdrasil needs: lifecycle, log/console streaming, stats and ephemeral install containers.
|
Package docker wraps the official Docker Engine SDK with the narrow set of operations Yggdrasil needs: lifecycle, log/console streaming, stats and ephemeral install containers. |
|
docskb
Package docskb is a tiny lexical retrieval index over the panel's embedded user documentation, so the Kvasir chat can ground how-to guidance in the real docs.
|
Package docskb is a tiny lexical retrieval index over the panel's embedded user documentation, so the Kvasir chat can ground how-to guidance in the real docs. |
|
firewall
Package firewall blocks individual client IPs at the host level via nftables, for origin traffic that does NOT arrive through a CDN (e.g.
|
Package firewall blocks individual client IPs at the host level via nftables, for origin traffic that does NOT arrive through a CDN (e.g. |
|
llm
Package llm is a small provider-agnostic chat-completion client for Yggdrasil's advisory AI features (e.g.
|
Package llm is a small provider-agnostic chat-completion client for Yggdrasil's advisory AI features (e.g. |
|
migrate
Package migrate moves a whole Yggdrasil panel between hosts as one portable bundle: the database, every server's data directory, and the auth secret_key (without which the encrypted variable secrets β RCON passwords, API keys β would be unrecoverable on the new host).
|
Package migrate moves a whole Yggdrasil panel between hosts as one portable bundle: the database, every server's data directory, and the auth secret_key (without which the encrypted variable secrets β RCON passwords, API keys β would be unrecoverable on the new host). |
|
modrinth
Package modrinth is a small read-only client for the Modrinth API (https://modrinth.com), the mod/plugin index behind Yggdrasil's one-click Minecraft mod manager.
|
Package modrinth is a small read-only client for the Modrinth API (https://modrinth.com), the mod/plugin index behind Yggdrasil's one-click Minecraft mod manager. |
|
notify
Package notify delivers event notifications to Telegram, Discord, or a generic webhook.
|
Package notify delivers event notifications to Telegram, Discord, or a generic webhook. |
|
npm
Package npm is a minimal client for the Nginx Proxy Manager (jc21) API, used to create and remove proxy hosts that route a subdomain to a game/app server's published host port.
|
Package npm is a minimal client for the Nginx Proxy Manager (jc21) API, used to create and remove proxy hosts that route a subdomain to a game/app server's published host port. |
|
panelbackup
Package panelbackup makes and reads an encrypted backup of the panel itself: the database and the one secret in config.yaml that every stored credential is encrypted with.
|
Package panelbackup makes and reads an encrypted backup of the panel itself: the database and the one secret in config.yaml that every stored credential is encrypted with. |
|
query
Package query implements the read-only status protocols Yggdrasil uses to show player counts and liveness on the dashboard: Source A2S (Steam games), Minecraft Java Server List Ping, and Minecraft Bedrock unconnected ping.
|
Package query implements the read-only status protocols Yggdrasil uses to show player counts and liveness on the dashboard: Source A2S (Steam games), Minecraft Java Server List Ping, and Minecraft Bedrock unconnected ping. |
|
rbac
Package rbac implements Yggdrasil's scoped permission model: a user may be granted a set of permissions at a scope (global, a realm, a game type, or a single server).
|
Package rbac implements Yggdrasil's scoped permission model: a user may be granted a set of permissions at a scope (global, a realm, a game type, or a single server). |
|
rcon
Package rcon provides remote-console clients for the protocols Yggdrasil's gameskills use: Source RCON (Minecraft Java and Source games), Rust WebSocket RCON, and BattlEye BERcon (DayZ).
|
Package rcon provides remote-console clients for the protocols Yggdrasil's gameskills use: Source RCON (Minecraft Java and Source games), Rust WebSocket RCON, and BattlEye BERcon (DayZ). |
|
scheduler
Package scheduler renders message templates and defines the schedule action model.
|
Package scheduler renders message templates and defines the schedule action model. |
|
totp
Package totp implements RFC 6238 time-based one-time passwords (TOTP) with HMAC-SHA1, a 30-second step, and 6 digits β compatible with Google Authenticator, Authy, etc.
|
Package totp implements RFC 6238 time-based one-time passwords (TOTP) with HMAC-SHA1, a 30-second step, and 6 digits β compatible with Google Authenticator, Authy, etc. |
|
unifi
Package unifi is a minimal client for the UniFi OS local API (UDM / Cloud Key Gen2+ / UDR), used to create and remove WAN port-forward rules for game servers.
|
Package unifi is a minimal client for the UniFi OS local API (UDM / Cloud Key Gen2+ / UDR), used to create and remove WAN port-forward rules for game servers. |
|
upnp
Package upnp adds/removes router port mappings via UPnP-IGD, so game servers can be reachable from the internet without manual port forwarding.
|
Package upnp adds/removes router port mappings via UPnP-IGD, so game servers can be reachable from the internet without manual port forwarding. |
|
wpress
Package wpress reads All-in-One WP Migration archives (.wpress) β the format most WordPress admins actually hold their site in.
|
Package wpress reads All-in-One WP Migration archives (.wpress) β the format most WordPress admins actually hold their site in. |











