@hivemagnus/magnus-ui 0.0.0-stage → 1.0.2

package/.env.example

@@ -0,0 +1,103 @@
+# Magnus UI environment example.
+# Copy to a private file (for example /etc/magnus-ui/magnus-ui.env, mode 0600),
+# fill in the values, then run `magnus-ui check --env-file <file>`.
+# `magnus-ui env-schema` prints every supported variable.
+
+# ── Required ─────────────────────────────────────────────────────────────────
+
+# Magnus Control API (magnus-server) reached server-side by the UI.
+CONTROL_API_URL=https://magnus-api.example.com:4000
+# Must match API_SECRET on the Control API. Never expose it via NEXT_PUBLIC_*.
+API_SECRET=change-me-api-secret
+# Dashboard-only session signing secret (32+ random characters). Do not reuse API_SECRET.
+SESSION_SECRET=change-me-dashboard-only-random-secret
+# Dedicated 32+ character key for encrypted control-node credentials at rest.
+CONTROL_NODE_CREDENTIAL_KEY=change-me-control-node-storage-key
+# Redis for durable login throttling (login fails closed without it).
+REDIS_URL=redis://127.0.0.1:6379
+# Canonical browser origin of this UI.
+DASHBOARD_PUBLIC_ORIGIN=https://magnus.example.com
+
+# Administrator login. Generate the Argon2id verifier with:
+#   node --input-type=module -e "import argon2 from 'argon2'; console.log(await argon2.hash(process.env.PASSWORD,{type:argon2.argon2id}))"
+DASHBOARD_ADMIN_USERNAME=admin
+DASHBOARD_ADMIN_PASSWORD_HASH='$argon2id$v=19$m=65536,t=3,p=1$replace-me'
+
+# ── Server ───────────────────────────────────────────────────────────────────
+
+# Listen address and port for `magnus-ui start`.
+# HOST=0.0.0.0
+# PORT=3000
+# TLS certificate and key. Required unless MAGNUS_UI_ALLOW_HTTP=true.
+TLS_CERT_PATH=/etc/magnus-ui/tls/server.crt
+TLS_KEY_PATH=/etc/magnus-ui/tls/server.key
+# Serve plain HTTP (local development, or behind a TLS-terminating proxy only).
+# MAGNUS_UI_ALLOW_HTTP=false
+# Directory for runtime state (.magnus/, terminal-audit/). Defaults to the
+# directory `magnus-ui start` runs in.
+# MAGNUS_UI_DATA_DIR=/var/lib/magnus-ui
+# Authentication audit log (login fails closed if it cannot be written).
+# UI_SECURITY_LOG_PATH=/var/lib/magnus-ui/.magnus/security-events.jsonl
+# Optional private CA bundle for the Control API certificate.
+# CONTROL_API_CA_PATH=/etc/magnus-ui/control-api-ca.pem
+
+# ── Optional integrations (off unless configured) ────────────────────────────
+
+# External security console: shows the Security nav entry and links to it.
+# MAGNUS_SECURITY_CONSOLE_URL=https://security.example.com
+
+# Hive Router admin plane, embedded through /api/hive-router/dashboard.
+# HIVE_ROUTER_ADMIN_URL=https://router.example.com
+# HIVE_ROUTER_CA_PATH=/etc/magnus-ui/hive-router-ca.pem
+
+# Hive IAM named login (OIDC). All of these plus DASHBOARD_PUBLIC_ORIGIN are required.
+# HIVE_OAUTH_DISCOVERY_URL=https://iam.example.com/.well-known/openid-configuration
+# HIVE_OAUTH_CLIENT_ID=magnus-ui
+# HIVE_OAUTH_CLIENT_SECRET=
+# HIVE_OAUTH_ISSUER=https://iam.example.com
+# HIVE_OAUTH_API_AUDIENCE=magnus-api
+# HIVE_OAUTH_SCOPE=openid profile email
+
+# Hermes Agent pages, dashboard proxy and WebSocket bridge.
+# MAGNUS_HERMES_ENABLED=false
+# Reviewed installation/node/address/SSH host-key bindings for the Hermes proxy.
+# HERMES_SSH_AUTHORIZATIONS_FILE=.magnus/hermes-ssh-authorizations.json
+# Additional browser origins allowed to open the Hermes WebSocket bridge.
+# HERMES_WEBSOCKET_ALLOWED_ORIGINS=https://magnus-backup.example.com
+# Optional network allowlist for Hermes SSH targets (exact /32 or narrow subnets).
+# HERMES_SSH_ALLOWED_CIDRS=192.0.2.10/32,10.0.0.0/24
+
+# Dedicated unprivileged SSH identity for the terminal and Hermes proxy.
+# DASHBOARD_SSH_USERNAME=magnus-proxy
+# DASHBOARD_SSH_PRIVATE_KEY_PATH=/etc/magnus-ui/dashboard_proxy_ed25519
+
+# ── Advanced ─────────────────────────────────────────────────────────────────
+
+# SESSION_ISSUER=magnus-dashboard
+# SESSION_AUDIENCE=magnus-dashboard-session
+# REDIS_PREFIX=magnus-
+# AUTH_RATE_LIMIT_LABEL_KEY=
+# CONTROL_API_MAX_RESPONSE_BYTES=1048576
+# Maximum proxy request body size, including chunked uploads.
+# DASHBOARD_PROXY_BODY_LIMIT_BYTES=1048576
+# Change to invalidate all existing local sessions without rotating secrets.
+# LOCAL_SESSION_GENERATION=
+# Server-only resource enrollment participant credential (32+ characters); must
+# match the Control API. Never set it via NEXT_PUBLIC_*.
+# RESOURCE_ENROLLMENT_DASHBOARD_SECRET=
+# Password for the dashboard SSH identity; a restricted key is preferred.
+# DASHBOARD_SSH_PASSWORD=
+
+# ── Legacy and serializer-managed (prefer the settings above) ───────────────
+
+# Base64 forms of the administrator credentials, written by deployment tooling.
+# DASHBOARD_ADMIN_USERNAME_B64=
+# DASHBOARD_ADMIN_PASSWORD_HASH_B64=
+# DASHBOARD_ADMIN_CREDENTIAL_METADATA_B64=
+# Former dashboard login, accepted only while migrating to DASHBOARD_ADMIN_*.
+# DASHBOARD_LOGIN_USERNAME=
+# DASHBOARD_LOGIN_PASSWORD=
+# Expired opt-in that reused JWT_SECRET for sessions; leave false.
+# ALLOW_LEGACY_SESSION_SECRET=false
+# Build-time Control API URL; never put a secret in it.
+# NEXT_PUBLIC_API_URL=https://magnus-api.example.com:4000

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,181 @@
-# Temporary Holding Version
+# Magnus UI
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`@hivemagnus/magnus-ui` is the web console for the [Magnus](https://github.com/ChefTaco/magnus)
+fleet control plane. It shows fleet and node inventory, runs commands, browses files and logs,
+manages rollouts, cron jobs, webhooks, retention and audit, and surveys Ardent and Codex agents
+on managed nodes. Hermes Agent pages and other integrations are optional.
+
+The package ships a prebuilt Next.js standalone server and the `magnus-ui` CLI. It needs a running
+Magnus Control API (`@hivemagnus/magnus-server`) and Redis.
+
+## Requirements
+
+- Node.js `^24.22.1` or `^26.13.0`
+- A reachable Magnus Control API and its `API_SECRET`
+- Redis (login throttling fails closed without it)
+- A TLS certificate and key, unless you terminate TLS in front of the UI
+
+## Install
+
+```bash
+npm install @hivemagnus/magnus-ui
+# or globally
+npm install --global @hivemagnus/magnus-ui
+```
+
+## Configure
+
+Copy `.env.example` from the package (`node_modules/@hivemagnus/magnus-ui/.env.example`) to a
+private file, for example `/etc/magnus-ui/magnus-ui.env` with mode `0600`, and fill it in.
+
+Required settings:
+
+| Variable | Purpose |
+| --- | --- |
+| `CONTROL_API_URL` | Magnus Control API base URL, reached server-side |
+| `API_SECRET` | Must match the Control API `API_SECRET` |
+| `SESSION_SECRET` | Dashboard-only session signing secret (32+ random characters) |
+| `CONTROL_NODE_CREDENTIAL_KEY` | Dedicated 32+ character key for stored control-node credentials |
+| `REDIS_URL` | Redis for login throttling |
+| `DASHBOARD_PUBLIC_ORIGIN` | Browser origin of this UI, for example `https://magnus.example.com` |
+| `DASHBOARD_ADMIN_USERNAME` | Administrator login name |
+| `DASHBOARD_ADMIN_PASSWORD_HASH` | Argon2id hash of the administrator password |
+| `TLS_CERT_PATH`, `TLS_KEY_PATH` | PEM certificate and key (or `MAGNUS_UI_ALLOW_HTTP=true`) |
+
+Generate the password hash:
+
+```bash
+PASSWORD='choose-a-password' node --input-type=module -e \
+  "import argon2 from 'argon2'; console.log(await argon2.hash(process.env.PASSWORD, { type: argon2.argon2id }))"
+```
+
+The node terminal and the Hermes proxy also need a dedicated unprivileged SSH identity on the
+managed nodes: `DASHBOARD_SSH_USERNAME` with `DASHBOARD_SSH_PRIVATE_KEY_PATH` (or
+`DASHBOARD_SSH_PASSWORD`). Without it everything else works.
+
+`magnus-ui env-schema` lists every supported variable with its default.
+
+## Run
+
+```bash
+magnus-ui check --env-file /etc/magnus-ui/magnus-ui.env   # validate and list integrations
+magnus-ui start --env-file /etc/magnus-ui/magnus-ui.env   # start (also the default command)
+```
+
+| Option | Variable | Default |
+| --- | --- | --- |
+| `--env-file FILE` | | Variables already set in the environment win over the file |
+| `--port N` | `PORT` | `3000` |
+| `--host ADDR` | `HOST` | `0.0.0.0` |
+| `--data-dir DIR` | `MAGNUS_UI_DATA_DIR` | The current directory |
+
+`start` validates the configuration first and refuses to start when required settings are
+missing. It serves HTTPS with `TLS_CERT_PATH` and `TLS_KEY_PATH`. To serve plain HTTP, for local
+development or behind a TLS-terminating reverse proxy, set `MAGNUS_UI_ALLOW_HTTP=true`; the server
+prints a warning. Session cookies are `Secure`, so browsers keep them only over HTTPS or on
+`http://localhost`.
+
+Runtime state (the control-node registry, Hermes SSH bindings, terminal audit and the
+authentication audit log) is written under the data directory, mostly in `.magnus/`. Keep it on
+persistent storage and readable only by the service account.
+
+### systemd
+
+`deploy/magnus-ui.service` in the package is an example unit that runs `magnus-ui start` as a
+dedicated `magnus` user with state in `/var/lib/magnus-ui` and the install in `/opt/magnus-ui`.
+Adjust the paths and port, then:
+
+```bash
+sudo cp deploy/magnus-ui.service /etc/systemd/system/
+sudo systemctl daemon-reload && sudo systemctl enable --now magnus-ui
+```
+
+## Optional integrations
+
+Every integration is off until configured. When it is off its navigation entry is hidden, its
+pages show how to enable it, and its proxy routes answer `503`. `magnus-ui check` shows the
+current state.
+
+| Integration | Enable with | Adds |
+| --- | --- | --- |
+| External security console | `MAGNUS_SECURITY_CONSOLE_URL` | Security navigation, fleet security summary, links and redirects to the console |
+| Hive Router | `HIVE_ROUTER_ADMIN_URL` (optional `HIVE_ROUTER_CA_PATH`) | Embedded router admin UI at `/api/hive-router/dashboard` |
+| Hive IAM login | `HIVE_OAUTH_DISCOVERY_URL`, `HIVE_OAUTH_CLIENT_ID`, `HIVE_OAUTH_ISSUER`, `HIVE_OAUTH_API_AUDIENCE` (+ `DASHBOARD_PUBLIC_ORIGIN`) | Named-user OIDC sign-in next to the local administrator |
+| Hermes Agent | `MAGNUS_HERMES_ENABLED=true`, `HERMES_SSH_AUTHORIZATIONS_FILE`, `DASHBOARD_SSH_*` | Hermes installation, profile, drift and proxy-security pages, and the embedded Hermes dashboard over SSH |
+
+## Environment reference
+
+Every variable the runtime configuration accepts. `magnus-ui env-schema` prints the same list.
+
+<!-- dashboard-environment:start -->
+<!-- Generated from runtime-environment.mjs by scripts/check-documentation.mjs. -->
+| Variable | Requirement | Default | Purpose |
+| --- | --- | --- | --- |
+| `CONTROL_API_URL` | Optional | `https://localhost:4000` | Default Magnus Control API target. |
+| `CONTROL_API_CA_PATH` | Optional | None | Private CA bundle used for verified Control API TLS. |
+| `CONTROL_API_MAX_RESPONSE_BYTES` | Optional | `1048576` | Maximum accepted Control API response size in bytes. |
+| `DASHBOARD_PROXY_BODY_LIMIT_BYTES` | Optional | `1048576` | Maximum forwarded request body size in bytes, enforced while streaming. |
+| `API_SECRET` | Required | None | Server-side secret injected into Control API proxy requests. |
+| `CONTROL_NODE_CREDENTIAL_KEY` | Required | None | Dedicated key for encrypted control-node credentials at rest. |
+| `SESSION_SECRET` | Required; temporary legacy fallback is separately gated | None | Dedicated dashboard session signing secret. |
+| `SESSION_ISSUER` | Optional | `magnus-dashboard` | Required issuer claim for dashboard session tokens. |
+| `SESSION_AUDIENCE` | Optional | `magnus-dashboard-session` | Required audience claim for dashboard session tokens. |
+| `ALLOW_LEGACY_SESSION_SECRET` | Optional | `false` | Temporary opt-in for the expiring JWT_SECRET session fallback. |
+| `HERMES_SSH_AUTHORIZATIONS_FILE` | Required (default path shown) | `.magnus/hermes-ssh-authorizations.json` | Reviewed installation, node, address, and SSH host-key bindings. |
+| `DASHBOARD_PUBLIC_ORIGIN` | Required | None | Canonical browser origin allowed to open the Hermes WebSocket bridge. |
+| `HERMES_WEBSOCKET_ALLOWED_ORIGINS` | Optional | None | Comma-separated additional allowed Hermes WebSocket origins. |
+| `DASHBOARD_ADMIN_USERNAME` | Required with DASHBOARD_ADMIN_PASSWORD_HASH; deployment may serialize it | None | Dedicated dashboard administrator identity. |
+| `DASHBOARD_ADMIN_USERNAME_B64` | Optional | None | Serializer-managed base64 form of the dashboard administrator identity. |
+| `DASHBOARD_ADMIN_PASSWORD_HASH` | Required with DASHBOARD_ADMIN_USERNAME; Argon2id only | None | Non-reusable Argon2id dashboard administrator password verifier. |
+| `DASHBOARD_ADMIN_PASSWORD_HASH_B64` | Optional | None | Serializer-managed base64 form of the Argon2id verifier. |
+| `DASHBOARD_ADMIN_CREDENTIAL_METADATA_B64` | Optional | None | Versioned non-secret credential purpose, rotation, fleet-password, and fingerprint-separation evidence. |
+| `DASHBOARD_LOGIN_USERNAME` | Optional | None | Temporary two-phase migration source for the former dedicated dashboard login. |
+| `DASHBOARD_LOGIN_PASSWORD` | Optional | None | Temporary two-phase reusable secret; rejected when equal to fleet or bootstrap credentials. |
+| `REDIS_URL` | Optional | None | Durable dashboard authentication throttling and concurrency store. |
+| `REDIS_PREFIX` | Optional | `magnus-` | Namespace prefix for durable Redis authentication limiter keys. |
+| `AUTH_RATE_LIMIT_LABEL_KEY` | Optional | None | Optional dedicated HMAC key for de-identifying authentication limiter labels. |
+| `DASHBOARD_SSH_USERNAME` | Required for the terminal and Hermes proxy | None | Dedicated, unprivileged dashboard proxy account on managed nodes. |
+| `DASHBOARD_SSH_PASSWORD` | Optional | None | Optional dedicated dashboard SSH password; restricted keys are preferred. |
+| `DASHBOARD_SSH_PRIVATE_KEY_PATH` | Required for the terminal and Hermes proxy (or DASHBOARD_SSH_PASSWORD) | None | Restricted dashboard-proxy private key with no deployment privileges. |
+| `NEXT_PUBLIC_API_URL` | Optional | `https://localhost:4000` | Legacy build-time Control API URL; must never contain a secret. |
+| `HIVE_OAUTH_DISCOVERY_URL` | Optional | None | Hive OAuth discovery URL for optional named dashboard login; HTTPS required. |
+| `HIVE_OAUTH_CLIENT_ID` | Optional | None | Registered Magnus dashboard OAuth client ID. |
+| `HIVE_OAUTH_CLIENT_SECRET` | Optional | None | Optional confidential OAuth client secret, kept server-side. |
+| `HIVE_OAUTH_ISSUER` | Optional | None | Exact trusted Hive access-token issuer. |
+| `HIVE_OAUTH_API_AUDIENCE` | Optional | None | Exact access-token audience accepted by the Control API. |
+| `HIVE_OAUTH_SCOPE` | Optional | `openid profile email` | Registered named-user OAuth scopes. |
+| `HIVE_ROUTER_ADMIN_URL` | Optional | None | Optional Hive Router admin plane; enables the embedded router dashboard proxy. |
+| `HIVE_ROUTER_CA_PATH` | Optional | None | Optional private CA bundle for hostname-verified Hive Router TLS. |
+| `MAGNUS_SECURITY_CONSOLE_URL` | Optional | None | Optional external security console; enables the Security pages and nav entry. |
+| `MAGNUS_HERMES_ENABLED` | Optional | `false` | Enables the optional Hermes Agent pages, dashboard proxy and WebSocket bridge. |
+| `PORT` | Optional | `3000` | Listen port for magnus-ui start. |
+| `HOST` | Optional | `0.0.0.0` | Listen address for magnus-ui start. |
+| `TLS_CERT_PATH` | Required unless MAGNUS_UI_ALLOW_HTTP=true | None | PEM certificate served by magnus-ui start. |
+| `TLS_KEY_PATH` | Required unless MAGNUS_UI_ALLOW_HTTP=true | None | PEM private key for TLS_CERT_PATH. |
+| `MAGNUS_UI_DATA_DIR` | Optional | None | Working directory for runtime state (.magnus/, terminal-audit/); magnus-ui start defaults it to the current directory. |
+| `UI_SECURITY_LOG_PATH` | Optional | `.magnus/security-events.jsonl` | Append-only authentication audit log; login fails closed when it cannot be written. |
+| `MAGNUS_UI_ALLOW_HTTP` | Optional | `false` | Serve plain HTTP when no TLS certificate is configured (local development or behind a TLS proxy only). |
+<!-- dashboard-environment:end -->
+
+## Develop
+
+From a checkout of the monorepo:
+
+```bash
+npm install
+npm --workspace @hivemagnus/magnus-contracts run build
+cd apps/dashboard
+cp .env.example .env    # point CONTROL_API_URL at a local Control API
+npm run dev             # https://localhost:3000, expects ../../certs/server.{crt,key}
+```
+
+Checks: `npm run typecheck`, `npm run lint`, `npm test`, `npm run build`. Browser tests use
+Playwright (`npm run test:e2e`, credentials in `TEST_USERNAME` and `TEST_PASSWORD`).
+
+To build the package locally: `npm run build && npm pack`. `npm pack` runs `scripts/stage-package.mjs`,
+which assembles the standalone server, static assets, the TLS wrapper and its runtime helpers in
+`dist/app`.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).