Skip to content

install.md

Latest commit

 

History

History
65 lines (49 loc) · 3.74 KB

install.md

File metadata and controls

65 lines (49 loc) · 3.74 KB
Raw
subsystem install
owned_paths
.dockerignore
Dockerfile
compose.yaml
docker/
core/scripts/
core/test/check-arch-docs.test.js
core/test/install-doctor.test.js
plugins/README.md

install

Tooling for setup checks, the architecture-docs gate and the container image (#352).

Owns

  • core/scripts/ — helper scripts (e.g. check-arch-docs.mjs).
  • Arch-doc unit test and install-doctor test.
  • plugins/README.md — plugin inventory index.
  • The container image: Dockerfile, compose.yaml, .dockerignore, docker/ (guide).

Does not own

  • core/dev/ bench/smoke tooling → ds-bot-core.
  • Repo-root scripts/ds-bot-patches.mjs (and other root scripts/ patch tooling) → ds-bot-core. This page's core/scripts/ covers install/doctor/arch tooling and the dev-only replay script.

Key files

File Role
core/scripts/check-arch-docs.mjs owned_paths ↔ docs gate. Its refusal names both places a Docs-not-needed: trailer has to appear — the pull request body and the branch commit — because the gate reads git log <base>..HEAD and, on a merge-queue entry, that range is the squashed body (#1076).
core/test/check-arch-docs.test.js Tests for the gate.
core/test/install-doctor.test.js Install doctor tests.
plugins/README.md Plugin list.
core/scripts/install-doctor.mjs Install doctor: Node floor, the packages (core, plugins/social, plugins/tree, plugins/timeline) and the install commands (core, social, tree; @flybot/timeline is opt-in and not in the default commands, #281).
core/scripts/local-ci.sh Local run of CI's steps, including each plugin's suite.
core/scripts/replay.mjs Dev-only state-journal replay (#511): rebuilds state.json up to an entry from <home>/journal/state.jsonl; no network or process calls, output is a new 0600 file or stdout, a bad journal is refused whole. See core-host.
Dockerfile Packs core and the plugins with check-pack.mjs (the release tarballs), then a runtime with DSH (pinned like the README), pnpm and tini, as user node, one volume /data.
compose.yaml One instance: port on the host's 127.0.0.1, volume data, DEEPSEEK_API_KEY passed through only when set.
docker/entrypoint.mjs, docker/profile.mjs Each start links the image's packages into /data/profiles/web (other plugins and cordis.patch.yml kept), pnpm install, then dsh web in /data/workspace.
docker/web.patch.yml Container-only overlay: webserver.host: 0.0.0.0 (the CLI refuses --host 0.0.0.0; inside the container it reaches only the container's network).
docker/healthcheck.mjs Healthy when GET / answers (401 without the cookie).

Entry points

  • npm run arch-docs (in core/) → scripts/check-arch-docs.mjs.

Invariants

  1. Owned-file changes require a matching subsystem doc in the same PR (or a Docs-not-needed: trailer).
  2. Empty diff vs base passes.
  3. A new peer plugin is added to the install doctor (and its test), check-pack.mjs, the CI plugin matrix, local-ci.sh and plugins/README.md in the same PR.
  4. The container image holds no key or token, runs as a normal user, and compose.yaml publishes the port on the host's 127.0.0.1 only. CI (.github/workflows/docker.yml) builds and start-checks it; nothing is pushed to a registry (owner decision on #352).

Tests

node --import ./test/harness-resolve.mjs --test test/check-arch-docs.test.js. Container: node --test .github/scripts/docker-profile.test.mjs (repo root) and the Docker workflow.

Common mistakes

  • Changing an owned path without updating the subsystem page.
  • Committing without regenerating patches when core/ changes.