chore: update config template (#15344)

.docker/selfhost/.env.example

@@ -1,23 +0,0 @@
-# select a revision to deploy, available values: stable, beta, canary
-AFFINE_REVISION=stable
-
-# set the port for the server container it will expose the server on
-PORT=3010
-
-# set the host for the server for outgoing links
-# AFFINE_SERVER_HTTPS=true
-# AFFINE_SERVER_HOST=affine.yourdomain.com
-# or 
-# AFFINE_SERVER_EXTERNAL_URL=https://affine.yourdomain.com
-
-# position of the database data to persist
-DB_DATA_LOCATION=~/.affine/self-host/postgres/pgdata
-# position of the upload data(images, files, etc.) to persist
-UPLOAD_LOCATION=~/.affine/self-host/storage
-# position of the configuration files to persist
-CONFIG_LOCATION=~/.affine/self-host/config
-
-# database credentials
-DB_USERNAME=affine
-DB_PASSWORD=
-DB_DATABASE=affine

.docker/selfhost/compose.yml

@@ -1,10 +1,10 @@
 name: affine
 services:
   affine:
-    image: ghcr.io/toeverything/affine:${AFFINE_REVISION:-stable}
+    image: ghcr.io/toeverything/affine:stable
     container_name: affine_server
     ports:
-      - '${PORT:-3010}:3010'
+      - '3010:3010'
     depends_on:
       redis:
         condition: service_healthy
@@ -13,30 +13,24 @@ services:
       affine_migration:
         condition: service_completed_successfully
     volumes:
-      # custom configurations
-      - ${UPLOAD_LOCATION}:/root/.affine/storage
-      - ${CONFIG_LOCATION}:/root/.affine/config
-    env_file:
-      - .env
+      - ./data/storage:/root/.affine/storage
+      - ./config:/root/.affine/config
     environment:
       - REDIS_SERVER_HOST=redis
-      - DATABASE_URL=postgresql://${DB_USERNAME}:${DB_PASSWORD}@postgres:5432/${DB_DATABASE:-affine}
+      - DATABASE_URL=postgresql://affine@postgres:5432/affine
       - AFFINE_INDEXER_ENABLED=false
     restart: unless-stopped
 
   affine_migration:
-    image: ghcr.io/toeverything/affine:${AFFINE_REVISION:-stable}
+    image: ghcr.io/toeverything/affine:stable
     container_name: affine_migration_job
     volumes:
-      # custom configurations
-      - ${UPLOAD_LOCATION}:/root/.affine/storage
-      - ${CONFIG_LOCATION}:/root/.affine/config
+      - ./data/storage:/root/.affine/storage
+      - ./config:/root/.affine/config
     command: ['sh', '-c', 'node ./scripts/self-host-predeploy.js']
-    env_file:
-      - .env
     environment:
       - REDIS_SERVER_HOST=redis
-      - DATABASE_URL=postgresql://${DB_USERNAME}:${DB_PASSWORD}@postgres:5432/${DB_DATABASE:-affine}
+      - DATABASE_URL=postgresql://affine@postgres:5432/affine
       - AFFINE_INDEXER_ENABLED=false
     depends_on:
       postgres:
@@ -58,18 +52,14 @@ services:
     image: pgvector/pgvector:pg16
     container_name: affine_postgres
     volumes:
-      - ${DB_DATA_LOCATION}:/var/lib/postgresql/data
+      - ./data/postgres:/var/lib/postgresql/data
     environment:
-      POSTGRES_USER: ${DB_USERNAME}
-      POSTGRES_PASSWORD: ${DB_PASSWORD}
-      POSTGRES_DB: ${DB_DATABASE:-affine}
+      POSTGRES_USER: affine
+      POSTGRES_DB: affine
       POSTGRES_INITDB_ARGS: '--data-checksums'
-      # you better set a password for you database
-      # or you may add 'POSTGRES_HOST_AUTH_METHOD=trust' to ignore postgres security policy
       POSTGRES_HOST_AUTH_METHOD: trust
     healthcheck:
-      test:
-        ['CMD', 'pg_isready', '-U', "${DB_USERNAME}", '-d', "${DB_DATABASE:-affine}"]
+      test: ['CMD', 'pg_isready', '-U', 'affine', '-d', 'affine']
       interval: 10s
       timeout: 5s
       retries: 5

.docker/selfhost/config.json.example

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://github.com/toeverything/affine/releases/latest/download/config.schema.json",
+  "server": {
+    "name": "AFFiNE Self-hosted",
+    "externalUrl": "http://localhost:3010"
+  },
+  "copilot": {
+    "enabled": true,
+    "byok": {
+      "enabled": true,
+      "allowCustomEndpoint": true
+    }
+  }
+}

.docker/selfhost/schema.json

@@ -1140,17 +1140,17 @@
       "properties": {
         "enabled": {
           "type": "boolean",
-          "description": "Whether to enable the copilot plugin. <br> Document: <a href=\"https://docs.affine.pro/self-host-affine/administer/ai\" target=\"_blank\">https://docs.affine.pro/self-host-affine/administer/ai</a>\n@default false",
+          "description": "Enable AI features. Workspace owners configure provider keys in Workspace Settings → Integrations → AI BYOK.\n@default false",
           "default": false
         },
         "byok.enabled": {
           "type": "boolean",
-          "description": "Whether to enable workspace BYOK.\n@default true",
+          "description": "Allow workspace owners and admins to configure AI provider keys through AI BYOK.\n@default true",
           "default": true
         },
         "byok.allowedProviders": {
           "type": "array",
-          "description": "The allowlist for workspace BYOK providers.\n@default [\"openai\",\"anthropic\",\"gemini\",\"fal\"]",
+          "description": "AI providers that workspace owners and admins may add through AI BYOK.\n@default [\"openai\",\"anthropic\",\"gemini\",\"fal\"]",
           "default": [
             "openai",
             "anthropic",
@@ -1160,7 +1160,7 @@
         },
         "byok.allowCustomEndpoint": {
           "type": "boolean",
-          "description": "Whether workspace BYOK custom endpoints are accepted.\n@default false",
+          "description": "Allow AI BYOK keys to use a custom provider endpoint.\n@default false",
           "default": false
         },
         "byok.allowPrivateEndpoint": {