Skip to content

Commit 7d6f89a

Browse files
committed
update docs
1 parent 85fc8c7 commit 7d6f89a

File tree

1 file changed

+90
-18
lines changed

1 file changed

+90
-18
lines changed

docs/backend/reference/conf.md

Lines changed: 90 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,11 @@ token 加密算法
116116

117117
### `TOKEN_EXPIRE_SECONDS` <Badge type="info" text="int" />
118118

119-
token 过期时长
119+
token 过期时长(秒)
120120

121121
### `TOKEN_REFRESH_EXPIRE_SECONDS` <Badge type="info" text="int" />
122122

123-
刷新 token 过期时长
123+
刷新 token 过期时长(秒)
124124

125125
### `TOKEN_REDIS_PREFIX` <Badge type="info" text="str" />
126126

@@ -151,6 +151,62 @@ fba 内通过 JWT 中间件解析 token 获取用户信息,并将用户信息
151151

152152
JWT / RBAC 路由白名单正则模式,从路由头部开始匹配,与之匹配的请求地址将不会校验 token 真伪性,注意项同上
153153

154+
## 用户安全配置
155+
156+
### `USER_LOCK_REDIS_PREFIX` <Badge type="info" text="str" />
157+
158+
用户锁定存储到 Redis 时的前缀
159+
160+
### `USER_LOCK_THRESHOLD` <Badge type="info" text="int" />
161+
162+
用户密码错误锁定阈值,0 表示禁用锁定
163+
164+
### `USER_LOCK_SECONDS` <Badge type="info" text="int" />
165+
166+
用户锁定时长(秒)
167+
168+
### `USER_PASSWORD_EXPIRY_DAYS` <Badge type="info" text="int" />
169+
170+
用户密码有效期,0 表示永不过期
171+
172+
### `USER_PASSWORD_REMINDER_DAYS` <Badge type="info" text="int" />
173+
174+
用户密码到期提醒,0 表示不提醒
175+
176+
### `USER_PASSWORD_HISTORY_CHECK_COUNT` <Badge type="info" text="int" />
177+
178+
用户密码历史检查数量,避免重复使用历史密码
179+
180+
### `USER_PASSWORD_MIN_LENGTH` <Badge type="info" text="int" />
181+
182+
用户密码最小长度
183+
184+
### `USER_PASSWORD_MAX_LENGTH` <Badge type="info" text="int" />
185+
186+
用户密码最大长度
187+
188+
### `USER_PASSWORD_REQUIRE_SPECIAL_CHAR` <Badge type="info" text="bool" />
189+
190+
用户密码需要特殊字符
191+
192+
## 登录配置
193+
194+
### `LOGIN_CAPTCHA_REDIS_PREFIX` <Badge type="info" text="str" />
195+
196+
登录验证码存储到 Redis 时的前缀
197+
198+
### `LOGIN_CAPTCHA_EXPIRE_SECONDS` <Badge type="info" text="int" />
199+
200+
登录验证码过期时长(秒)
201+
202+
### `LOGIN_CAPTCHA_ENABLED` <Badge type="info" text="bool" />
203+
204+
是否开始登录验证码
205+
206+
### `LOGIN_FAILURE_PREFIX` <Badge type="info" text="str" />
207+
208+
登录失败存储到 Redis 时的前缀
209+
154210
## JWT 配置
155211

156212
### `JWT_USER_REDIS_PREFIX` <Badge type="info" text="str" />
@@ -177,17 +233,7 @@ JWT 中间件存储用户信息到 Redis 时的前缀
177233

178234
### `COOKIE_REFRESH_TOKEN_EXPIRE_SECONDS` <Badge type="info" text="int" />
179235

180-
将刷新 token 存储到 cookie 时的过期时长
181-
182-
## 验证码配置
183-
184-
### `CAPTCHA_LOGIN_REDIS_PREFIX` <Badge type="info" text="str" />
185-
186-
验证码登录时,验证码存储到 Redis 时的前缀
187-
188-
### `CAPTCHA_LOGIN_EXPIRE_SECONDS` <Badge type="info" text="int" />
189-
190-
验证码登录时,验证码过期时长
236+
将刷新 token 存储到 cookie 时的过期时长(秒)
191237

192238
## 数据权限配置
193239

@@ -203,7 +249,7 @@ JWT 中间件存储用户信息到 Redis 时的前缀
203249

204250
### `WS_NO_AUTH_MARKER` <Badge type="info" text="str" />
205251

206-
连接 socket.io 服务时跳过用户验证的标记,应将其直接定义为 token 值进行传输
252+
连接 socket.io 服务时跳过用户验证的标记
207253

208254
::: danger
209255
请妥善保管此值,以免遭受恶意攻击
@@ -289,7 +335,7 @@ JWT 中间件存储用户信息到 Redis 时的前缀
289335

290336
### `IP_LOCATION_EXPIRE_SECONDS` <Badge type="info" text="int" />
291337

292-
定位信息缓存时长
338+
定位信息缓存时长(秒)
293339

294340
## Trace ID
295341

@@ -382,10 +428,20 @@ JWT 中间件存储用户信息到 Redis 时的前缀
382428

383429
通过 pip 下载插件依赖时的索引地址
384430

431+
### `PLUGIN_PIP_MAX_RETRY` <Badge type="info" text="int" />
432+
433+
pip 下载最大重试次数
434+
385435
### `PLUGIN_REDIS_PREFIX` <Badge type="info" text="str" />
386436

387437
插件信息存储到 Redis 时的前缀
388438

439+
## I18n 配置
440+
441+
### `I18N_DEFAULT_LANGUAGE` <Badge type="info" text="str" />
442+
443+
国际化响应的默认语言
444+
389445
## 应用:Task
390446

391447
### `CELERY_BROKER_REDIS_DATABASE` <Badge type="info" text="int" /> <Badge type="warning" text="env" />
@@ -412,6 +468,10 @@ Celery 连接 RabbitMQ 服务的密码
412468

413469
Celery 代理模式(开发模式默认使用 Redis,线上模式强制切换为 Rabbitmq)
414470

471+
### `CELERY_RABBITMQ_VHOST` <Badge type="info" text="str" />
472+
473+
Celery 连接 RabbitMQ 服务的 vhost
474+
415475
### `CELERY_REDIS_PREFIX` <Badge type="info" text="str" />
416476

417477
Celery 数据存储到 Redis 时的前缀
@@ -422,7 +482,7 @@ Celery 任务执行失败时的最大重试次数
422482

423483
## 插件:Code Generator
424484

425-
#### `CODE_GENERATOR_DOWNLOAD_ZIP_FILENAME` <Badge type="info" text="str" />
485+
### `CODE_GENERATOR_DOWNLOAD_ZIP_FILENAME` <Badge type="info" text="str" />
426486

427487
下载代码时的 ZIP 压缩包文件名
428488

@@ -452,6 +512,14 @@ Linux Do 客户端 ID
452512

453513
Linux Do 客户端密钥
454514

515+
### `OAUTH2_STATE_REDIS_PREFIX` <Badge type="info" text="str" />
516+
517+
OAuth2 状态信息存储到 Redis 时的前缀
518+
519+
### `OAUTH2_STATE_EXPIRE_SECONDS` <Badge type="info" text="str" />
520+
521+
OAuth2 状态信息存储到 Redis 时的过期时间(秒)
522+
455523
### `OAUTH2_GITHUB_REDIRECT_URI` <Badge type="info" text="str" />
456524

457525
GitHub 重定向地址,必须与 GitHub OAuth Apps 配置保持一致
@@ -464,10 +532,14 @@ Google 重定向地址,必须与 Google OAuth 2.0 客户端配置保持一致
464532

465533
Linux Do 重定向地址,必须与 Linux Do Connect 配置保持一致
466534

467-
### `OAUTH2_FRONTEND_REDIRECT_URI` <Badge type="info" text="str" />
535+
### `OAUTH2_FRONTEND_LOGIN_REDIRECT_URI` <Badge type="info" text="str" />
468536

469537
登陆成功后,重定向到前端的地址
470538

539+
### `OAUTH2_FRONTEND_BINDING_REDIRECT_URI` <Badge type="info" text="str" />
540+
541+
绑定成功后,重定向到前端的地址
542+
471543
## 插件:Email
472544

473545
### `EMAIL_USERNAME` <Badge type="info" text="str" />
@@ -496,4 +568,4 @@ Linux Do 重定向地址,必须与 Linux Do Connect 配置保持一致
496568

497569
### `EMAIL_CAPTCHA_EXPIRE_SECONDS` <Badge type="info" text="int" />
498570

499-
电子邮件验证码缓存时长
571+
电子邮件验证码缓存时长(秒)

0 commit comments

Comments
 (0)