docs: remove customize.md (#20742)
Ilya Mashchenko committed
Jul 30, 2025 at 15:34 UTC
b32f7b70c5a6bf9b3c161956cbba373d5420de38
1 file changed
-74
docs/developer-and-contributor-corner/customize.md
deleted
-74
@@ -1,74 +0,0 @@
1
-# Customize the standard dashboard
2
-
3
-> **Disclaimer**
4
->
5
-> This document is only applicable to the v1 version of the dashboard and doesn't affect the [Netdata Dashboard](/docs/dashboards-and-charts/README.md).
6
-
7
-While the [Netdata dashboard](/src/web/gui/README.md) comes pre-configured with hundreds of charts and
8
-thousands of metrics, you may want to alter your experience based on a particular use case or preferences.
9
-
10
-## Dashboard settings
11
-
12
-To change dashboard settings, click on the **settings** icon
13
-
14
-in the top panel.
15
-
16
-These settings only affect how the dashboard behaves in your browser. They take effect immediately and are permanently
17
-saved to browser local storage (except the refresh on focus / always option). Some settings are applied immediately, and
18
-others are only reflected after the dashboard is refreshed, which happens automatically.
19
-
20
-Here are a few popular settings:
21
-
22
-### Change chart legend position
23
-
24
-Find this setting under the **Visual** tab. By default, Netdata places the legend of dimensions _below_ charts.
25
-Click this toggle to move the legend to the _right_ of charts.
26
-
27
-### Change theme
28
-
29
-Find this setting under the **Visual** tab. Choose between Dark (the default) and White.
30
-
31
-## Customize the standard dashboard info
32
-
33
-Netdata stores information about individual charts in the `dashboard_info.js` file. This file includes section and
34
-subsection headings, descriptions, colors, titles, tooltips, and other information for Netdata to render on the
35
-dashboard.
36
-
37
-One common use case for customizing the standard dashboard is adding internal "documentation" a section or specific
38
-chart that can then be read by anyone with access to that dashboard.
39
-
40
-For example, here is how `dashboard_info.js` defines the **System Overview** section.
41
-
42
-```javascript
43
-netdataDashboard.menu = {
44
- 'system': {
45
- title: 'System Overview',
46
- icon: '<i class="fas fa-bookmark"></i>',
47
- info: 'Overview of the key system metrics.'
48
- },
49
-```
50
-
51
-If you want to customize this information, use the example `dashboard_info_custom_example.js` as a starting point.
52
-First, navigate to the web server's directory. If you're on a Linux system, this should be at `/usr/share/netdata/web/`.
53
-Copy the example file, then ensure that its permissions match the rest of the web server, which is `netdata:netdata` by
54
-default.
55
-
56
-```bash
57
-cd /usr/share/netdata/web/
58
-sudo cp dashboard_info_custom_example.js your_dashboard_info_file.js
59
-sudo chown netdata:netdata your_dashboard_info_file.js
60
-```
61
-
62
-Edit the file with customizations to the `title`, `icon`, and `info` fields. Replace the string after `fas fa-` with any
63
-icon from [Font Awesome](https://fontawesome.com/cheatsheet) to customize the icons that appear throughout the
64
-dashboard.
65
-
66
-Save the file, then navigate to your [Netdata config directory](/docs/netdata-agent/configuration/README.md) to edit `netdata.conf`. Add
67
-the following line to the `[web]` section to tell Netdata where to find your custom configuration.
68
-
69
-```text
70
-[web]
71
- custom dashboard_info.js = your_dashboard_info_file.js
72
-```
73
-
74
-Reload your browser tab to see your custom configuration.