|
|
@@ -53,15 +53,13 @@ desktop software that provides self-hosted solutions.
|
|
53
|
53
|
hbbr -k abc1234567
|
|
54
|
54
|
```
|
|
55
|
55
|
|
|
56
|
|
-## Features
|
|
|
56
|
+## Overview
|
|
57
|
57
|
|
|
58
|
58
|
### API Service: Basic implementation of the PC client's primary interfaces.Supports the Personal version api, which can be enabled by configuring the `rustdesk.personal` file or the `RUSTDESK_API_RUSTDESK_PERSONAL` environment variable.
|
|
59
|
59
|
|
|
60
|
60
|
#### Login
|
|
61
|
61
|
|
|
62
|
|
-- Added `GitHub` and `Google` login, which can be used after configuration in the admin panel. See the OAuth
|
|
63
|
|
- configuration section
|
|
64
|
|
- for details.
|
|
|
62
|
+- Added `GitHub` and `Google` login, which can be used after configuration in the admin panel. See the OAuth configuration section for details.
|
|
65
|
63
|
- Added authorization login for the web admin panel.
|
|
66
|
64
|
|
|
67
|
65
|

|
|
|
@@ -70,31 +68,29 @@ desktop software that provides self-hosted solutions.
|
|
70
|
68
|
|
|
71
|
69
|

|
|
72
|
70
|
|
|
73
|
|
-#### Groups: Groups are divided into `shared groups` and `regular groups`. In shared groups, everyone can see the addresses of all group members, while in regular groups, only administrators can see all members' addresses.
|
|
|
71
|
+#### Groups: Groups are divided into `shared groups` and `regular groups`. In shared groups, everyone can see the peers of all group members, while in regular groups, only administrators can see all members' peers.
|
|
74
|
72
|
|
|
75
|
73
|

|
|
76
|
74
|
|
|
77
|
|
-### **Web UI
|
|
|
75
|
+### Web Admin
|
|
78
|
76
|
|
|
79
|
|
-**: The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and
|
|
80
|
|
-displaying data.
|
|
|
77
|
+***The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and
|
|
|
78
|
+displaying data.Frontend code is available at [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***
|
|
81
|
79
|
|
|
82
|
|
-***Frontend code is available at [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)***
|
|
83
|
|
-
|
|
84
|
|
-***Admin panel URL: `http://<your server>[:port]/_admin/`. The default username and password for the initial
|
|
|
80
|
+***Admin panel URL: `http://<your server[:port]>/_admin/`. The default username and password for the initial
|
|
85
|
81
|
installation are `admin` `admin`, please change the password immediately.***
|
|
86
|
82
|
|
|
87
|
83
|
1. Admin interface:
|
|
88
|
84
|

|
|
89
|
85
|
2. Regular user interface:
|
|
90
|
86
|

|
|
91
|
|
-3. You can change your password from the top right corner:
|
|
|
87
|
+ You can change your password from the top right corner:
|
|
92
|
88
|

|
|
93
|
|
-4. Groups can be customized for easy management. Currently, two types are supported: `shared group` and `regular group`.
|
|
|
89
|
+3. Groups can be customized for easy management. Currently, two types are supported: `shared group` and `regular group`.
|
|
94
|
90
|

|
|
95
|
|
-5. You can open the web client directly for convenience:
|
|
|
91
|
+4. You can open the web client directly for convenience:
|
|
96
|
92
|

|
|
97
|
|
-6. OAuth support: Currently, `GitHub` and `Google` is supported. You need to create an `OAuth App` and configure it in
|
|
|
93
|
+5. OAuth support: Currently, `GitHub` and `Google` is supported. You need to create an `OAuth App` and configure it in
|
|
98
|
94
|
the admin
|
|
99
|
95
|
panel.
|
|
100
|
96
|

|
|
|
@@ -103,7 +99,7 @@ installation are `admin` `admin`, please change the password immediately.***
|
|
103
|
99
|
- Set the `Authorization callback URL` to `http://<your server[:port]>/api/oauth/callback`,
|
|
104
|
100
|
e.g., `http://127.0.0.1:21114/api/oauth/callback`.
|
|
105
|
101
|
|
|
106
|
|
-### **Web Client**:
|
|
|
102
|
+### Web Client:
|
|
107
|
103
|
|
|
108
|
104
|
1. If you're already logged into the admin panel, the web client will log in automatically.
|
|
109
|
105
|
2. If you're not logged in, simply click the login button at the top right corner, and the API server will be
|
|
|
@@ -112,12 +108,10 @@ installation are `admin` `admin`, please change the password immediately.***
|
|
112
|
108
|
3. After logging in, the ID server and key will be automatically synced.
|
|
113
|
109
|
4. The address book will also be automatically saved to the web client for convenient use.
|
|
114
|
110
|
|
|
115
|
|
-### **Automated Documentation
|
|
116
|
|
-
|
|
117
|
|
-** : API documentation is generated using Swag, making it easier for developers to understand and use the API.
|
|
|
111
|
+### Automated Documentation : API documentation is generated using Swag, making it easier for developers to understand and use the API.
|
|
118
|
112
|
|
|
119
|
|
-1. Admin panel docs: `<your server>/admin/swagger/index.html`
|
|
120
|
|
-2. PC client docs: `<your server>/swagger/index.html`
|
|
|
113
|
+1. Admin panel docs: `<your server[:port]>/admin/swagger/index.html`
|
|
|
114
|
+2. PC client docs: `<your server[:port]>/swagger/index.html`
|
|
121
|
115
|

|
|
122
|
116
|
|
|
123
|
117
|
## Installation and Setup
|
|
|
@@ -150,7 +144,7 @@ rustdesk:
|
|
150
|
144
|
personal: 1
|
|
151
|
145
|
```
|
|
152
|
146
|
|
|
153
|
|
-* Environment variables, with the prefix `RUSTDESK_API`, will override the settings in the configuration file if
|
|
|
147
|
+* Environment variables, with the prefix `RUSTDESK_API_RUSTDESK_PERSONAL`, will override the settings in the configuration file if
|
|
154
|
148
|
present.
|
|
155
|
149
|
|
|
156
|
150
|
| Variable Name | Description | Example |
|
|
|
@@ -383,7 +377,7 @@ Download the release from [release](https://github.com/lejianwen/rustdesk-api/re
|
|
383
|
377
|
compiling, the corresponding executables will be generated in the `release` directory. Run the compiled executables
|
|
384
|
378
|
directly.
|
|
385
|
379
|
|
|
386
|
|
-6. Open your browser and visit `http://<your server>:21114/_admin/`, with default credentials `admin admin`. Please
|
|
|
380
|
+6. Open your browser and visit `http://<your server[:port]>/_admin/`, with default credentials `admin admin`. Please
|
|
387
|
381
|
change the password promptly.
|
|
388
|
382
|
|
|
389
|
383
|
## Miscellaneous
|