@nocobase/app-template-default 1.0.0-beta.78 → 1.0.0-beta.79

package/config.example.yml

@@ -158,6 +158,34 @@ snowflake:
 # scheduler:
 #   jobs: redis
 
+# Knowledge owns one global index shared by all spaces; these are server-only instance definitions.
+# Declaring instances does not enable indexing. Select an instance and Embedding model in Knowledge's
+# global index dialog, then explicitly confirm the all-space rebuild and possible model charges.
+# Agents supplies Embedding models only; its vector collections are not used.
+# knowledge:
+#   # Optional: select an existing host jobs configuration by name; omitted follows jobs.default.
+#   # jobs: redis
+#   indexing:
+#     local:
+#       name: Local semantic index
+#       type: sqlite-vec
+#       # Relative to application storage; use one shared file on one host, not separate pod-local files.
+#       file: knowledge/vectors.sqlite
+#     shared:
+#       name: Shared PostgreSQL index
+#       type: pgvector
+#       # Supply real credentials privately. An administrator must install vector and create this schema.
+#       url: postgresql://kb_user:replace-with-the-password@127.0.0.1:5432/knowledge
+#       schema: knowledge_index
+#       # Deployment-owned generation table prefix (default: knowledge); not a page setting.
+#       table: knowledge
+#       # Optional TLS settings; ca/cert/key are PEM contents, not file paths.
+#       # ssl:
+#       #   rejectUnauthorized: true
+#       #   ca: replace-with-the-ca-pem
+#       #   cert: replace-with-the-client-certificate-pem
+#       #   key: replace-with-the-client-private-key-pem
+
 # Mail is registered by default. Configure mailbox provider instances before connecting accounts.
 # See .agents/skills/nocobase-app-plugin-mail/references/configuration-and-accounts.md.
 mail:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nocobase/app-template-default",
   "displayName": "Default Template",
-  "version": "1.0.0-beta.78",
+  "version": "1.0.0-beta.79",
   "type": "module",
   "prettier": "@nocobase/dev-config/prettier",
   "engines": {
@@ -9,7 +9,7 @@
   },
   "nocobase": {
     "templateKind": "app",
-    "defaultTemplateVersion": "1.0.0-beta.78"
+    "defaultTemplateVersion": "1.0.0-beta.79"
   },
   "devDependencies": {
     "@ai-sdk/react": "4.0.131",
@@ -74,7 +74,7 @@
     "elkjs": "^0.10.2",
     "@nocobase/app-client": "^4.0.0-beta.3",
     "@nocobase/app-plugin-template-print": "0.0.2-beta.2",
-    "@nocobase/app-skills": "0.1.0-beta.48",
+    "@nocobase/app-skills": "0.1.0-beta.49",
     "@nocobase/app-testing": "0.1.0-beta.6",
     "@nocobase/app-websocket": "^0.1.0-beta.1",
     "@nocobase/dev-config": "0.1.0-beta.25",
@@ -139,15 +139,15 @@
     "@oclif/core": "^4.14.0",
     "better-auth": "1.7.5",
     "hono": "^4.13.2",
-    "@nocobase/app-plugin-agents": "^1.0.0-beta.23",
+    "@nocobase/app-plugin-agents": "^1.0.0-beta.25",
     "@nocobase/app-plugin-api-keys": "^1.0.0-beta.18",
-    "@nocobase/app-plugin-authentication": "^2.0.0-beta.13",
+    "@nocobase/app-plugin-authentication": "^2.0.0-beta.14",
     "@nocobase/app-plugin-authorization": "^1.0.0-beta.31",
     "@nocobase/app-plugin-database-explorer": "^1.0.0-beta.16",
     "@nocobase/app-plugin-file": "^1.0.0-beta.26",
-    "@nocobase/app-plugin-foundation": "^0.1.0-beta.4",
+    "@nocobase/app-plugin-foundation": "^0.1.0-beta.6",
     "@nocobase/app-plugin-i18n": "^1.0.0-beta.18",
-    "@nocobase/app-plugin-knowledge": "^0.1.0-beta.11",
+    "@nocobase/app-plugin-knowledge": "^0.1.0-beta.12",
     "@nocobase/app-plugin-mail": "^1.0.0-beta.17",
     "@nocobase/app-plugin-notification": "^2.0.0-beta.0",
     "@nocobase/app-plugin-notification-in-app": "^2.0.0-beta.0",

package/server/config/index.ts

@@ -22,6 +22,7 @@ import api from './api.js';
 import database from './database.js';
 import snowflake from './snowflake.js';
 import users from './users.js';
+import knowledge from './knowledge.js';
 
 const defaultConfigs: AppConfigFactory<{
   auth: ReturnType<typeof auth>;
@@ -44,6 +45,7 @@ const defaultConfigs: AppConfigFactory<{
   database: ReturnType<typeof database>;
   snowflake: ReturnType<typeof snowflake>;
   users: ReturnType<typeof users>;
+  knowledge: ReturnType<typeof knowledge>;
 }> = defaultAppConfigs({
   auth,
   authorization,
@@ -65,6 +67,7 @@ const defaultConfigs: AppConfigFactory<{
   database,
   snowflake,
   users,
+  knowledge,
 });
 
 export default defaultConfigs;

package/server/config/knowledge.ts

@@ -0,0 +1,3 @@
+import { defineKnowledgeConfig } from '@nocobase/app-plugin-knowledge/config';
+
+export default defineKnowledgeConfig();

package/tests/logic/config-example.test.ts

@@ -1,7 +1,11 @@
 // @vitest-environment node
 
-import { readFile } from 'node:fs/promises';
+import { mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
 
+import os from 'node:os';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { AppConfig } from '@nocobase/app-server/config';
 import { describe, expect, it } from 'vitest';
 
 // `pnpm nocobase config init` writes config.yml from this file: it replaces the instruction on the first line with
@@ -27,4 +31,39 @@ describe('config.example.yml', () => {
       ].join('\n'),
     );
   });
+  it('keeps Knowledge opt-in and ships a parseable SQLite and PostgreSQL instance example', async () => {
+    const active = new AppConfig().loadFile(
+      fileURLToPath(new URL('../../config.example.yml', import.meta.url)),
+    );
+    await active.loadAll();
+    expect(active.get('knowledge')).toBeUndefined();
+    const example = (await read()).match(
+      /^# knowledge:\n(?:#(?: {2,}.*)?\n)*/m,
+    )?.[0];
+    expect(example).toBeDefined();
+    const directory = await mkdtemp(
+      path.join(os.tmpdir(), 'knowledge-config-example-'),
+    );
+    try {
+      const file = path.join(directory, 'config.yml');
+      await writeFile(file, example!.replace(/^# ?/gm, ''));
+      const config = new AppConfig().loadFile(file);
+      await config.loadAll();
+      expect(config.get('knowledge.indexing.local')).toEqual({
+        name: 'Local semantic index',
+        type: 'sqlite-vec',
+        file: 'knowledge/vectors.sqlite',
+      });
+      expect(config.get('knowledge.indexing.shared')).toEqual({
+        name: 'Shared PostgreSQL index',
+        type: 'pgvector',
+        url: 'postgresql://kb_user:replace-with-the-password@127.0.0.1:5432/knowledge',
+        schema: 'knowledge_index',
+        table: 'knowledge',
+      });
+      expect(config.get('knowledge.jobs')).toBeUndefined();
+    } finally {
+      await rm(directory, { recursive: true, force: true });
+    }
+  });
 });