This repository was archived by the owner on Aug 6, 2026. It is now read-only.
docs: ship asobi_admin as a self-host console + deployment-mode honesty - #2
Merged
Conversation
Adds the README that makes asobi_admin usable by self-hosters, and a deployment-mode signal so live-plane figures never silently lie. - README documents the two endpoint classes (data-plane works from any node sharing the DB; live-plane - presence, matchmaker, system stats - reads local node state), and leads with the same-release deployment as the supported way to get the full console. Auth (ASOBI_ADMIN_TOKEN, ws in-protocol auth) and the RELEASE_COOKIE requirement are documented. - asobi_admin_runtime exposes deployment_mode (embedded|standalone, env ASOBI_ADMIN_DEPLOYMENT_MODE, safe default standalone). /dashboard and /system now return deployment_mode + live_plane_authoritative so a consumer can tell whether online counts / matchmaker / VM stats reflect the real game runtime or the console's own idle node. The managed per-environment console that runs out-of-process (option C) stays deferred: it needs asobi to expose presence/matchmaker snapshots on its public API first. This ships the self-host path (option D) honestly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Makes asobi_admin usable and deployable by self-hosters (the engine guardian's "option D"), and closes the guardian's core concern that live-plane endpoints could silently report wrong data.
README
Documents what the console is and, crucially, where to run it:
/systemBEAM stats) reads local node state - only correct when asobi_admin runs in the same release as the asobi backend.Leads with the same-release deployment (full functionality), documents auth (
ASOBI_ADMIN_TOKEN, websocket in-protocol auth,RELEASE_COOKIE), and enumerates the API.Deployment-mode honesty
New
asobi_admin_runtime:deployment_mode(embedded|standalone, envASOBI_ADMIN_DEPLOYMENT_MODE, safe defaultstandalone)./admin/api/dashboardand/admin/api/systemnow returndeployment_mode+live_plane_authoritative, so a consumer can tell whether an online count of zero is real or just means the console isn't co-located with the runtime. No more silently-wrong live figures.Deferred (not this PR)
The managed, per-environment console that runs out-of-process (option C) needs asobi to expose presence/matchmaker snapshots on its public API first (so the live-plane can be read remotely without clustering). That's the asobi-architecture-guardian's prerequisite list; this PR ships the self-host path honestly in the meantime. No web UI yet - noted as a possible follow-up.
Testing
26 eunit (incl. 6 new runtime-mode tests), fmt/xref/dialyzer clean, eqwalize NO ERRORS on the touched modules.