From b6eaa4b061e222fc0a3532b0369d028762ad079c Mon Sep 17 00:00:00 2001 From: lejianwen <84855512@qq.com> Date: Sun, 25 May 2025 17:44:29 +0800 Subject: [PATCH] docs: Readme --- README.md | 3 +++ README_EN.md | 3 +++ docs/admin/admin_docs.go | 2 +- docs/api/api_docs.go | 2 +- 4 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dae9062..25d1c0d 100644 --- a/README.md +++ b/README.md @@ -163,6 +163,9 @@ | RUSTDESK_API_APP_SHOW_SWAGGER | 是否可见swagger文档;`1`显示,`0`不显示,默认`0`不显示 | `1` | | RUSTDESK_API_APP_TOKEN_EXPIRE | token有效时长 | `168h` | | RUSTDESK_API_APP_DISABLE_PWD_LOGIN | 是否禁用密码登录; `true`, `false` 默认`false` | `false` | +| RUSTDESK_API_APP_REGISTER_STATUS | 注册用户默认状态; 1 启用,2 禁用, 默认 1 | `1` | +| RUSTDESK_API_APP_CAPTCHA_THRESHOLD | 验证码触发次数; -1 不启用, 0 一直启用, >0 登录错误次数后启用 ;默认 `3` | `3` | +| RUSTDESK_API_APP_BAN_THRESHOLD | 封禁IP触发次数; 0 不启用, >0 登录错误次数后封禁IP; 默认 `0` | `0` | | -----ADMIN配置----- | ---------- | ---------- | | RUSTDESK_API_ADMIN_TITLE | 后台标题 | `RustDesk Api Admin` | | RUSTDESK_API_ADMIN_HELLO | 后台欢迎语,可以使用`html` | | diff --git a/README_EN.md b/README_EN.md index d1db922..3a936c0 100644 --- a/README_EN.md +++ b/README_EN.md @@ -162,6 +162,9 @@ The table below does not list all configurations. Please refer to the configurat | RUSTDESK_API_APP_SHOW_SWAGGER | swagger visible; 1: yes, 0: no; default: 0 | `0` | | RUSTDESK_API_APP_TOKEN_EXPIRE | token expire duration | `168h` | | RUSTDESK_API_APP_DISABLE_PWD_LOGIN | disable password login | `false` | +| RUSTDESK_API_APP_REGISTER_STATUS | register user default status ; 1 enabled , 2 disabled ; default 1 | `1` | +| RUSTDESK_API_APP_CAPTCHA_THRESHOLD | captcha threshold; -1 disabled, 0 always enable, >0 threshold ;default `3` | `3` | +| RUSTDESK_API_APP_BAN_THRESHOLD | ban ip threshold; 0 disabled, >0 threshold ; default `0` | `0` | | ----- ADMIN Configuration----- | ---------- | ---------- | | RUSTDESK_API_ADMIN_TITLE | Admin Title | `RustDesk Api Admin` | | RUSTDESK_API_ADMIN_HELLO | Admin welcome message, you can use `html` | | diff --git a/docs/admin/admin_docs.go b/docs/admin/admin_docs.go index 5fa6476..57d2a94 100644 --- a/docs/admin/admin_docs.go +++ b/docs/admin/admin_docs.go @@ -1,4 +1,4 @@ -// Package admin Code generated by swaggo/swag. DO NOT EDIT +// Package admin Content generated by swaggo/swag. DO NOT EDIT package admin import "github.com/swaggo/swag" diff --git a/docs/api/api_docs.go b/docs/api/api_docs.go index 75c49cf..631ba24 100644 --- a/docs/api/api_docs.go +++ b/docs/api/api_docs.go @@ -1,4 +1,4 @@ -// Package api Code generated by swaggo/swag. DO NOT EDIT +// Package api Content generated by swaggo/swag. DO NOT EDIT package api import "github.com/swaggo/swag"