create-meith 0.21.2 → 0.22.0

package/src/scaffold.ts

@@ -120,8 +120,12 @@ const ENV_TICK_SECRET_PROSE = `# The shared secret the tick caller presents to G
 # it the same way. Without it the tick is unauthenticated, and the tick is how
 # bans expire and digests send.`
 
-const ENV_DATA_SOURCE_PROSE = `# fixture = deterministic in-memory sample data, no database needed. This is
-# what \`npm run build\` uses, and what a checkout with no database falls back to.`
+const ENV_DATA_SOURCE_PROSE = `# Derived, and left commented out on purpose: with no DATABASE_URL the board
+# serves \`fixture\` — deterministic in-memory sample data, no database needed,
+# which is what \`npm run build\` uses and what \`npm run dev\` falls back to — and
+# with one it serves \`postgres\`. Setting it to postgres while DATABASE_URL is
+# still blank is refused at boot, so uncomment it only to override the
+# derivation.`
 
 const ENV_APP_URL_PROSE = `# Absolute, no trailing slash. Used in mail, feeds and canonical URLs — every
 # place a relative URL cannot work because there is no request to be relative to.
@@ -168,7 +172,7 @@ TICK_SECRET=
 ${ENV_OPTIONAL_HEADING}
 
 ${ENV_DATA_SOURCE_PROSE}
-DATA_SOURCE=postgres
+# DATA_SOURCE=postgres
 
 ${ENV_APP_URL_PROSE}
 APP_URL=
@@ -467,7 +471,7 @@ save-exact=true
  *
  * Adding a theme is: \`npm install\` it, add a line here, redeploy. Adding a
  * plugin is the same, through board.plugins.json and community.plugins.ts —
- * see docs/plugin-api.md.
+ * see docs/customization/plugins.md.
  */
 import { defineForumConfig } from '@meith/web/config'
 import {
@@ -506,7 +510,7 @@ export default defineForumConfig({
  * The board's installed-plugin list.
  *
  * Inside the Meith monorepo this file is generated from board.plugins.json
- * by \`pnpm board:gen\` (see docs/plugin-api.md) — that generator is
+ * by \`pnpm board:gen\` (see docs/customization/plugins.md) — that generator is
  * repository tooling, not something this workspace carries, so this file
  * starts as a plain, valid file with the same shape instead. Add a plugin by
  * importing its \`plugin\`/\`messages\` exports and adding an entry:
@@ -556,7 +560,7 @@ export function installedPluginDefinitions() {
 #
 # FROM the published framework base image — deps + framework layers only,
 # locked to this exact release (see the meith repository's
-# docs/self-hosting.md, "Custom boards", and docker/Dockerfile.base for what
+# docs/getting-started/deployment/docker-compose.md, "Custom boards", and docker/Dockerfile.base for what
 # it is and is not). This board's own Dockerfile only ever installs its own
 # delta on top of it — a new plugin's own dependency, typically nothing more
 # — which is what keeps a rebuild after \`npm install some-plugin\` a matter
@@ -566,12 +570,12 @@ export function installedPluginDefinitions() {
 # to Next's own standalone output. The migrate role below runs \`community
 # migrate\`, and \`community\` materializes @meith/cli's sources and runs them
 # with tsx at the moment it runs (see the meith repository's
-# docs/development.md, "Consuming the board from a workspace") — it needs
+# docs/contributing/development.md, "Consuming the board from a workspace") — it needs
 # the full, un-pruned node_modules tree this board installed, not what Next
 # traced as reachable from the web server alone. The tick itself is driven
 # by docker-compose.yml's own \`worker\` service — a lightweight loop against
 # /api/system/tick, not a compiled worker process, because @meith/worker is
-# not published (see the meith repository's docs/release.md).
+# not published (see the meith repository's docs/contributing/release.md).
 ARG MEITH_VERSION
 FROM ghcr.io/meith-dev/meith-base:\${MEITH_VERSION} AS deps
 WORKDIR /board
@@ -596,7 +600,7 @@ ENV NODE_ENV=production
 # persists into every container started from this image afterward, and this
 # Dockerfile has no later stage to reset it in (see "Two stages, not three"
 # above). The build needs neither a database nor a production secret (see
-# the meith repository's docs/development.md, "Fixture mode"), but baking
+# the meith repository's docs/contributing/development.md, "Fixture mode"), but baking
 # DATA_SOURCE=fixture into the image itself would silently force fixture
 # mode — and with it the in-memory queue driver — at runtime too, no matter
 # what DATABASE_URL an operator supplies to \`docker run\`.
@@ -838,9 +842,9 @@ services:
         condition: service_completed_successfully
 
   # @meith/worker is not published (see the meith repository's
-  # docs/release.md), so there is no compiled worker binary a scaffolded
+  # docs/contributing/release.md), so there is no compiled worker binary a scaffolded
   # board can run — this drives the tick the alternative way the meith
-  # repository documents in docs/self-hosting.md, "Running the tick without
+  # repository documents in docs/getting-started/deployment/docker-compose.md, "Running the tick without
   # a second set of credentials": a small loop calling /api/system/tick.
   worker:
     image: alpine:3.24@sha256:28bd5fe8b56d1bd048e5babf5b10710ebe0bae67db86916198a6eec434943f8b
@@ -911,7 +915,7 @@ one value only you know:
 
 3. **Deploy, then \`/install\` on your own domain.** Coolify issues the
    certificate; the installer from there is the one
-   [docs/quickstart.md](${repositoryUrl}/blob/main/docs/quickstart.md#4-run-the-installer)
+   [docs/getting-started/deployment/coolify.md](${repositoryUrl}/blob/main/docs/getting-started/deployment/coolify.md#4-run-the-installer)
    walks through, screen for screen. It seals itself when it finishes, and
    \`/install\` answers 404 from then on — run it **against the database you
    are going to keep**. Every push to \`main\` after this rebuilds the
@@ -929,7 +933,7 @@ rather not use GitHub Actions for the build — push the result wherever
 docker build --build-arg MEITH_VERSION=$(node -p "require('./package.json').dependencies['@meith/web']") -t ${name} .
 \`\`\`
 
-**Without a panel**: [docs/self-hosting.md](${repositoryUrl}/blob/main/docs/self-hosting.md)
+**Without a panel**: [docs/getting-started/deployment/docker-compose.md](${repositoryUrl}/blob/main/docs/getting-started/deployment/docker-compose.md)
 is the same four containers by hand — your own \`.env\`, a reverse proxy you
 already run, no Coolify. \`Dockerfile\` and \`docker-compose.yml\` here are this
 board's own version of exactly that shape.
@@ -949,12 +953,15 @@ Two things nothing configures for you:
 
 \`\`\`sh
 npm install
-cp .env.example .env.local
 npm run dev
 \`\`\`
 
-With no \`DATABASE_URL\`, the board runs on deterministic in-memory sample data —
-enough to click through every reading surface. Posting needs a database:
+No environment file, no database: with no \`DATABASE_URL\` the board serves
+deterministic in-memory sample data, which is enough to click through every
+reading surface.
+
+Posting needs Postgres. Copy \`.env.example\` to \`.env.local\`, set
+\`DATABASE_URL\` and the two secrets in it, then:
 
 \`\`\`sh
 npm run community -- migrate
@@ -1002,7 +1009,7 @@ project's own \`.npmrc\` sets \`save-exact=true\` for the same reason, so an
 build workflow also refuses to build from anything but an exact version, as
 a second line of defense. Once the rebuilt image is deployed, run
 \`npm run community -- upgrade\` against it for the plugin migrations — see
-[the operator CLI](${repositoryUrl}/blob/main/docs/operating.md#the-operator-cli)
+[the operator CLI](${repositoryUrl}/blob/main/docs/guides/operations/operating.md#the-operator-cli)
 for running it against this deployment.
 
 Migrations are forward-only. Recovery is by restore, so take a backup first —
@@ -1192,7 +1199,7 @@ the board's name and address and for the first administrator's username, email
 and password, creates the board and that account, and then **seals itself**:
 \`/install\` answers 404 from then on. Run it against the database you intend to
 keep — the screens are the ones
-[docs/quickstart.md](${repositoryUrl}/blob/main/docs/quickstart.md#4-run-the-installer)
+[docs/getting-started/deployment/docker-compose.md](${repositoryUrl}/blob/main/docs/getting-started/deployment/docker-compose.md#6-install-it)
 walks through.
 
 ## The tick
@@ -1308,15 +1315,15 @@ one.
 ## Somewhere other than Vercel
 
 Everything above is one deployment shape.
-[docs/self-hosting.md](${repositoryUrl}/blob/main/docs/self-hosting.md) is the
+[docs/getting-started/deployment/docker-compose.md](${repositoryUrl}/blob/main/docs/getting-started/deployment/docker-compose.md) is the
 same board as containers you run yourself, and \`npx create-meith <name>\`
 scaffolds that shape instead — a Dockerfile, a compose file and a workflow that
-builds the image. [docs/scaling.md](${repositoryUrl}/blob/main/docs/scaling.md)
+builds the image. [docs/guides/operations/scaling.md](${repositoryUrl}/blob/main/docs/guides/operations/scaling.md)
 explains why the drivers above are what they are, and why an S3-compatible
 bucket is the portable choice for uploads everywhere but here.
 `
 }
 
 export function nextSteps(name: string): readonly string[] {
-  return [`cd ${name}`, 'npm install', 'cp .env.example .env.local', 'npm run dev']
+  return [`cd ${name}`, 'npm install', 'npm run dev']
 }