Skip to content

配置文件标准

优秀的小杨同学 edited this page Jul 2, 2023 · 4 revisions

配置文件标准

配置文件是 Sonolus 服务器运行时的相关信息,您可以通过修改配置文件来修改 Sonolus 服务器的运行时行为。

请注意,由于本服务器不具备热重载功能,因此每次修改配置文件后,您都需要重新启动服务来使配置文件生效。

基础配置文件

在文件 config/config.json 中:

  • database: 数据库类型,可选 mysqlsqlite
  • mysql.hostname: MySQL 服务器监听地址。
  • mysql.port: MySQL 服务器监听端口。
  • mysql.username: MySQL 用户名。
  • mysql.password: MySQL 用户密码。
  • mysql.database: MySQL 目标数据库名。
  • sqlite.dbfile: SQLite 数据库文件位置。
  • server.listenHost: WebServer Core 监听地址。
  • server.listenPort: WebServer Core 监听端口。
  • server.enableSSL: 指定服务器是否启用 HTTPS。
  • server.httpsCacert: 服务器 CA 证书。
  • server.httpsPrivate: 服务器私钥。
  • server.threadNumber: 服务器运行线程数。
  • logSystem.debug: 指定是否输出 DEBUG 信息。
  • logSystem.target: 指定日志输出位置。0 为不输出,1 为输出在控制台,2 为文件输出,3 为二者皆有。
  • logSystem.targetFile: 日志文件地址。
  • sonolus.version: 服务器适配的 Sonolus 版本。
  • session.expireTime: 会话过期时间。
  • export.retryTime: 访问远程服务器时重试次数。

Web 端配置文件

在文件 config/*_config.json 中:

  • server.name: Sonolus 服务器副标题。
  • server.title: Sonolus 服务器标题。
  • server.description: Sonolus 服务器描述。
  • server.logo: Sonolus 网站图标文件地址。
  • server.bannerUrl: Sonolus 网站导航图地址。
  • server.bannerHash: Sonolus 网站导航图 sha1 代码。
  • server.rootUrl: Sonolus 服务器域名/ip地址。
  • server.auth.title: Sonolus 登录服务器地址。
  • server.auth.logo: Sonolus 登录服务器图标文件地址。
  • server.auth.bannerUrl: Sonolus 登录服务器导航图地址。
  • server.auth.bannerHash: Sonolus 登录服务器导航图 sha1 代码。
  • language.default: 网站默认语言。

自定义搜索配置文件

在文件 config/*_search.json 中:

  • options: 一个 Search 类型的搜索选项。Search 类型结构见 Search 类

自定义资源创建配置文件

  • options: 一个 Search 类型的资源创建选项。Search 类型结构见 Search 类