extern/doc.rustdesk.com
1
0
Fork 1
mirror of https://github.com/rustdesk/doc.rustdesk.com.git synced 2025-06-10 03:36:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update _index.en.md

Browse Source
This commit is contained in:
Mr-Update 2023-10-21 21:55:47 +02:00 committed by GitHub
parent 43adf3cd21
commit 86b5f05337
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
content/self-host/rustdesk-server-pro/console/_index.en.md
View File

@ -11,7 +11,7 @@ Features:
- Update settings - Update settings
- Manage client settings sync strategies - Manage client settings sync strategies
## Log in ### Log in
The default port of the web console is 21114. Enter `http://<hbbs host>:21114` in the browser to enter the console page, as shown in the following figure. The default administrator username/password is admin/test1234: The default port of the web console is 21114. Enter `http://<hbbs host>:21114` in the browser to enter the console page, as shown in the following figure. The default administrator username/password is admin/test1234:
@ -26,51 +26,51 @@ After logging in please be sure to change the password, select `Settings` in the
Non-administrator users can also login to browse their device and logs, change their user settings. Non-administrator users can also login to browse their device and logs, change their user settings.
## Automatic Configs ### Automatic Configs
By Clicking on `Windows EXE` you will be able to get the configs for your own RustDesk Server Pro, this will help configure your clients. By Clicking on `Windows EXE` you will be able to get the configs for your own RustDesk Server Pro, this will help configure your clients.
For Windows clients, you can leave out the custom server configuration and put the configuration information in the `rustdesk.exe` filename instead. As shown above, please go to the console welcome page and click on `Windows EXE`. **Client >=1.1.9 Required.** For Windows clients, you can leave out the custom server configuration and put the configuration information in the `rustdesk.exe` filename instead. As shown above, please go to the console welcome page and click on `Windows EXE`. **Client >=1.1.9 Required.**
You can use this in conjuction with [client config](https://rustdesk.com/docs/en/self-host/client-configuration/) and [deployment scripts](https://rustdesk.com/docs/en/self-host/client-deployment/) to setup your clients. You can use this in conjunction with [client config](https://rustdesk.com/docs/en/self-host/client-configuration/) and [deployment scripts](https://rustdesk.com/docs/en/self-host/client-deployment/) to setup your clients.
## Creating a new user other than the default `admin` user ### Creating a new user other than the default `admin` user
1. Click On `Users` on the left hand menu. 1. Click On `Users` on the left hand menu.
2. Create another account with `administrator` enabled. 2. Create another account with `administrator` enabled.
3. Log in with the new administrative account. 3. Log in with the new administrative account.
4. Delete the `admin` on `Users` page. 4. Delete the `admin` on `Users` page.
## Creating a new user ### Creating a new user
1. Click On `Users` on the left hand menu. 1. Click On `Users` on the left hand menu.
2. Create a new user. 2. Create a new user.
3. Select what group they should be in (if you need to add new groups please keep reading). 3. Select what group they should be in (if you need to add new groups please keep reading).
## Add a new Group ### Add a new Group
1. Click On `Groups` on the left hand menu. 1. Click On `Groups` on the left hand menu.
2. Create a new group. 2. Create a new group.
3. Once created you can allow groups access each other, Click `Edit`. 3. Once created you can allow groups access each other, Click `Edit`.
4. Select the relevant groups you want access (it automatically adds them in the corresponding group). 4. Select the relevant groups you want access (it automatically adds them in the corresponding group).
## Setting up multiple relay servers ### Setting up multiple relay servers
1. Go to `Settings` on the left hand menu. 1. Go to `Settings` on the left hand menu.
2. Click on `Relay` on the sub-menu. 2. Click on `Relay` on the submenu.
3. Click `+` next to `Relay Servers`. 3. Click `+` next to `Relay Servers`.
4. Enter the Relay server DNS address or IP address in the box which now shows and press <kbd>Enter</kbd>. 4. Enter the Relay server DNS address or IP address in the box which now shows and press <kbd>Enter</kbd>.
5. If you have more than one Relay server you can keep clicking `+` and adapt the Geo settings is required (remember and copy your key to the other servers). 5. If you have more than one Relay server you can keep clicking `+` and adapt the Geo settings is required (remember and copy your key to the other servers).
## Set or change the license ### Set or change the license
1. Go to `Settings` on the left hand menu. 1. Go to `Settings` on the left hand menu.
2. Click on `License` on the sub-menu. 2. Click on `License` on the submenu.
3. Click `Edit` and paste in your license code. 3. Click `Edit` and paste in your license code.
4. Click `OK`. 4. Click `OK`.
## Viewing Logs ### Viewing Logs
On the left hand side click on `Logs`. On the left hand side click on `Logs`.
## Setup Emails ### Setup Emails
Gmail in this example Gmail in this example
1. Go to `Settings` on the left hand menu. 1. Go to `Settings` on the left hand menu.
2. Click on `SMTP` on the sub-menu. 2. Click on `SMTP` on the submenu.
3. Enter the SMTP address `smtp.gmail.com`. 3. Enter the SMTP address `smtp.gmail.com`.
4. Enter the Port 587 in `SMTP Port`. 4. Enter the Port 587 in `SMTP Port`.
5. Enter the Gmail account i.e. `myrustdeskserver@gmail.com` in `Mail Account`. 5. Enter the Gmail account i.e. `myrustdeskserver@gmail.com` in `Mail Account`.
@ -78,12 +78,13 @@ Gmail in this example
7. Enter your Gmail account i.e. `myrustdeskserver@gmail.com` in `From`. 7. Enter your Gmail account i.e. `myrustdeskserver@gmail.com` in `From`.
8. Click `Check` to save. 8. Click `Check` to save.
## Assign Device Users and Groups to Devices ### Assign Device Users and Groups to Devices
The User is the RustDesk User logged in on the device or assigned to the device by clicking `Edit` next to the device, click in the `User` box and drop down to select your user, this will auto assign the group based on the group the user as been assigned to. The User is the RustDesk User logged in on the device or assigned to the device by clicking `Edit` next to the device, click in the `User` box and drop down to select your user, this will auto assign the group based on the group the user as been assigned to.
This can also be done via the API at command line on deployment or later by calling the RustDesk executable followed by `--assign --token <generatedtoken> --user_name <username>`. You need to go to "Settings -> Tokens -> Create" and create a token with Device permissions first to do this. An example of this on windows would be `"C:\Program Files\RustDesk\rustdesk.exe" --assign --token <generatedtoken> --user_name <newuser>`. This can also be done via the API at command line on deployment or later by calling the RustDesk executable followed by `--assign --token <generatedtoken> --user_name <username>`. You need to go to "Settings -> Tokens -> Create" and create a token with Device permissions first to do this. An example of this on windows would be `"C:\Program Files\RustDesk\rustdesk.exe" --assign --token <generatedtoken> --user_name <newuser>`.
## Searching for a device ### Searching for a device
1. Go to Devices. 1. Go to Devices.
2. In the Device Name Search Field type in the name and click `Query` or hit <kbd>Enter</kbd>. 2. In the Device Name Search Field type in the name and click `Query` or hit <kbd>Enter</kbd>.
3. To use a wildcard add `%` at the start, end or both of the search term. 3. To use a wildcard add `%` at the start, end or both of the search term.