|
|
@@ -109,8 +109,6 @@ displaying data.Frontend code is available at [rustdesk-api-web](https://github.
|
|
109
|
109
|
* Custom commands can be added
|
|
110
|
110
|
* Custom commands can be executed
|
|
111
|
111
|
|
|
112
|
|
- 
|
|
113
|
|
-
|
|
114
|
112
|
11. **LDAP Support**, When you setup the LDAP(test for OpenLDAP and AD), you can login with the LDAP's user. https://github.com/lejianwen/rustdesk-api/issues/114 , if LDAP fail fallback local user
|
|
115
|
113
|
|
|
116
|
114
|
### Web Client:
|
|
|
@@ -145,71 +143,11 @@ displaying data.Frontend code is available at [rustdesk-api-web](https://github.
|
|
145
|
143
|
|
|
146
|
144
|
### Configuration
|
|
147
|
145
|
|
|
|
146
|
+* [Config File](./conf/config.yaml)
|
|
148
|
147
|
* Modify the configuration in `conf/config.yaml`.
|
|
149
|
148
|
* If `gorm.type` is set to `sqlite`, MySQL-related configurations are not required.
|
|
150
|
149
|
* Language support: `en` and `zh-CN` are supported. The default is `zh-CN`.
|
|
151
|
150
|
|
|
152
|
|
-```yaml
|
|
153
|
|
-lang: "en"
|
|
154
|
|
-app:
|
|
155
|
|
- web-client: 1 # web client route 1:open 0:close
|
|
156
|
|
- register: false #register enable
|
|
157
|
|
- show-swagger: 0 #show swagger 1:open 0:close
|
|
158
|
|
- web-sso: true #web sso
|
|
159
|
|
- token-expire: 168h #token expire duration
|
|
160
|
|
- disable-pwd-login: false #disable password login
|
|
161
|
|
-gin:
|
|
162
|
|
- api-addr: "0.0.0.0:21114"
|
|
163
|
|
- mode: "release"
|
|
164
|
|
- resources-path: 'resources'
|
|
165
|
|
- trust-proxy: ""
|
|
166
|
|
-gorm:
|
|
167
|
|
- type: "sqlite"
|
|
168
|
|
- max-idle-conns: 10
|
|
169
|
|
- max-open-conns: 100
|
|
170
|
|
-mysql:
|
|
171
|
|
- username: "root"
|
|
172
|
|
- password: "111111"
|
|
173
|
|
- addr: "192.168.1.66:3308"
|
|
174
|
|
- dbname: "rustdesk"
|
|
175
|
|
-rustdesk:
|
|
176
|
|
- id-server: "192.168.1.66:21116"
|
|
177
|
|
- relay-server: "192.168.1.66:21117"
|
|
178
|
|
- api-server: "http://192.168.1.66:21114"
|
|
179
|
|
- key: "123456789"
|
|
180
|
|
- personal: 1
|
|
181
|
|
-logger:
|
|
182
|
|
- path: "./runtime/log.txt"
|
|
183
|
|
- level: "warn" #trace,debug,info,warn,error,fatal
|
|
184
|
|
- report-caller: true
|
|
185
|
|
-proxy:
|
|
186
|
|
- enable: false
|
|
187
|
|
- host: ""
|
|
188
|
|
-jwt:
|
|
189
|
|
- key: ""
|
|
190
|
|
- expire-duration: 360000
|
|
191
|
|
-ldap:
|
|
192
|
|
- enable: false
|
|
193
|
|
- url: "ldap://ldap.example.com:389"
|
|
194
|
|
- tls: false
|
|
195
|
|
- tls-verify: false
|
|
196
|
|
- base-dn: "dc=example,dc=com"
|
|
197
|
|
- bind-dn: "cn=admin,dc=example,dc=com"
|
|
198
|
|
- bind-password: "password"
|
|
199
|
|
-
|
|
200
|
|
- user:
|
|
201
|
|
- base-dn: "ou=users,dc=example,dc=com"
|
|
202
|
|
- enable-attr: "" #The attribute name of the user for enabling, in AD it is "userAccountControl", empty means no enable attribute, all users are enabled
|
|
203
|
|
- enable-attr-value: "" # The value of the enable attribute when the user is enabled. If you are using AD, just set random value, it will be ignored.
|
|
204
|
|
- filter: "(cn=*)"
|
|
205
|
|
- username: "uid" # The attribute name of the user for usernamem if you are using AD, it should be "sAMAccountName"
|
|
206
|
|
- email: "mail"
|
|
207
|
|
- first-name: "givenName"
|
|
208
|
|
- last-name: "sn"
|
|
209
|
|
- sync: false # If true, the user will be synchronized to the database when the user logs in. If false, the user will be synchronized to the database when the user be created.
|
|
210
|
|
- admin-group: "cn=admin,dc=example,dc=com" # The group name of the admin group, if the user is in this group, the user will be an admin.
|
|
211
|
|
-
|
|
212
|
|
-```
|
|
213
|
151
|
|
|
214
|
152
|
### Environment Variables
|
|
215
|
153
|
The environment variables correspond one-to-one with the configurations in the `conf/config.yaml` file. The prefix for variable names is `RUSTDESK_API`.
|
|
|
@@ -247,6 +185,7 @@ The table below does not list all configurations. Please refer to the configurat
|
|
247
|
185
|
| RUSTDESK_API_RUSTDESK_KEY | Rustdesk key | 123456789 |
|
|
248
|
186
|
| RUSTDESK_API_RUSTDESK_KEY_FILE | Rustdesk key file | `./conf/data/id_ed25519.pub` |
|
|
249
|
187
|
| RUSTDESK_API_RUSTDESK<br/>_WEBCLIENT_MAGIC_QUERYONLINE | New online query method is enabled in the web client v2; '1': Enabled, '0': Disabled, not enabled by default | `0` |
|
|
|
188
|
+| RUSTDESK_API_RUSTDESK_WS_HOST | Custom Websocket Host | |
|
|
250
|
189
|
| ---- PROXY ----- | --------------- | ---------- |
|
|
251
|
190
|
| RUSTDESK_API_PROXY_ENABLE | proxy_enable :`false`, `true` | `false` |
|
|
252
|
191
|
| RUSTDESK_API_PROXY_HOST | proxy_host | `http://127.0.0.1:1080` |
|