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: source/manual/dashboard.rst
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,40 +3,44 @@ Dashboard
3
3
=========
4
4
5
5
The Dashboard is the first page you will see after you log into OPNsense.
6
-
Additionally, it can be accessed via :menuselection:`Lobby --> Dashboard`. The Dashboard provides an overview of your system status.
6
+
Additionally, it can be accessed via :menuselection:`Lobby --> Dashboard`.
7
+
The Dashboard provides an overview of your system status.
7
8
8
9
-------------
9
10
Configuration
10
11
-------------
11
12
12
-
What is shown on the Dashboard can be configured by adding and removing widgets. Some widgets also allow further
13
-
configuration.
13
+
What is shown on the Dashboard can be configured by adding and removing widgets.
14
+
Some widgets also allow further configuration.
14
15
15
16
By default, the following widgets are present:
16
17
17
-
* **System Information:** Shows information about the installed OPNsense version, updates etc.
18
+
* **System Information** Shows information about the installed OPNsense version, updates etc.
18
19
* **Memory** Shows memory usage.
19
20
* **Disk** Shows disk usage.
20
21
* **CPU** Shows CPU usage.
21
22
* **Announcements** Shows the latest announcements from the OPNsense project.
22
-
* **Gateways:** Shows used gateways.
23
+
* **Gateways** Shows used gateways.
23
24
* **Interface Statistics** Shows the number of packets, bytes and errors handled by each interface.
24
25
* **Firewall** Collects logged events from the moment the dashboard has loaded to represent a snapshot of what the firewall is currently seeing. Can be expanded to show a live log.
25
26
* **Traffic Graph** Shows traffic passing through the system.
26
27
27
28
In the upper right corner of every widget, there can be two buttons:
28
29
29
-
* **Edit (pencil icon):** Click this to modify the widget settings. This button is only present if the widget is configurable.
30
-
* **Remove (cross icon):** Removes the widget from the Dashboard.
30
+
* **Edit (pencil icon)** Click this to modify the widget settings. This button is only present if the widget is configurable.
31
+
* **Remove (cross icon)** Removes the widget from the Dashboard.
31
32
32
33
In the upper right corner of the page, there are two or three buttons:
33
34
34
-
* **Add widget:** Opens a dialog window with a list of widgets that can be added to the Dashboard. Simply click on an entry in the list to add it to the Dashboard.
35
-
* **Save Settings:** When you change the amount of columns or collapse a widget, you can make that change persistent by clicking this button. Otherwise the changes will be discarded as soon as you reload the page.
36
-
* **Lock** Locks the dashboard so you cannot move, remove or resize widgets. New widgets can still be added. This change is persisted and is useful to navigate the dashboard on a mobile device.
35
+
* **Edit dashboard (pencil icon)** Unlocks the dashboard temporarily so you can move, resize, remove, or configure widgets.
36
+
* **Add widget (plus icon)** Opens a dialog window with a list of widgets that can be added to the Dashboard. Simply click on an entry in the list to add it to the Dashboard.
37
+
* **Restore default layou (widgets icon)** Restores the dashboard to its default configuration discarding all your modifications.
38
+
* **Save** After editing the dashboard, you can make all changes persistent by clicking this button. Otherwise the changes will be discarded as soon as you reload the page.
37
39
38
-
All widgets can be resized by dragging on one of the corners of the widget. The widget will snap to the grid, so it will always fit in the available space.
40
+
All widgets can be resized by dragging on one of the corners of the widget.
41
+
The widget will snap to the grid, so it will always fit in the available space.
39
42
40
43
.. Note::
41
44
42
45
The dashboard configuration is saved per user. This means that each user can have their own dashboard layout.
46
+
Therefore, use the "Users and Groups" high availability option to synchronize the dashboard configuration.
0 commit comments