diff --git a/README.md b/README.md index bb004c2..65c2f97 100644 --- a/README.md +++ b/README.md @@ -205,32 +205,37 @@ proxy: ### 环境变量 变量名前缀是`RUSTDESK_API`,环境变量如果存在将覆盖配置文件中的配置 -| 变量名 | 说明 | 示例 | -|------------------------------------|--------------------------------------|-----------------------------| -| TZ | 时区 | Asia/Shanghai | -| RUSTDESK_API_LANG | 语言 | `en`,`zh-CN` | -| RUSTDESK_API_APP_WEB_CLIENT | 是否启用web-client; 1:启用,0:不启用; 默认启用 | 1 | -| RUSTDESK_API_APP_REGISTER | 是否开启注册; `true`, `false` 默认`false` | `false` | -| -----GIN配置----- | ---------- | ---------- | -| RUSTDESK_API_GIN_TRUST_PROXY | 信任的代理IP列表,以`,`分割,默认信任所有 | 192.168.1.2,192.168.1.3 | -| -----------GORM配置---------------- | ------------------------------------ | --------------------------- | -| RUSTDESK_API_GORM_TYPE | 数据库类型sqlite或者mysql,默认sqlite | sqlite | -| RUSTDESK_API_GORM_MAX_IDLE_CONNS | 数据库最大空闲连接数 | 10 | -| RUSTDESK_API_GORM_MAX_OPEN_CONNS | 数据库最大打开连接数 | 100 | -| RUSTDESK_API_RUSTDESK_PERSONAL | 是否启用个人版API, 1:启用,0:不启用; 默认启用 | 1 | -| -----MYSQL配置----- | ---------- | ---------- | -| RUSTDESK_API_MYSQL_USERNAME | mysql用户名 | root | -| RUSTDESK_API_MYSQL_PASSWORD | mysql密码 | 111111 | -| RUSTDESK_API_MYSQL_ADDR | mysql地址 | 192.168.1.66:3306 | -| RUSTDESK_API_MYSQL_DBNAME | mysql数据库名 | rustdesk | -| -----RUSTDESK配置----- | --------------- | ---------- | -| RUSTDESK_API_RUSTDESK_ID_SERVER | Rustdesk的id服务器地址 | 192.168.1.66:21116 | -| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk的relay服务器地址 | 192.168.1.66:21117 | -| RUSTDESK_API_RUSTDESK_API_SERVER | Rustdesk的api服务器地址 | http://192.168.1.66:21114 | -| RUSTDESK_API_RUSTDESK_KEY | Rustdesk的key | 123456789 | -| ----PROXY配置----- | --------------- | ---------- | -| RUSTDESK_API_PROXY_ENABLE | 是否启用代理:`false`, `true` | `false` | -| RUSTDESK_API_PROXY_HOST | 代理地址 | `http://127.0.0.1:1080` | +| 变量名 | 说明 | 示例 | +|------------------------------------|---------------------------------------------------------|------------------------------| +| TZ | 时区 | Asia/Shanghai | +| RUSTDESK_API_LANG | 语言 | `en`,`zh-CN` | +| RUSTDESK_API_APP_WEB_CLIENT | 是否启用web-client; 1:启用,0:不启用; 默认启用 | 1 | +| RUSTDESK_API_APP_REGISTER | 是否开启注册; `true`, `false` 默认`false` | `false` | +| -----ADMIN配置----- | ---------- | ---------- | +| RUSTDESK_API_ADMIN_TITLE | 后台标题 | `RustDesk Api Admin` | +| RUSTDESK_API_ADMIN_HELLO | 后台欢迎语,可以使用`html` | | +| RUSTDESK_API_ADMIN_HELLO_FILE | 后台欢迎语文件,如果内容多,使用文件更方便。
会覆盖`RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html` | +| -----GIN配置----- | ---------- | ---------- | +| RUSTDESK_API_GIN_TRUST_PROXY | 信任的代理IP列表,以`,`分割,默认信任所有 | 192.168.1.2,192.168.1.3 | +| -----------GORM配置---------------- | ------------------------------------ | --------------------------- | +| RUSTDESK_API_GORM_TYPE | 数据库类型sqlite或者mysql,默认sqlite | sqlite | +| RUSTDESK_API_GORM_MAX_IDLE_CONNS | 数据库最大空闲连接数 | 10 | +| RUSTDESK_API_GORM_MAX_OPEN_CONNS | 数据库最大打开连接数 | 100 | +| RUSTDESK_API_RUSTDESK_PERSONAL | 是否启用个人版API, 1:启用,0:不启用; 默认启用 | 1 | +| -----MYSQL配置----- | ---------- | ---------- | +| RUSTDESK_API_MYSQL_USERNAME | mysql用户名 | root | +| RUSTDESK_API_MYSQL_PASSWORD | mysql密码 | 111111 | +| RUSTDESK_API_MYSQL_ADDR | mysql地址 | 192.168.1.66:3306 | +| RUSTDESK_API_MYSQL_DBNAME | mysql数据库名 | rustdesk | +| -----RUSTDESK配置----- | --------------- | ---------- | +| RUSTDESK_API_RUSTDESK_ID_SERVER | Rustdesk的id服务器地址 | 192.168.1.66:21116 | +| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk的relay服务器地址 | 192.168.1.66:21117 | +| RUSTDESK_API_RUSTDESK_API_SERVER | Rustdesk的api服务器地址 | http://192.168.1.66:21114 | +| RUSTDESK_API_RUSTDESK_KEY | Rustdesk的key | 123456789 | +| RUSTDESK_API_RUSTDESK_KEY_FILE | Rustdesk存放key的文件 | `./conf/data/id_ed25519.pub` | +| ----PROXY配置----- | --------------- | ---------- | +| RUSTDESK_API_PROXY_ENABLE | 是否启用代理:`false`, `true` | `false` | +| RUSTDESK_API_PROXY_HOST | 代理地址 | `http://127.0.0.1:1080` | ### 运行 diff --git a/README_EN.md b/README_EN.md index f64b1e6..97d7680 100644 --- a/README_EN.md +++ b/README_EN.md @@ -210,32 +210,37 @@ proxy: ### Environment Variables The prefix for variable names is `RUSTDESK_API`. If environment variables exist, they will override the configurations in the configuration file. -| Variable Name | Description | Example | -|------------------------------------|-----------------------------------------------------------|-------------------------------| -| TZ | timezone | Asia/Shanghai | -| RUSTDESK_API_LANG | Language | `en`,`zh-CN` | -| RUSTDESK_API_APP_WEB_CLIENT | web client on/off; 1: on, 0 off, deault 1 | 1 | -| RUSTDESK_API_APP_REGISTER | register enable; `true`, `false`; default:`false` | `false` | -| ----- GIN Configuration ----- | --------------------------------------- | ----------------------------- | -| RUSTDESK_API_GIN_TRUST_PROXY | Trusted proxy IPs, separated by commas. | 192.168.1.2,192.168.1.3 | -| ----- GORM Configuration ----- | --------------------------------------- | ----------------------------- | -| RUSTDESK_API_GORM_TYPE | Database type (`sqlite` or `mysql`). Default is `sqlite`. | sqlite | -| RUSTDESK_API_GORM_MAX_IDLE_CONNS | Maximum idle connections | 10 | -| RUSTDESK_API_GORM_MAX_OPEN_CONNS | Maximum open connections | 100 | -| RUSTDESK_API_RUSTDESK_PERSONAL | Open Personal Api 1:Enable,0:Disable | 1 | -| ----- MYSQL Configuration ----- | --------------------------------------- | ----------------------------- | -| RUSTDESK_API_MYSQL_USERNAME | MySQL username | root | -| RUSTDESK_API_MYSQL_PASSWORD | MySQL password | 111111 | -| RUSTDESK_API_MYSQL_ADDR | MySQL address | 192.168.1.66:3306 | -| RUSTDESK_API_MYSQL_DBNAME | MySQL database name | rustdesk | -| ----- RUSTDESK Configuration ----- | --------------------------------------- | ----------------------------- | -| RUSTDESK_API_RUSTDESK_ID_SERVER | Rustdesk ID server address | 192.168.1.66:21116 | -| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk relay server address | 192.168.1.66:21117 | -| RUSTDESK_API_RUSTDESK_API_SERVER | Rustdesk API server address | http://192.168.1.66:21114 | -| RUSTDESK_API_RUSTDESK_KEY | Rustdesk key | 123456789 | -| ---- PROXY ----- | --------------- | ---------- | -| RUSTDESK_API_PROXY_ENABLE | proxy_enable :`false`, `true` | `false` | -| RUSTDESK_API_PROXY_HOST | proxy_host | `http://127.0.0.1:1080` | +| Variable Name | Description | Example | +|------------------------------------|-------------------------------------------------------------------------|-------------------------------| +| TZ | timezone | Asia/Shanghai | +| RUSTDESK_API_LANG | Language | `en`,`zh-CN` | +| RUSTDESK_API_APP_WEB_CLIENT | web client on/off; 1: on, 0 off, deault 1 | 1 | +| RUSTDESK_API_APP_REGISTER | register enable; `true`, `false`; default:`false` | `false` | +| -----ADMIN Configuration----- | ---------- | ---------- | +| RUSTDESK_API_ADMIN_TITLE | Admin Title | `RustDesk Api Admin` | +| RUSTDESK_API_ADMIN_HELLO | Admin welcome message, you can use `html` | | +| RUSTDESK_API_ADMIN_HELLO_FILE | Admin welcome message file,
will override `RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html` | +| ----- GIN Configuration ----- | --------------------------------------- | ----------------------------- | +| RUSTDESK_API_GIN_TRUST_PROXY | Trusted proxy IPs, separated by commas. | 192.168.1.2,192.168.1.3 | +| ----- GORM Configuration ----- | --------------------------------------- | ----------------------------- | +| RUSTDESK_API_GORM_TYPE | Database type (`sqlite` or `mysql`). Default is `sqlite`. | sqlite | +| RUSTDESK_API_GORM_MAX_IDLE_CONNS | Maximum idle connections | 10 | +| RUSTDESK_API_GORM_MAX_OPEN_CONNS | Maximum open connections | 100 | +| RUSTDESK_API_RUSTDESK_PERSONAL | Open Personal Api 1:Enable,0:Disable | 1 | +| ----- MYSQL Configuration ----- | --------------------------------------- | ----------------------------- | +| RUSTDESK_API_MYSQL_USERNAME | MySQL username | root | +| RUSTDESK_API_MYSQL_PASSWORD | MySQL password | 111111 | +| RUSTDESK_API_MYSQL_ADDR | MySQL address | 192.168.1.66:3306 | +| RUSTDESK_API_MYSQL_DBNAME | MySQL database name | rustdesk | +| ----- RUSTDESK Configuration ----- | --------------------------------------- | ----------------------------- | +| RUSTDESK_API_RUSTDESK_ID_SERVER | Rustdesk ID server address | 192.168.1.66:21116 | +| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk relay server address | 192.168.1.66:21117 | +| RUSTDESK_API_RUSTDESK_API_SERVER | Rustdesk API server address | http://192.168.1.66:21114 | +| RUSTDESK_API_RUSTDESK_KEY | Rustdesk key | 123456789 | +| RUSTDESK_API_RUSTDESK_KEY_FILE | Rustdesk存放key的文件 | `./conf/data/id_ed25519.pub` | +| ---- PROXY ----- | --------------- | ---------- | +| RUSTDESK_API_PROXY_ENABLE | proxy_enable :`false`, `true` | `false` | +| RUSTDESK_API_PROXY_HOST | proxy_host | `http://127.0.0.1:1080` | ### Installation Steps