create-ragen-app 0.6.1 → 0.7.0

package/dist/storage-provider.d.ts

@@ -13,6 +13,16 @@
  * by `tests/architecture/create-ragen-app-knows-the-provider-seams.test.ts` —
  * the same arrangement `manifest.ts` already has with the `.env.example`
  * files.
+ *
+ * **Three answers, two providers.** The third answer, RustFS, is not a third
+ * provider: to the apps it is plain S3 on `localhost:59000`, and the seam has
+ * no variant for it and should not grow one. What makes it an answer of its
+ * own is everything *around* the app config — it is a service this install
+ * starts (compose's `s3` profile), and the store's keys have to be known to
+ * two files that are read by two different programs: Compose reads `.env` to
+ * give RustFS its keys, the apps read `.env.local` to present them. So a
+ * selection carries `composeProfiles` and `composeEnv` beside `envUpdates`,
+ * and `provider` stays what the config and the seam understand.
  */
 /**
  * One field of a written config, and the variable it resolves from.
@@ -28,7 +38,50 @@ export interface ConfigField {
     envVar: string;
     required: boolean;
 }
-export type StorageChoice = 'local' | 's3';
+/** What the wizard offers. */
+export type StorageChoice = 'local' | 's3' | 'rustfs';
+/**
+ * What the app sees — `STORAGE_PROVIDER` and `ragen.config.ts`'s `provider`.
+ * Kept separate from `StorageChoice` so that `'rustfs'` cannot reach either:
+ * the seam would refuse it at boot, and the typed config would not compile.
+ */
+export type StorageProvider = 'local' | 's3';
+/** The compose profile RustFS and its two init containers sit behind. */
+export declare const RUSTFS_COMPOSE_PROFILE = "s3";
+/**
+ * Where the apps reach RustFS. The apps run on the host (compose runs only the
+ * backing services), so this is the published port, not `rustfs:9000` — that
+ * name resolves only inside the compose network. The defaults mirror
+ * `docker-compose.yml`, and `RUSTFS_PUBLISHED_PORTS` in `tasks.ts` is held to
+ * that file by `installer-ports-agree-with-compose.test.ts`.
+ */
+export declare const RUSTFS_ENDPOINT_URL = "http://localhost:59000";
+/**
+ * Where RustFS answers from *inside* the compose network — for the apps when
+ * they run as containers (`npm run ragen:up:everything`), where `localhost` is
+ * the container itself. `docker-compose.fullapp.yml` prefers
+ * `S3_CONTAINER_ENDPOINT_URL` over `S3_ENDPOINT_URL` for exactly this.
+ */
+export declare const RUSTFS_CONTAINER_ENDPOINT_URL = "http://rustfs:9000";
+/** The web console, printed at the end so someone can look inside the store. */
+export declare const RUSTFS_CONSOLE_URL = "http://localhost:59001";
+/** The bucket `rustfs-bucket-init` creates on every `up`. */
+export declare const RUSTFS_BUCKET = "ragen";
+/**
+ * RustFS ignores the region, but the AWS SDK refuses to sign a request without
+ * one and the seam requires `S3_REGION`. `us-east-1` is what every
+ * S3-compatible server answers to, and what the bucket init uses.
+ */
+export declare const RUSTFS_REGION = "us-east-1";
+/**
+ * The keys RustFS is started with. Generated per install rather than using
+ * compose's `ragen-local` defaults, which are printed in a public file.
+ */
+export interface RustfsKeys {
+    accessKey: string;
+    secretKey: string;
+}
+export declare function generateRustfsKeys(): RustfsKeys;
 export interface S3Answers {
     bucket: string;
     region: string;
@@ -38,12 +91,44 @@ export interface S3Answers {
     endpoint: string;
 }
 export interface StorageSelection {
-    provider: StorageChoice;
+    /** The answer, so later steps can tell RustFS from an S3 someone else runs. */
+    choice: StorageChoice;
+    provider: StorageProvider;
     /** Written to the root `.env.local` — credentials never go in the config. */
     envUpdates: Record<string, string>;
     /** The config fields, already named as the config names them. */
     configFields: ConfigField[];
+    /** Passed to `docker compose --profile …`, so choosing it starts it. */
+    composeProfiles: string[];
+    /**
+     * Lines for the install's `.env`, which Compose reads and the apps do not.
+     * Written only where the file has no value yet — see `writeComposeEnv` in
+     * `cli.ts` for why an existing value wins.
+     */
+    composeEnv: Record<string, string>;
 }
 export declare const STORAGE_LABELS: Record<StorageChoice, string>;
-export declare function resolveStorageSelection(provider: StorageChoice, answers?: S3Answers): StorageSelection;
+/**
+ * `answers` is read for `s3`, `rustfsKeys` for `rustfs`. RustFS generates its
+ * keys when none are given; the wizard passes them only when the install's
+ * `.env` already holds keys the store was started with (see
+ * `withExistingRustfsKeys`).
+ */
+export declare function resolveStorageSelection(choice: StorageChoice, answers?: S3Answers, rustfsKeys?: RustfsKeys): StorageSelection;
+/**
+ * The same selection, with any RustFS key the install's `.env` already has
+ * taking the place of the generated one.
+ *
+ * `.env` wins because it is what the store was *started* with: RustFS takes
+ * its root keys from its environment on every boot, and rotating them in
+ * `.env.local` alone would leave the apps presenting keys the running store
+ * does not know. Rotating both would be worse on a store that already holds
+ * files — the new keys would work, and nothing would say the old ones were
+ * someone's only record. Reusing them keeps `.env` and `.env.local` agreeing,
+ * which is the invariant that matters: one pair of keys, written twice.
+ *
+ * Per key, not all-or-nothing, because the `.env` merge is per line too: a
+ * file with only one of the two keeps it and gets the other appended.
+ */
+export declare function withExistingRustfsKeys(selection: StorageSelection, existing: Record<string, string | undefined>): StorageSelection;
 //# sourceMappingURL=storage-provider.d.ts.map

package/dist/storage-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-provider.d.ts","sourceRoot":"","sources":["../src/storage-provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,IAAI,CAAC;AAE3C,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,aAAa,CAAC;IACxB,6EAA6E;IAC7E,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,iEAAiE;IACjE,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B;AAED,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,aAAa,EAAE,MAAM,CAGxD,CAAC;AAkBF,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,aAAa,EACvB,OAAO,CAAC,EAAE,SAAS,GAClB,gBAAgB,CAmDlB"}
+{"version":3,"file":"storage-provider.d.ts","sourceRoot":"","sources":["../src/storage-provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;CACnB;AAID,8BAA8B;AAC9B,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,IAAI,GAAG,QAAQ,CAAC;AAEtD;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,IAAI,CAAC;AAE7C,yEAAyE;AACzE,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,2BAA2B,CAAC;AAE5D;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,uBAAuB,CAAC;AAElE,gFAAgF;AAChF,eAAO,MAAM,kBAAkB,2BAA2B,CAAC;AAE3D,6DAA6D;AAC7D,eAAO,MAAM,aAAa,UAAU,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,aAAa,cAAc,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,wBAAgB,kBAAkB,IAAI,UAAU,CAK/C;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,+EAA+E;IAC/E,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,eAAe,CAAC;IAC1B,6EAA6E;IAC7E,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,iEAAiE;IACjE,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,wEAAwE;IACxE,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC;AAED,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,aAAa,EAAE,MAAM,CAIxD,CAAC;AAkBF;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,aAAa,EACrB,OAAO,CAAC,EAAE,SAAS,EACnB,UAAU,CAAC,EAAE,UAAU,GACtB,gBAAgB,CAmBlB;AA4CD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,gBAAgB,EAC3B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAC3C,gBAAgB,CAalB"}

package/dist/storage-provider.js

@@ -14,13 +14,60 @@
  * by `tests/architecture/create-ragen-app-knows-the-provider-seams.test.ts` —
  * the same arrangement `manifest.ts` already has with the `.env.example`
  * files.
+ *
+ * **Three answers, two providers.** The third answer, RustFS, is not a third
+ * provider: to the apps it is plain S3 on `localhost:59000`, and the seam has
+ * no variant for it and should not grow one. What makes it an answer of its
+ * own is everything *around* the app config — it is a service this install
+ * starts (compose's `s3` profile), and the store's keys have to be known to
+ * two files that are read by two different programs: Compose reads `.env` to
+ * give RustFS its keys, the apps read `.env.local` to present them. So a
+ * selection carries `composeProfiles` and `composeEnv` beside `envUpdates`,
+ * and `provider` stays what the config and the seam understand.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.STORAGE_LABELS = void 0;
+exports.STORAGE_LABELS = exports.RUSTFS_REGION = exports.RUSTFS_BUCKET = exports.RUSTFS_CONSOLE_URL = exports.RUSTFS_CONTAINER_ENDPOINT_URL = exports.RUSTFS_ENDPOINT_URL = exports.RUSTFS_COMPOSE_PROFILE = void 0;
+exports.generateRustfsKeys = generateRustfsKeys;
 exports.resolveStorageSelection = resolveStorageSelection;
+exports.withExistingRustfsKeys = withExistingRustfsKeys;
+const secrets_1 = require("./secrets");
+/** The compose profile RustFS and its two init containers sit behind. */
+exports.RUSTFS_COMPOSE_PROFILE = 's3';
+/**
+ * Where the apps reach RustFS. The apps run on the host (compose runs only the
+ * backing services), so this is the published port, not `rustfs:9000` — that
+ * name resolves only inside the compose network. The defaults mirror
+ * `docker-compose.yml`, and `RUSTFS_PUBLISHED_PORTS` in `tasks.ts` is held to
+ * that file by `installer-ports-agree-with-compose.test.ts`.
+ */
+exports.RUSTFS_ENDPOINT_URL = 'http://localhost:59000';
+/**
+ * Where RustFS answers from *inside* the compose network — for the apps when
+ * they run as containers (`npm run ragen:up:everything`), where `localhost` is
+ * the container itself. `docker-compose.fullapp.yml` prefers
+ * `S3_CONTAINER_ENDPOINT_URL` over `S3_ENDPOINT_URL` for exactly this.
+ */
+exports.RUSTFS_CONTAINER_ENDPOINT_URL = 'http://rustfs:9000';
+/** The web console, printed at the end so someone can look inside the store. */
+exports.RUSTFS_CONSOLE_URL = 'http://localhost:59001';
+/** The bucket `rustfs-bucket-init` creates on every `up`. */
+exports.RUSTFS_BUCKET = 'ragen';
+/**
+ * RustFS ignores the region, but the AWS SDK refuses to sign a request without
+ * one and the seam requires `S3_REGION`. `us-east-1` is what every
+ * S3-compatible server answers to, and what the bucket init uses.
+ */
+exports.RUSTFS_REGION = 'us-east-1';
+function generateRustfsKeys() {
+    return {
+        accessKey: (0, secrets_1.generateS3AccessKeyId)(),
+        secretKey: (0, secrets_1.generateS3SecretAccessKey)(),
+    };
+}
 exports.STORAGE_LABELS = {
     local: 'Local filesystem (default — no cloud account needed)',
     s3: 'S3-compatible (AWS, Cloudflare R2, Scaleway, MinIO, Ceph)',
+    rustfs: 'RustFS — self-hosted object storage, started with the stack',
 };
 /**
  * A path-style endpoint is what Scaleway (dotted bucket names) and MinIO/Ceph
@@ -35,16 +82,96 @@ function needsPathStyle(endpoint) {
     return (!host.includes('amazonaws.com') &&
         !host.includes('r2.cloudflarestorage.com'));
 }
-function resolveStorageSelection(provider, answers) {
-    if (provider === 'local' || !answers) {
+/**
+ * `answers` is read for `s3`, `rustfsKeys` for `rustfs`. RustFS generates its
+ * keys when none are given; the wizard passes them only when the install's
+ * `.env` already holds keys the store was started with (see
+ * `withExistingRustfsKeys`).
+ */
+function resolveStorageSelection(choice, answers, rustfsKeys) {
+    if (choice === 'rustfs') {
+        return rustfsSelection(rustfsKeys ?? generateRustfsKeys());
+    }
+    if (choice === 'local' || !answers) {
         return {
+            choice: 'local',
             provider: 'local',
             envUpdates: { STORAGE_PROVIDER: 'local' },
             configFields: [
                 { field: 'path', envVar: 'STORAGE_LOCAL_PATH', required: false },
             ],
+            composeProfiles: [],
+            composeEnv: {},
         };
     }
+    return s3Selection(answers);
+}
+/**
+ * RustFS through the S3 path, not beside it: the same five variables and the
+ * same config fields an S3 answer pointed at `localhost:59000` would produce.
+ * A second hand-written list is how the two would drift, and the apps cannot
+ * tell them apart anyway. Path-style comes from `needsPathStyle` like it does
+ * for MinIO — a `localhost` host has no bucket subdomains to resolve.
+ */
+function rustfsSelection(keys) {
+    const s3 = s3Selection({
+        bucket: exports.RUSTFS_BUCKET,
+        region: exports.RUSTFS_REGION,
+        endpoint: exports.RUSTFS_ENDPOINT_URL,
+        accessKeyId: keys.accessKey,
+        secretAccessKey: keys.secretKey,
+    });
+    return {
+        ...s3,
+        choice: 'rustfs',
+        composeProfiles: [exports.RUSTFS_COMPOSE_PROFILE],
+        // `.env` is the only file Compose reads, and it serves two readers: the
+        // RustFS server (its root keys) and, with the apps in containers
+        // (`ragen:up:everything`), the apps themselves — which otherwise never see
+        // `.env.local` and would quietly store to the local volume instead. So the
+        // S3 settings go here too, derived from the same pair of keys, with the
+        // container-side endpoint. The host apps are unaffected: `.env.local`
+        // holds the same values and wins over `.env`, and nothing on the host
+        // reads S3_CONTAINER_ENDPOINT_URL.
+        composeEnv: {
+            RUSTFS_ACCESS_KEY: keys.accessKey,
+            RUSTFS_SECRET_KEY: keys.secretKey,
+            STORAGE_PROVIDER: 's3',
+            S3_CONTAINER_ENDPOINT_URL: exports.RUSTFS_CONTAINER_ENDPOINT_URL,
+            S3_FORCE_PATH_STYLE: 'true',
+            S3_REGION: exports.RUSTFS_REGION,
+            S3_BUCKET_NAME: exports.RUSTFS_BUCKET,
+            S3_ACCESS_KEY_ID: keys.accessKey,
+            S3_SECRET_ACCESS_KEY: keys.secretKey,
+        },
+    };
+}
+/**
+ * The same selection, with any RustFS key the install's `.env` already has
+ * taking the place of the generated one.
+ *
+ * `.env` wins because it is what the store was *started* with: RustFS takes
+ * its root keys from its environment on every boot, and rotating them in
+ * `.env.local` alone would leave the apps presenting keys the running store
+ * does not know. Rotating both would be worse on a store that already holds
+ * files — the new keys would work, and nothing would say the old ones were
+ * someone's only record. Reusing them keeps `.env` and `.env.local` agreeing,
+ * which is the invariant that matters: one pair of keys, written twice.
+ *
+ * Per key, not all-or-nothing, because the `.env` merge is per line too: a
+ * file with only one of the two keeps it and gets the other appended.
+ */
+function withExistingRustfsKeys(selection, existing) {
+    if (selection.choice !== 'rustfs') {
+        return selection;
+    }
+    const accessKey = existing.RUSTFS_ACCESS_KEY?.trim() ||
+        selection.composeEnv.RUSTFS_ACCESS_KEY;
+    const secretKey = existing.RUSTFS_SECRET_KEY?.trim() ||
+        selection.composeEnv.RUSTFS_SECRET_KEY;
+    return rustfsSelection({ accessKey, secretKey });
+}
+function s3Selection(answers) {
     const endpoint = answers.endpoint.trim();
     const envUpdates = {
         STORAGE_PROVIDER: 's3',
@@ -79,6 +206,13 @@ function resolveStorageSelection(provider, answers) {
             });
         }
     }
-    return { provider: 's3', envUpdates, configFields };
+    return {
+        choice: 's3',
+        provider: 's3',
+        envUpdates,
+        configFields,
+        composeProfiles: [],
+        composeEnv: {},
+    };
 }
 //# sourceMappingURL=storage-provider.js.map

package/dist/storage-provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage-provider.js","sourceRoot":"","sources":["../src/storage-provider.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAyDH,0DAsDC;AA3EY,QAAA,cAAc,GAAkC;IAC3D,KAAK,EAAE,sDAAsD;IAC7D,EAAE,EAAE,2DAA2D;CAChE,CAAC;AAEF;;;;GAIG;AACH,SAAS,cAAc,CAAC,QAAgB;IACtC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC3C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CACL,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC/B,CAAC,IAAI,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAC3C,CAAC;AACJ,CAAC;AAED,SAAgB,uBAAuB,CACrC,QAAuB,EACvB,OAAmB;IAEnB,IAAI,QAAQ,KAAK,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QACrC,OAAO;YACL,QAAQ,EAAE,OAAO;YACjB,UAAU,EAAE,EAAE,gBAAgB,EAAE,OAAO,EAAE;YACzC,YAAY,EAAE;gBACZ,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,QAAQ,EAAE,KAAK,EAAE;aACjE;SACF,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAEzC,MAAM,UAAU,GAA2B;QACzC,gBAAgB,EAAE,IAAI;QACtB,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE;QACrC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE;QAChC,gBAAgB,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE;QAC5C,oBAAoB,EAAE,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE;KACrD,CAAC;IAEF,MAAM,YAAY,GAAkB;QAClC,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE;QACjE,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE;QACxD,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,kBAAkB,EAAE,QAAQ,EAAE,IAAI,EAAE;QACpE;YACE,KAAK,EAAE,iBAAiB;YACxB,MAAM,EAAE,sBAAsB;YAC9B,QAAQ,EAAE,IAAI;SACf;KACF,CAAC;IAEF,IAAI,QAAQ,EAAE,CAAC;QACb,UAAU,CAAC,eAAe,GAAG,QAAQ,CAAC;QACtC,YAAY,CAAC,IAAI,CAAC;YAChB,KAAK,EAAE,UAAU;YACjB,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAC;QAEH,IAAI,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,UAAU,CAAC,mBAAmB,GAAG,MAAM,CAAC;YACxC,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,gBAAgB;gBACvB,MAAM,EAAE,qBAAqB;gBAC7B,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC;AACtD,CAAC"}
+{"version":3,"file":"storage-provider.js","sourceRoot":"","sources":["../src/storage-provider.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;;;AAuEH,gDAKC;AAyDD,0DAuBC;AA2DD,wDAgBC;AAtND,uCAA6E;AAY7E,yEAAyE;AAC5D,QAAA,sBAAsB,GAAG,IAAI,CAAC;AAE3C;;;;;;GAMG;AACU,QAAA,mBAAmB,GAAG,wBAAwB,CAAC;AAE5D;;;;;GAKG;AACU,QAAA,6BAA6B,GAAG,oBAAoB,CAAC;AAElE,gFAAgF;AACnE,QAAA,kBAAkB,GAAG,wBAAwB,CAAC;AAE3D,6DAA6D;AAChD,QAAA,aAAa,GAAG,OAAO,CAAC;AAErC;;;;GAIG;AACU,QAAA,aAAa,GAAG,WAAW,CAAC;AAWzC,SAAgB,kBAAkB;IAChC,OAAO;QACL,SAAS,EAAE,IAAA,+BAAqB,GAAE;QAClC,SAAS,EAAE,IAAA,mCAAyB,GAAE;KACvC,CAAC;AACJ,CAAC;AA6BY,QAAA,cAAc,GAAkC;IAC3D,KAAK,EAAE,sDAAsD;IAC7D,EAAE,EAAE,2DAA2D;IAC/D,MAAM,EAAE,6DAA6D;CACtE,CAAC;AAEF;;;;GAIG;AACH,SAAS,cAAc,CAAC,QAAgB;IACtC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC3C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CACL,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC/B,CAAC,IAAI,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAC3C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,MAAqB,EACrB,OAAmB,EACnB,UAAuB;IAEvB,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxB,OAAO,eAAe,CAAC,UAAU,IAAI,kBAAkB,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,MAAM,KAAK,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QACnC,OAAO;YACL,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,OAAO;YACjB,UAAU,EAAE,EAAE,gBAAgB,EAAE,OAAO,EAAE;YACzC,YAAY,EAAE;gBACZ,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,QAAQ,EAAE,KAAK,EAAE;aACjE;YACD,eAAe,EAAE,EAAE;YACnB,UAAU,EAAE,EAAE;SACf,CAAC;IACJ,CAAC;IAED,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,IAAgB;IACvC,MAAM,EAAE,GAAG,WAAW,CAAC;QACrB,MAAM,EAAE,qBAAa;QACrB,MAAM,EAAE,qBAAa;QACrB,QAAQ,EAAE,2BAAmB;QAC7B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,eAAe,EAAE,IAAI,CAAC,SAAS;KAChC,CAAC,CAAC;IAEH,OAAO;QACL,GAAG,EAAE;QACL,MAAM,EAAE,QAAQ;QAChB,eAAe,EAAE,CAAC,8BAAsB,CAAC;QACzC,wEAAwE;QACxE,iEAAiE;QACjE,2EAA2E;QAC3E,2EAA2E;QAC3E,wEAAwE;QACxE,sEAAsE;QACtE,sEAAsE;QACtE,mCAAmC;QACnC,UAAU,EAAE;YACV,iBAAiB,EAAE,IAAI,CAAC,SAAS;YACjC,iBAAiB,EAAE,IAAI,CAAC,SAAS;YACjC,gBAAgB,EAAE,IAAI;YACtB,yBAAyB,EAAE,qCAA6B;YACxD,mBAAmB,EAAE,MAAM;YAC3B,SAAS,EAAE,qBAAa;YACxB,cAAc,EAAE,qBAAa;YAC7B,gBAAgB,EAAE,IAAI,CAAC,SAAS;YAChC,oBAAoB,EAAE,IAAI,CAAC,SAAS;SACrC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,sBAAsB,CACpC,SAA2B,EAC3B,QAA4C;IAE5C,IAAI,SAAS,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,SAAS,GACb,QAAQ,CAAC,iBAAiB,EAAE,IAAI,EAAE;QAClC,SAAS,CAAC,UAAU,CAAC,iBAAiB,CAAC;IACzC,MAAM,SAAS,GACb,QAAQ,CAAC,iBAAiB,EAAE,IAAI,EAAE;QAClC,SAAS,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAEzC,OAAO,eAAe,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,WAAW,CAAC,OAAkB;IACrC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAEzC,MAAM,UAAU,GAA2B;QACzC,gBAAgB,EAAE,IAAI;QACtB,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE;QACrC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE;QAChC,gBAAgB,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE;QAC5C,oBAAoB,EAAE,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE;KACrD,CAAC;IAEF,MAAM,YAAY,GAAkB;QAClC,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE;QACjE,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE;QACxD,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,kBAAkB,EAAE,QAAQ,EAAE,IAAI,EAAE;QACpE;YACE,KAAK,EAAE,iBAAiB;YACxB,MAAM,EAAE,sBAAsB;YAC9B,QAAQ,EAAE,IAAI;SACf;KACF,CAAC;IAEF,IAAI,QAAQ,EAAE,CAAC;QACb,UAAU,CAAC,eAAe,GAAG,QAAQ,CAAC;QACtC,YAAY,CAAC,IAAI,CAAC;YAChB,KAAK,EAAE,UAAU;YACjB,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAC;QAEH,IAAI,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,UAAU,CAAC,mBAAmB,GAAG,MAAM,CAAC;YACxC,YAAY,CAAC,IAAI,CAAC;gBAChB,KAAK,EAAE,gBAAgB;gBACvB,MAAM,EAAE,qBAAqB;gBAC7B,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO;QACL,MAAM,EAAE,IAAI;QACZ,QAAQ,EAAE,IAAI;QACd,UAAU;QACV,YAAY;QACZ,eAAe,EAAE,EAAE;QACnB,UAAU,EAAE,EAAE;KACf,CAAC;AACJ,CAAC"}

package/dist/tasks.d.ts

@@ -15,26 +15,153 @@ export interface MigrateOptions {
 }
 export declare function isDockerAvailable(): Promise<boolean>;
 /**
- * Whether this Docker daemon already runs a Ragen stack.
+ * Compose takes its project name from the **directory basename**, which is not
+ * the same as being unique per install.
  *
- * docker-compose.yml pins container, volume and network names instead of
- * letting Compose prefix them per project, so a second install does not just
- * collide on the container names — it silently attaches to the *same*
- * postgres and qdrant volumes as the first one. Checking the volume rather
- * than a container catches a stack that is merely stopped, which is the
- * case that looks safest and is not.
+ * Removing the pinned `container_name`/volume `name:` from docker-compose.yml
+ * scopes every resource to the project, and that is what lets two checkouts
+ * coexist. But `/work/a/ragen` and `/work/b/ragen` produce the same project
+ * name, and therefore the same containers, volumes and network — the original
+ * bug, narrowed to same-named directories rather than fixed. Worse than the
+ * port collision, because a *stopped* first stack collides silently: no port
+ * is held, nothing refuses, and the second install opens the first one's
+ * database.
  *
- * Reads RAGEN_STACK_NAME for the same reason compose does: someone already
- * running a stack under a name of their own would otherwise be told their
- * machine is clear, and collide with it.
+ * So the name is decided here, at install time, and written to the new tree's
+ * `.env` — which Compose reads from the project directory on every later
+ * `docker compose` the user runs, with no flag to remember. `.env` is the
+ * lowest-precedence file `scripts/load-root-env.mjs` reads and is gitignored,
+ * and nothing in the apps reads `COMPOSE_PROJECT_NAME`, so it cannot collide
+ * with the install's own configuration.
+ *
+ * The basename is kept whenever it is free, because the readability given up
+ * with the pinned names is worth not giving up twice. A suffix appears only
+ * when this daemon already runs a project of that name from somewhere else.
+ */
+export interface ComposeProjectName {
+    name: string;
+    /** True when the plain basename was taken and a suffix was added. */
+    disambiguated: boolean;
+    /** The compose file of the project that took it, for the message. */
+    takenBy?: string;
+    /**
+     * True when the suffix was added because Docker could not be asked, rather
+     * than because a collision was seen. A different sentence to the reader:
+     * nothing is wrong, and the name is cautious rather than forced.
+     */
+    daemonUnreachable?: boolean;
+}
+/**
+ * Compose accepts `[a-z0-9][a-z0-9_-]*`. A directory called `My Ragen!` or
+ * `.ragen` is perfectly legal and would otherwise make every compose command
+ * fail with a validation error after the install had finished.
+ */
+export declare function normalizeComposeProjectName(raw: string): string;
+export declare function resolveComposeProjectName(targetDir: string): Promise<ComposeProjectName>;
+/**
+ * Every host port a default `docker compose up` publishes, with the variable
+ * that moves it. The order is the order the warning prints them in.
+ *
+ * Defaults are duplicated from docker-compose.yml rather than parsed out of
+ * it, because this runs *before* the repository is cloned — there is no file
+ * to read yet. `ports-agree-with-compose.test.ts` holds the two in step.
+ */
+export declare const PUBLISHED_PORTS: readonly [{
+    readonly service: "Postgres";
+    readonly variable: "POSTGRES_PORT";
+    readonly port: 55432;
+}, {
+    readonly service: "Qdrant";
+    readonly variable: "QDRANT_PORT";
+    readonly port: 6333;
+}, {
+    readonly service: "Qdrant (gRPC)";
+    readonly variable: "QDRANT_GRPC_PORT";
+    readonly port: 6334;
+}, {
+    readonly service: "Docling";
+    readonly variable: "DOCLING_PORT";
+    readonly port: 5001;
+}, {
+    readonly service: "Redis";
+    readonly variable: "REDIS_PORT";
+    readonly port: 56379;
+}];
+/** The two more, behind the `pii` profile, that only a masking install starts. */
+export declare const PII_PUBLISHED_PORTS: readonly [{
+    readonly service: "Presidio analyzer";
+    readonly variable: "PRESIDIO_ANALYZER_PORT";
+    readonly port: 5002;
+}, {
+    readonly service: "Presidio anonymizer";
+    readonly variable: "PRESIDIO_ANONYMIZER_PORT";
+    readonly port: 5003;
+}];
+/**
+ * The two more, behind the `s3` profile, that only a RustFS install starts:
+ * the S3 API the apps talk to, and the web console.
+ */
+export declare const RUSTFS_PUBLISHED_PORTS: readonly [{
+    readonly service: "RustFS (S3 API)";
+    readonly variable: "RUSTFS_PORT";
+    readonly port: 59000;
+}, {
+    readonly service: "RustFS console";
+    readonly variable: "RUSTFS_CONSOLE_PORT";
+    readonly port: 59001;
+}];
+export interface PublishedPort {
+    service: string;
+    variable: string;
+    port: number;
+}
+/**
+ * The extra ports each optional profile publishes, keyed by profile name.
+ *
+ * One table rather than a branch per profile, because the port probe, the
+ * recovery command and the "update .env.local" hint all have to agree on what
+ * a profile starts — and with two profiles the branch-per-profile version was
+ * already printing a command that named only one of them.
+ */
+export declare const PROFILE_PUBLISHED_PORTS: Record<string, readonly PublishedPort[]>;
+/** Every port a `docker compose up` with these profiles publishes. */
+export declare function publishedPortsFor(profiles: readonly string[]): PublishedPort[];
+/**
+ * The `docker compose up` a person should type to get the stack this install
+ * configured, profiles included.
+ *
+ * Built from the same list `startDockerServices` is given, so a printed
+ * command cannot drift from an executed one. A command that drops a profile
+ * starts a stack without the services whose URLs were just written to
+ * `.env.local` — the half-configuration the profiles exist to prevent, only
+ * printed instead of executed.
+ */
+export declare function composeUpCommand(profiles?: readonly string[]): string;
+/**
+ * Which of these host ports something is already listening on.
+ *
+ * This replaces a check for the volume `ragen-postgres-data`. That volume name
+ * was pinned in docker-compose.yml, which is what made a second install share
+ * the first one's database — and removing the pin removed the sharing, so the
+ * old check now answers a question nobody is asking and would answer "clear"
+ * for every install made after the change. A guard that quietly stops firing
+ * is worse than no guard.
+ *
+ * Ports are what is genuinely left: Compose prefixes names per project, and
+ * prefixes nothing about a published port, so two stacks still collide on
+ * 55432. Binding is also a better probe than asking Docker — it sees a native
+ * Postgres on the port as well, which is the other way this install ends up
+ * talking to a database it did not start.
  */
-export declare function ragenStackVolumeExists(): Promise<boolean>;
+export declare function busyPublishedPorts(candidates?: readonly PublishedPort[]): Promise<PublishedPort[]>;
 /**
  * `profiles` names compose profiles to add to the default set.
  *
  * Without it, choosing PII masking would write the two Presidio URLs and start
  * nothing behind them: those services sit behind compose's `pii` profile, so a
  * plain `up -d` skips them and the app would point at containers nobody ran.
+ * RustFS is the same shape behind `s3` — the apps would be configured for an
+ * object store on 59000 that nothing started, and fail at the first upload.
  */
 export declare function startDockerServices({ cwd, profiles, }: RunOptions & {
     profiles?: string[];

package/dist/tasks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/tasks.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC,CAU1D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,sBAAsB,IAAI,OAAO,CAAC,OAAO,CAAC,CAgB/D;AAED;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,GAAG,EACH,QAAa,GACd,EAAE,UAAU,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAMtD;AAED,wBAAsB,mBAAmB,CAAC,EAAE,GAAG,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAE5E;AAED,wBAAsB,oBAAoB,CAAC,EACzC,GAAG,EACH,GAAG,GACJ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAE5B;AAED,wBAAsB,YAAY,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1E;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CACnC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,UAAU,EACxB,EAAE,OAAW,EAAE,YAAmB,EAAE,GAAE,cAAmB,GACxD,OAAO,CAAC,IAAI,CAAC,CAsBf"}
+{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/tasks.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC,CAU1D;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,qEAAqE;IACrE,aAAa,EAAE,OAAO,CAAC;IACvB,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO/D;AA4BD,wBAAsB,yBAAyB,CAC7C,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,kBAAkB,CAAC,CA8C7B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;EAMlB,CAAC;AAEX,kFAAkF;AAClF,eAAO,MAAM,mBAAmB;;;;;;;;EAWtB,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;EAOzB,CAAC;AAEX,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,aAAa,EAAE,CAI1E,CAAC;AAEJ,sEAAsE;AACtE,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,SAAS,MAAM,EAAE,GAC1B,aAAa,EAAE,CAKjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,GAAE,SAAS,MAAM,EAAO,GAAG,MAAM,CAMzE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,kBAAkB,CACtC,UAAU,GAAE,SAAS,aAAa,EAAoB,GACrD,OAAO,CAAC,aAAa,EAAE,CAAC,CAS1B;AAyBD;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,GAAG,EACH,QAAa,GACd,EAAE,UAAU,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAMtD;AAED,wBAAsB,mBAAmB,CAAC,EAAE,GAAG,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAE5E;AAED,wBAAsB,oBAAoB,CAAC,EACzC,GAAG,EACH,GAAG,GACJ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAE5B;AAED,wBAAsB,YAAY,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1E;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CACnC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,UAAU,EACxB,EAAE,OAAW,EAAE,YAAmB,EAAE,GAAE,cAAmB,GACxD,OAAO,CAAC,IAAI,CAAC,CAsBf"}