doc.rustdesk.com/content/self-host/rustdesk-server-pro/console/_index.en.md

101 lines
5.3 KiB
Markdown
Raw Normal View History

2023-08-21 21:46:01 +02:00
---
title: Web Console
weight: 10
---
2024-07-06 02:53:18 +02:00
The web console is integrated in the RustDesk server Pro, serviced by the `21114` port.
2023-08-21 21:46:01 +02:00
Features:
2024-07-06 02:53:18 +02:00
- Browse devices
2023-08-21 21:46:01 +02:00
- Add/modify users and user groups
- Modify device access permissions
- Browse device connection logs and the other logs
- Update settings
- Manage client settings sync strategies
2024-07-06 02:53:18 +02:00
- Manage shared address books
- Generate custom client build
2023-08-21 21:46:01 +02:00
2023-10-21 21:55:47 +02:00
### Log in
2023-08-21 21:46:01 +02:00
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:
2023-10-01 13:55:39 +02:00
2023-08-23 05:45:37 +02:00
![](/docs/en/self-host/rustdesk-server-pro/console/images/console-login.png)
2023-08-21 21:46:01 +02:00
2023-09-05 00:12:58 +02:00
If you need HTTPS support, please install a web server such as `Nginx` or use `IIS` for Windows.
2023-08-21 21:46:01 +02:00
2023-09-05 00:12:58 +02:00
After logging in please be sure to change the password, select `Settings` in the account menu in the upper right corner to enter the password modification page, as shown in the following figure. You can also create another administrator account and delete this one. You'd better enable email login verification.
2023-10-01 13:55:39 +02:00
2023-08-21 21:46:01 +02:00
<a name=console-home></a>
2023-08-23 05:45:37 +02:00
![](/docs/en/self-host/rustdesk-server-pro/console/images/console-home.png?v2)
2023-08-21 21:46:01 +02:00
Non-administrator users can also login to browse their device and logs, change their user settings.
2023-10-21 21:55:47 +02:00
### Automatic Configs
2023-10-01 13:55:39 +02:00
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.
2023-08-21 21:46:01 +02:00
2024-02-09 21:43:31 +01:00
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.**
2023-08-21 21:46:01 +02:00
2023-10-21 21:55:47 +02:00
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.
2023-09-14 16:13:59 +02:00
2023-10-21 21:55:47 +02:00
### Creating a new user other than the default `admin` user
2024-02-09 21:43:31 +01:00
1. Click on `Users` on the left hand menu.
2023-09-21 09:36:50 +02:00
2. Create another account with `administrator` enabled.
3. Log in with the new administrative account.
4. Delete the `admin` on `Users` page.
2023-10-21 21:55:47 +02:00
### Creating a new user
2024-02-09 21:43:31 +01:00
1. Click on `Users` on the left hand menu.
2023-09-21 09:36:50 +02:00
2. Create a new user.
3. Select what group they should be in (if you need to add new groups please keep reading).
2023-10-21 21:55:47 +02:00
### Add a new Group
2024-02-09 21:43:31 +01:00
1. Click on `Groups` on the left hand menu.
2023-09-21 09:36:50 +02:00
2. Create a new group.
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).
2023-08-21 21:46:01 +02:00
2023-10-21 21:55:47 +02:00
### Setting up multiple relay servers
2023-08-21 21:46:01 +02:00
1. Go to `Settings` on the left hand menu.
2023-10-21 21:55:47 +02:00
2. Click on `Relay` on the submenu.
2023-08-21 21:46:01 +02:00
3. Click `+` next to `Relay Servers`.
2023-09-05 00:12:58 +02:00
4. Enter the Relay server DNS address or IP address in the box which now shows and press <kbd>Enter</kbd>.
2023-08-21 21:46:01 +02:00
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).
2023-10-21 21:55:47 +02:00
### Set or change the license
2023-08-21 21:46:01 +02:00
1. Go to `Settings` on the left hand menu.
2023-10-21 21:55:47 +02:00
2. Click on `License` on the submenu.
2023-08-21 21:46:01 +02:00
3. Click `Edit` and paste in your license code.
4. Click `OK`.
2023-10-21 21:55:47 +02:00
### Viewing Logs
2023-08-21 21:46:01 +02:00
On the left hand side click on `Logs`.
2023-10-21 21:55:47 +02:00
### Setup Emails
2023-08-21 21:46:01 +02:00
Gmail in this example
1. Go to `Settings` on the left hand menu.
2023-10-21 21:55:47 +02:00
2. Click on `SMTP` on the submenu.
2023-08-21 21:46:01 +02:00
3. Enter the SMTP address `smtp.gmail.com`.
4. Enter the Port 587 in `SMTP Port`.
5. Enter the Gmail account i.e. `myrustdeskserver@gmail.com` in `Mail Account`.
6. Enter your password (you might need an app password).
2023-08-27 20:59:41 +02:00
7. Enter your Gmail account i.e. `myrustdeskserver@gmail.com` in `From`.
2023-08-21 21:46:01 +02:00
8. Click `Check` to save.
2024-04-11 09:24:55 +02:00
### Assign Device Users/Groups/Strategies to Devices
2023-10-23 22:06:44 +02:00
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.
2023-09-21 09:36:50 +02:00
2024-04-11 09:30:57 +02:00
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>`.
2023-09-21 09:36:50 +02:00
2024-05-21 22:00:23 +02:00
You can also assign strategy in this way, e.g. `--assign --token <generatedtoken> --strategy_name <strategyname>`.
2024-04-11 09:24:55 +02:00
2024-08-14 07:12:23 +02:00
You can also assign address book in this way, e.g. `--assign --token <generatedtoken> --address_book_name <addressbookname>` or `--assign --token <generatedtoken> --address_book_name <addressbookname> --address_book_tag <addressbooktag>`
2024-05-21 22:00:23 +02:00
The command line on Windows does not have output by default. To get output, please run like this, `"C:\Program Files\RustDesk\rustdesk.exe" <arg1> <arg2> ... | more` or `"C:\Program Files\RustDesk\rustdesk.exe" <arg1> <arg2> ... | Out-String`, see [here](https://github.com/rustdesk/rustdesk/discussions/6377#discussioncomment-8094952).
2024-04-11 09:30:57 +02:00
2023-10-21 21:55:47 +02:00
### Searching for a device
2023-08-27 20:59:41 +02:00
1. Go to Devices.
2023-09-05 00:12:58 +02:00
2. In the Device Name Search Field type in the name and click `Query` or hit <kbd>Enter</kbd>.
2023-08-27 20:59:41 +02:00
3. To use a wildcard add `%` at the start, end or both of the search term.