178 lines
4.4 KiB
Markdown
178 lines
4.4 KiB
Markdown
# 配置说明
|
||
|
||
## 完整配置文件
|
||
|
||
```ini
|
||
[app]
|
||
JwtSecret = message-nest
|
||
; 暂时无用
|
||
RuntimeRootPath = runtime/
|
||
LogLevel = INFO
|
||
; 首次运行时初始化数据，设置为enable启用
|
||
; InitData = enable
|
||
|
||
[server]
|
||
; debug or release
|
||
; debug模式下会自动添加跨域headers
|
||
RunMode = release
|
||
HttpPort = 8000
|
||
ReadTimeout = 60
|
||
WriteTimeout = 60
|
||
; use embed html static file
|
||
; 是否使用embed打包的静态资源
|
||
; 如果运行release打包后的应用，请注释这个设置。
|
||
; 如果取消这个注释，只会单独运行api服务，前端页面需要到web目录手动npm run dev, 运行前端服务
|
||
; EmbedHtml = disable
|
||
; URL路径前缀，用于子路径部署，如：/message
|
||
; UrlPrefix = /message
|
||
|
||
[database]
|
||
; 配置使用什么数据库，支持：mysql、sqlite、tidb
|
||
Type = mysql
|
||
User = root
|
||
Password = password
|
||
Host = 123.1.1.1
|
||
Name = db_name
|
||
Port = 3306
|
||
; -- 其他配置
|
||
; 表前缀
|
||
TablePrefix = message_
|
||
; -- 是否打开sql打印
|
||
; SqlDebug = enable
|
||
; 数据库连接是否开启ssl, value: [false | true]
|
||
Ssl = true
|
||
```
|
||
|
||
## 配置项说明
|
||
|
||
### [app] 应用配置
|
||
|
||
| 配置项 | 说明 | 默认值 |
|
||
|--------|------|--------|
|
||
| JwtSecret | JWT密钥，用于token生成 | message-nest |
|
||
| RuntimeRootPath | 运行时根路径（暂时无用） | runtime/ |
|
||
| LogLevel | 日志级别：DEBUG/INFO/ERROR | INFO |
|
||
| InitData | 首次运行时初始化数据，设置为enable启用 | - |
|
||
|
||
### [server] 服务器配置
|
||
|
||
| 配置项 | 说明 | 默认值 |
|
||
|--------|------|--------|
|
||
| RunMode | 运行模式：debug/release，debug模式会自动添加跨域 | release |
|
||
| HttpPort | HTTP服务端口 | 8000 |
|
||
| ReadTimeout | 读取超时时间（秒） | 60 |
|
||
| WriteTimeout | 写入超时时间（秒） | 60 |
|
||
| EmbedHtml | 是否使用embed打包的静态资源，注释则启用单应用模式 | - |
|
||
| UrlPrefix | URL路径前缀，用于子路径部署，如：/message | - |
|
||
|
||
### [database] 数据库配置
|
||
|
||
| 配置项 | 说明 | 默认值 |
|
||
|--------|------|--------|
|
||
| Type | 数据库类型：mysql/sqlite/tidb | mysql |
|
||
| User | 数据库用户名 | - |
|
||
| Password | 数据库密码 | - |
|
||
| Host | 数据库主机地址 | - |
|
||
| Port | 数据库端口 | 3306 |
|
||
| Name | 数据库名称 | - |
|
||
| TablePrefix | 数据表前缀 | message_ |
|
||
| SqlDebug | 是否打印SQL，设置enable开启 | - |
|
||
| Ssl | 数据库连接是否开启SSL | false |
|
||
|
||
## Docker 环境变量
|
||
|
||
使用Docker部署时，可以通过环境变量进行配置：
|
||
|
||
| 变量 | 说明 |
|
||
|------|------|
|
||
| JWT_SECRET | jwt秘钥，可选，默认为message-nest |
|
||
| LOG_LEVEL | 日志等级，可选，默认为INFO，DEBUG/INFO/ERROR |
|
||
| RUN_MODE | 运行模式，可选，默认release，为debug将自动添加跨域 |
|
||
| URL_PREFIX | URL路径前缀，用于子路径部署，如：/message |
|
||
| DB_TYPE | 数据库类型，sqlite/mysql。默认为sqlite,存储路径为conf/database.db |
|
||
| MYSQL_HOST | mysql-host，DB_TYPE=mysql必填 |
|
||
| MYSQL_PORT | mysql端口，DB_TYPE=mysql必填 |
|
||
| MYSQL_USER | mysql用户名，DB_TYPE=mysql必填 |
|
||
| MYSQL_PASSWORD | mysql数据库密码，DB_TYPE=mysql必填 |
|
||
| MYSQL_DB | mysql数据库名字，DB_TYPE=mysql必填 |
|
||
| MYSQL_TABLE_PREFIX | mysql数据表前缀，DB_TYPE=mysql必填 |
|
||
| SSL | 是否开启SSL |
|
||
| SQL_DEBUG | 是否打印SQL，可选，默认关，设置enable为开启 |
|
||
|
||
## 配置示例
|
||
|
||
### 单应用模式（推荐）
|
||
|
||
```ini
|
||
[app]
|
||
JwtSecret = message-nest
|
||
LogLevel = INFO
|
||
|
||
[server]
|
||
RunMode = release
|
||
HttpPort = 8000
|
||
ReadTimeout = 60
|
||
WriteTimeout = 60
|
||
; 注释EmbedHtml，启用单应用模式
|
||
; EmbedHtml = disable
|
||
|
||
[database]
|
||
; 关闭SQL打印
|
||
; SqlDebug = enable
|
||
|
||
Type = mysql
|
||
User = root
|
||
Password = Aa123456
|
||
Host = vm.server
|
||
Port = 3308
|
||
Name = yourDbName
|
||
TablePrefix = message_
|
||
```
|
||
|
||
### 开发调试模式
|
||
|
||
```ini
|
||
[app]
|
||
JwtSecret = message-nest
|
||
LogLevel = INFO
|
||
|
||
[server]
|
||
; RunMode务必设置成debug，会自动添加跨域
|
||
RunMode = debug
|
||
HttpPort = 8000
|
||
ReadTimeout = 60
|
||
WriteTimeout = 60
|
||
; 取消EmbedHtml的注释（启用前后端分离），然后到web目录下面，npm run dev启动前端页面
|
||
EmbedHtml = disable
|
||
|
||
[database]
|
||
; 开启SQL打印
|
||
SqlDebug = enable
|
||
|
||
Type = mysql
|
||
User = root
|
||
Password = Aa123456
|
||
Host = vm.server
|
||
Port = 3308
|
||
Name = yourDbName
|
||
TablePrefix = message_
|
||
```
|
||
|
||
### SQLite 配置
|
||
|
||
```ini
|
||
[app]
|
||
JwtSecret = message-nest
|
||
LogLevel = INFO
|
||
|
||
[server]
|
||
RunMode = release
|
||
HttpPort = 8000
|
||
ReadTimeout = 60
|
||
WriteTimeout = 60
|
||
|
||
[database]
|
||
Type = sqlite
|
||
TablePrefix = message_
|
||
```
|