微语服务器配置参数说明
本文档详细说明微语服务器(基于Spring Boot 3.x开发)的配置参数及其用法。
基础配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
server.port | 服务器端口 | 9003 | SERVER_PORT: 9003 |
bytedesk.debug | 是否开启调试模式 | true | BYTEDESK_DEBUG: true |
bytedesk.edition | 产品版本类型:COMMUNITY(社区版,功能受限)、ENTERPRISE(企业版,付费,功能不限)、PLATFORM(平台版,付费,功能不限) | PLATFORM | BYTEDESK_EDITION: ENTERPRISE |
bytedesk.version | 产品版本号 | 0.7.8 | BYTEDESK_VERSION: 0.7.8 |
bytedesk.appkey | 授权密钥 | ZjoyMDI1LTA2LTExOkNPTU1VTklUWTo6 | BYTEDESK_APPKEY: ZjoyMDI1LTA2LTExOkNPTU1VTklUWTo6 |
自定义配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
bytedesk.custom.enabled | 是否启用自定义配置(名称、logo、说明等) | true | BYTEDESK_CUSTOM_ENABLED: false |
bytedesk.custom.name | 自定义产品名称,默认为空则使用默认名称 | - | BYTEDESK_CUSTOM_NAME: |
bytedesk.custom.logo | 自定义产品logo,默认为空则使用默认logo | - | BYTEDESK_CUSTOM_LOGO: |
bytedesk.custom.description | 自定义产品描述,默认为空则使用"Chat As A Service" | - | BYTEDESK_CUSTOM_DESCRIPTION: |
bytedesk.custom.show-right-corner-chat | 是否显示右下角对话窗口 | false | BYTEDESK_CUSTOM_SHOW_RIGHT_CORNER_CHAT: true |
bytedesk.custom.privacy-policy-url | 隐私政策URL地址 | - | BYTEDESK_CUSTOM_PRIVACY_POLICY_URL: |
bytedesk.custom.terms-of-service-url | 服务条款URL地址 | - | BYTEDESK_CUSTOM_TERMS_OF_SERVICE_URL: |
bytedesk.custom.login-username-enable | 是否启用用户名登录 | true | BYTEDESK_CUSTOM_LOGIN_USERNAME_ENABLE: true |
bytedesk.custom.login-mobile-enable | 是否启用手机号登录 | true | BYTEDESK_CUSTOM_LOGIN_MOBILE_ENABLE: true |
bytedesk.custom.login-email-enable | 是否启用邮箱登录 | false | BYTEDESK_CUSTOM_LOGIN_EMAIL_ENABLE: false |
bytedesk.custom.login-scan-enable | 是否启用扫码登录 | true | BYTEDESK_CUSTOM_LOGIN_SCAN_ENABLE: true |
bytedesk.custom.doc-url-show | 是否显示文档链接 | true | BYTEDESK_CUSTOM_DOC_URL_SHOW: true |
bytedesk.custom.doc-url | 文档URL地址 | https://www.weiyuai.cn/docs/zh-CN/ | BYTEDESK_CUSTOM_DOC_URL: https://www.weiyuai.cn/docs/zh-CN/ |
管理员配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
bytedesk.admin.email | 管理员邮箱 | admin@email.com | BYTEDESK_ADMIN_EMAIL: admin@email.com |
bytedesk.admin.password | 管理员默认密码 | admin | BYTEDESK_ADMIN_PASSWORD: admin |
bytedesk.admin.password-default | 创建/导入成员的默认密码 | 123456 | BYTEDESK_ADMIN_PASSWORD_DEFAULT: 123456 |
bytedesk.admin.nickname | 管理员昵称 | SuperAdmin | BYTEDESK_ADMIN_NICKNAME: SuperAdmin |
bytedesk.admin.mobile | 管理员手机号 | 13345678000 | BYTEDESK_ADMIN_MOBILE: 13345678000 |
bytedesk.admin.mobile-whitelist | 手机号白名单,使用逗号分隔 | 18888888000,18888888001,... | BYTEDESK_ADMIN_MOBILE_WHITELIST: 18888888000,18888888001,18888888002,18888888003,18888888004,18888888005 |
bytedesk.admin.email-whitelist | 邮箱白名单,使用逗号分隔 | 100@email.com,101@email.com,... | BYTEDESK_ADMIN_EMAIL_WHITELIST: 100@email.com,101@email.com,102@email.com,103@email.com,104@email.com,105@email.com |
bytedesk.admin.validate-code | 白名单手机号和邮箱的验证码,否则生成随机6位数字 | 123456 | BYTEDESK_ADMIN_VALIDATE_CODE: 123456 |
bytedesk.admin.allow-register | 是否允许注册新账户 | true | BYTEDESK_FEATURES_ENABLE_REGISTRATION: false |
bytedesk.admin.force-validate-mobile | 是否强制验证手机号 | true | BYTEDESK_ADMIN_FORCE_VALIDATE_MOBILE: true |
bytedesk.admin.force-validate-email | 是否强制验证邮箱 | true | BYTEDESK_ADMIN_FORCE_VALIDATE_EMAIL: true |
成员配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
bytedesk.member.password | 创建/导入成员的默认密码 | 123456 | BYTEDESK_MEMBER_PASSWORD: 123456 |
性能测试配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
bytedesk.testing.enabled | 是否启用性能测试模式 | false | BYTEDESK_TESTING_ENABLED: false |
bytedesk.testing.account-count | 测试账号数量 | 300 | BYTEDESK_TESTING_ACCOUNT_COUNT: 300 |
bytedesk.testing.account-username | 测试账号用户名前缀 | test | BYTEDESK_TESTING_ACCOUNT_USERNAME: test |
bytedesk.testing.account-password | 测试账号密码 | password | BYTEDESK_TESTING_ACCOUNT_PASSWORD: password |
bytedesk.testing.disable-captcha | 是否禁用验证码 | true | BYTEDESK_TESTING_DISABLE_CAPTCHA: true |
bytedesk.testing.disable-ip-filter | 是否禁用IP过滤 | true | BYTEDESK_TESTING_DISABLE_IP_FILTER: true |
组织配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
bytedesk.organization.name | 组织名称 | MyCompany | BYTEDESK_ORGANIZATION_NAME: MyCompany |
bytedesk.organization.code | 组织代码 | bytedesk | BYTEDESK_ORGANIZATION_CODE: bytedesk |
功能特性配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
bytedesk.features.java-ai | 是否启用Java AI功能 | true | BYTEDESK_FEATURES_JAVA_AI: false |
bytedesk.features.python-ai | 是否启用Python AI功能 | false | BYTEDESK_FEATURES_PYTHON_AI: true |
bytedesk.features.email-type | 邮件发送方式,可选:javamail /aliyun | javamail | BYTEDESK_FEATURES_EMAIL_TYPE: javamail |
bytedesk.features.avatar-base-url | 头像基础URL | - | BYTEDESK_FEATURES_AVATAR_BASE_URL: |
跨域配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
bytedesk.cors.allowed-origins | 允许的跨域来源 | * | BYTEDESK_CORS_ALLOWED_ORIGINS: * |
JWT配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
bytedesk.jwt.secret-key | JWT密钥 | 1dfaf8d004207b628a9a6b859c429f49a9a7ead9fd8161c1e60847aeef06dbd2 | BYTEDESK_JWT_SECRET_KEY: 1dfaf8d004207b628a9a6b859c429f49a9a7ead9fd8161c1e60847aeef06dbd2 |
bytedesk.jwt.expiration | JWT过期时间(毫秒),默认30天 | 2592000000 | BYTEDESK_JWT_EXPIRATION: 2592000000 |
bytedesk.jwt.refresh-token-expiration | 刷新令牌过期时间(毫秒),默认60天 | 5184000000 | BYTEDESK_JWT_REFRESH_TOKEN_EXPIRATION: 5184000000 |
缓存配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
bytedesk.cache.level | 缓存级别:0(不使用缓存)、1(使用Caffeine缓存)、2(使用Caffeine + Redis缓存) | 0 | BYTEDESK_CACHE_LEVEL: 0 |
bytedesk.cache.prefix | 缓存前缀 | bytedeskim | BYTEDESK_CACHE_PREFIX: bytedeskim |
bytedesk.cache.redis-stream-key | Redis流键名 | bytedeskim:stream | BYTEDESK_CACHE_REDIS_STREAM_KEY: bytedeskim:stream |
上传配置
参数名 | 说明 | 示例值 | Docker环境变量 |
---|---|---|---|
bytedesk.upload.type | 上传类型 | local | BYTEDESK_UPLOAD_TYPE: local |
bytedesk.upload.dir | 上传目录(请首先在服务器创建文件夹,路径末尾不能添加'/') | /var/www/html/weiyuai/file | BYTEDESK_UPLOAD_DIR: /var/www/html/weiyuai/file |
bytedesk.upload.url | 外部访问上传文件URL(需要将域名替换为自己域名) | https://www.weiyuai.cn | BYTEDESK_UPLOAD_URL: https://www.weiyuai.cn |
上传配置URL组成说明
完整的上传文件URL实例:https://www.weiyuai.cn/file/2025/05/21/20250521112410_pigeon_blue.png
其中:
https://www.weiyuai.cn
对应bytedesk.upload.url
配置值/file
对应bytedesk.upload.dir
配置的最后一级目录名/2025/05/21/20250521112410_pigeon_blue.png
为系统自动生成的文件存储路径和文件名