You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: en_US/dashboard/introduction.md
+49-1Lines changed: 49 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ Support for custom plug-in integration, Extend EMQX connectivity protocols throu
32
32
33
33
In addition to debugging through online MQTT over WebSocket client connections and publishing subscriptions, we also support diagnosing and finding issues using things like slow subscriptions and online logs tracing and alarms.
34
34
35
-
## Running
35
+
## Launch Dashboard
36
36
37
37
EMQX Dashboard is a web application that listens to port `18083` by default. After installing EMQX successfully, you can access and use EMQX Dashboard by opening <http://localhost:18083/> (replace localhost with the actual IP address if deployed on a non-local machine) through your browser.
38
38
@@ -46,6 +46,54 @@ For users who have installed EMQX for the first time, you can use the default us
46
46
47
47
After logging in for the first time, the system will automatically detect that you are logging in with the default username and password, and will force you to change the default password, which is good for the security of accessing Dashboard, note that the changed password cannot be the same as the original password, and it is not recommended to use `public` as the login password again.
48
48
49
+
### Token-Based Login via URL
50
+
51
+
Starting from EMQX 5.6.0, the Dashboard supports a token-based login method that allows users to log in directly by embedding authentication information in the URL.
52
+
53
+
This feature is particularly useful for seamless redirection and integration scenarios where a user should be logged in automatically without entering credentials manually.
54
+
55
+
#### How To Use This Login Method
56
+
57
+
1. Call the `/login` API to obtain the login token and related information.
58
+
59
+
2. Manually add the username used during login (not included in the `/login` response).
60
+
61
+
3. Combine the data into a JSON structure:
62
+
63
+
```json
64
+
{
65
+
"license": {
66
+
"edition": "ee"
67
+
},
68
+
"role": "administrator",
69
+
"token": "xxx.jwt.token",
70
+
"version": "5.5.0-g0fef19f8",
71
+
"username": "admin"
72
+
}
73
+
```
74
+
75
+
4. Convert the JSON string to Base64.
76
+
77
+
5. Embed the encoded string in the `login_meta` query parameter of the Dashboard URL.
This method provides a smooth, pre-authenticated user experience for accessing the EMQX Dashboard. Make sure to handle the token securely and ensure it has appropriate expiration and scope limits.
96
+
49
97
## Reset password
50
98
51
99
You can reset your Dashboard login password via the `admins` command. For details, see [CLI - admins](../admin/cli.md#admins).
0 commit comments