From 6f423b75f3b17a86b749b430ee9ccd3137517674 Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Fri, 14 Nov 2025 10:19:24 +0800 Subject: [PATCH] doc: complete settings.md --- docs/en/deploy/settings.md | 71 ++++++++++++++++++++++++++++---------- docs/zh/deploy/settings.md | 69 ++++++++++++++++++++++++++---------- 2 files changed, 102 insertions(+), 38 deletions(-) diff --git a/docs/en/deploy/settings.md b/docs/en/deploy/settings.md index f3afc4320..de10ac712 100644 --- a/docs/en/deploy/settings.md +++ b/docs/en/deploy/settings.md @@ -34,25 +34,23 @@ concurrency: # Single session concurrency session: 1 -# Proxy configuration -proxy: - # HTTP proxy address - # If proxy is already set in environment variables, no configuration is needed - # For example: - # proxy: - # http: 'http://127.0.0.1:7890' - # https: 'http://127.0.0.1:7890' - http: '' - https: '' - -# System configuration -system: - # JWT configuration - jwt: - # JWT expiration time in seconds - expire: 604800 - # JWT secret key, a key will be automatically generated on first startup - secret: 'xxxx' +# Database configuration +database: + # The database to use + # Supported databases: + # - sqlite (local SQLite database, default) + # - postgresql (PostgreSQL database, please configure below) + use: sqlite + # SQLite configuration + sqlite: + path: 'data/langbot.db' + # PostgreSQL configuration + postgresql: + host: '127.0.0.1' + port: 5432 + database: 'postgres' + user: 'postgres' + password: 'postgres' # Plugin system configuration plugin: @@ -67,6 +65,41 @@ plugin: # Plugin marketplace URL cloud_service_url: 'https://space.langbot.app' +# Proxy configuration +proxy: + # HTTP proxy address + # If proxy is already set in environment variables, no configuration is needed + # For example: + # proxy: + # http: 'http://127.0.0.1:7890' + # https: 'http://127.0.0.1:7890' + http: '' + https: '' + +# Object storage configuration +storage: + # The object storage to use + # Supported object storage: + # - local (local storage, default) + # - s3 (S3 protocol object storage, supports R2, MinIO, etc. Please configure below) + use: local + # S3 configuration + s3: + endpoint_url: '' + access_key_id: '' + secret_access_key: '' + region: 'us-east-1' + bucket: 'langbot-storage' + +# System configuration +system: + # JWT configuration + jwt: + # JWT expiration time in seconds + expire: 604800 + # JWT secret key, a key will be automatically generated on first startup + secret: 'xxxx' + # Vector database configuration vdb: # The vector database to use diff --git a/docs/zh/deploy/settings.md b/docs/zh/deploy/settings.md index 7f80b677d..6419aeec7 100644 --- a/docs/zh/deploy/settings.md +++ b/docs/zh/deploy/settings.md @@ -34,25 +34,21 @@ concurrency: # 单会话并发数 session: 1 -# 代理配置 -proxy: - # HTTP 代理地址 - # 如果已经在环境变量设置了代理,则不需要配置 - # 例如: - # proxy: - # http: 'http://127.0.0.1:7890' - # https: 'http://127.0.0.1:7890' - http: '' - https: '' - -# 系统配置 -system: - # JWT 配置 - jwt: - # JWT 过期时间,单位为秒 - expire: 604800 - # JWT 密钥,首次启动时会自动生成一个密钥 - secret: 'xxxx' +# 数据库配置 +database: + # 所使用的数据库 + # 支持的数据库: + # - sqlite(本地 SQLite 数据库,默认) + # - postgresql(PostgreSQL 数据库,请在下方配置) + use: sqlite + sqlite: + path: 'data/langbot.db' + postgresql: + host: '127.0.0.1' + port: 5432 + user: 'postgres' + password: 'postgres' + database: 'postgres' # 插件系统配置 plugin: @@ -67,6 +63,41 @@ plugin: # 插件市场 URL cloud_service_url: 'https://space.langbot.app' +# 代理配置 +proxy: + # HTTP 代理地址 + # 如果已经在环境变量设置了代理,则不需要配置 + # 例如: + # proxy: + # http: 'http://127.0.0.1:7890' + # https: 'http://127.0.0.1:7890' + http: '' + https: '' + +# 对象存储配置 +storage: + # 所使用的对象存储 + # 支持的对象存储: + # - local(本地存储,默认) + # - s3(S3 协议对象存储,支持 R2、MinIO 等兼容 S3 协议的对象存储服务,请在下方配置) + use: local + # S3 配置 + s3: + endpoint_url: '' + access_key_id: '' + secret_access_key: '' + region: 'us-east-1' + bucket: 'langbot-storage' + +# 系统配置 +system: + # JWT 配置 + jwt: + # JWT 过期时间,单位为秒 + expire: 604800 + # JWT 密钥,首次启动时会自动生成一个密钥 + secret: 'xxxx' + # 向量数据库配置 vdb: # 所使用的向量数据库