chore: update config template

[darkskygit]

PR Dependency Tree

• PR chore: update config template #15344 👈

This tree was auto-generated by Charcoal

Summary by CodeRabbit

• New Features

  • Added an example configuration for self-hosted deployments, including server settings and AI BYOK options.
  • Updated self-hosted deployment defaults with stable images, simplified local data storage, and consistent database configuration.
  • Reorganized admin configuration around AI BYOK, including provider allowlists and custom endpoint controls.

• Changes

  • Removed the standalone admin AI page and navigation entry; the former route now redirects to Settings.

• Documentation

  • Clarified descriptions for AI and BYOK configuration options across configuration documentation and the admin interface.

[coderabbitai]

📝 Walkthrough

Walkthrough

Self-hosting defaults now use fixed local paths and affine database settings, with a JSON configuration example shipped in releases. AI configuration text and admin fields are renamed around BYOK, while the standalone admin AI page is removed and its route redirects to settings.

Changes

Self-hosting runtime and release configuration

Layer / File(s)	Summary
Self-host runtime and release configuration .docker/selfhost/compose.yml, .docker/selfhost/config.json.example, .github/workflows/release-desktop.yml	Compose services use stable images, fixed local mounts, affine database settings, and the release now includes config.json.example instead of .env.example.

AI BYOK configuration metadata

Layer / File(s)	Summary
AI BYOK configuration metadata .docker/selfhost/schema.json, packages/backend/server/src/plugins/copilot/config.ts, packages/frontend/admin/src/config.json, packages/frontend/admin/src/modules/settings/config.ts	Configuration descriptions and the admin configuration group now describe AI BYOK settings, allowed providers, and endpoint controls.

Admin AI route removal

Layer / File(s)	Summary
Admin AI route removal packages/frontend/admin/src/app.tsx, packages/frontend/admin/src/modules/ai/*, packages/frontend/admin/src/modules/nav/nav.tsx	The AI page module and inactive navigation entry are removed, and /admin/ai redirects to admin settings.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• toeverything/AFFiNE#15303: Adds backend support and configuration exposure for AI BYOK private endpoint probing.

Suggested labels: mod:infra, mod:component

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title is concise and matches the main theme of updating configuration templates and self-hosting config files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Trivy (0.72.0)

Trivy execution failed: 2026-07-25T08:05:13Z FATAL Fatal error run error: fs scan error: scan error: scan failed: failed analysis: post analysis error: post analysis error: helm scan error: fs filter error: fs filter error: walk error range error: stat packages/backend/server/doctor.config.json: no such file or directory: range error: stat packages/backend/server/doctor.config.json: no such file or directory

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[cloudflare-workers-and-pages]

Deploying blocksuite-docs with    Cloudflare Pages

Latest commit:	3fe75c3
Status:	✅  Deploy successful!
Preview URL:	https://76cf277f.blocksuite-docs.pages.dev
Branch Preview URL:	https://darksky-update-config-templa.blocksuite-docs.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 3

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

.docker/selfhost/schema.json (1)

1143-1163: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Keep AI BYOK terminology consistent across metadata.

• .docker/selfhost/schema.json#L1143-L1163: update copilot.byok.allowPrivateEndpoint to use the new “AI BYOK” terminology.
• packages/frontend/admin/src/config.json#L370-L382: apply the same wording to the admin metadata.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.docker/selfhost/schema.json around lines 1143 - 1163, Update the
descriptions for copilot.byok.allowPrivateEndpoint in
.docker/selfhost/schema.json (lines 1143-1163) and
packages/frontend/admin/src/config.json (lines 370-382) to consistently use the
“AI BYOK” terminology, without changing the setting behavior or metadata
structure.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.docker/selfhost/compose.yml:
- Around line 16-20: Update the Compose template’s storage mount paths and
database connection settings to preserve existing installation overrides while
retaining the current values as defaults. Apply the same compatibility treatment
to the corresponding sections referenced at lines 28–33 and 55–62, and ensure
upgrades do not silently switch to empty local directories or default database
credentials.
- Around line 6-7: Restore the configurable host-port override in the compose
service’s ports mapping, preserving the existing default of 3010 while allowing
deployments to supply PORT. Keep the container port fixed at 3010 and apply the
override only to the host-side port.

In @.docker/selfhost/config.json.example:
- Line 2: Update the $schema value in the configuration example to reference the
release-local config.schema.json (or an equivalent versioned schema URL) instead
of the moving releases/latest artifact, ensuring older bundles validate against
their shipped schema.

---

Outside diff comments:
In @.docker/selfhost/schema.json:
- Around line 1143-1163: Update the descriptions for
copilot.byok.allowPrivateEndpoint in .docker/selfhost/schema.json (lines
1143-1163) and packages/frontend/admin/src/config.json (lines 370-382) to
consistently use the “AI BYOK” terminology, without changing the setting
behavior or metadata structure.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 076388bb-9e9d-4808-b939-e50eaa39b34d

📥 Commits

Reviewing files that changed from the base of the PR and between 0d889bc and 3fe75c3.

📒 Files selected for processing (12)

• .docker/selfhost/.env.example
• .docker/selfhost/compose.yml
• .docker/selfhost/config.json.example
• .docker/selfhost/schema.json
• .github/workflows/release-desktop.yml
• packages/backend/server/src/plugins/copilot/config.ts
• packages/frontend/admin/src/app.tsx
• packages/frontend/admin/src/config.json
• packages/frontend/admin/src/modules/ai/index.tsx
• packages/frontend/admin/src/modules/ai/keys.tsx
• packages/frontend/admin/src/modules/nav/nav.tsx
• packages/frontend/admin/src/modules/settings/config.ts

💤 Files with no reviewable changes (4)

• .docker/selfhost/.env.example
• packages/frontend/admin/src/modules/ai/index.tsx
• packages/frontend/admin/src/modules/nav/nav.tsx
• packages/frontend/admin/src/modules/ai/keys.tsx

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.02%. Comparing base (0d889bc) to head (3fe75c3).

Additional details and impacted files

@@            Coverage Diff             @@
##           canary   #15344      +/-   ##
==========================================
+ Coverage   60.81%   61.02%   +0.21%     
==========================================
  Files        3320     3320              
  Lines      192687   192687              
  Branches    28477    28518      +41     
==========================================
+ Hits       117187   117592     +405     
+ Misses      71632    71246     -386     
+ Partials     3868     3849      -19     

Flag	Coverage Δ
server-test	80.98% <100.00%> (+0.28%)	⬆️
unittest	36.13% <ø> (-0.03%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.