docs(web/gui): remove info about old dashboard from readme (#19531)
Ilya Mashchenko committed
Jan 30, 2025 at 12:07 UTC
437393cee64830f476e8d98422eb1f78fd5c6059
1 file changed
+5
-41
src/web/README.md
+5
-41
@@ -1,44 +1,8 @@
1
-# Agent Dashboards
1
+# Agent Dashboard
2
3
-Because Netdata is a health monitoring and _performance troubleshooting_ system,
4
-we put a lot of emphasis on real-time, meaningful, and context-aware charts.
3
+Every Netdata installation comes with a comprehensive dashboard featuring hundreds of pre-configured charts that help you understand your system's performance at a glance.
4
6
-We bundle Netdata with a dashboard and hundreds of charts, designed by both our
7
-team and the community, but you can also customize them yourself.
5
+There are two ways to access your Agent's dashboard:
6
9
-There are two primary ways to view Netdata's dashboards on the Agent:
10
-
11
-1. The [local Agent dashboard](/src/web/gui/README.md) that comes pre-configured with every Netdata installation. You can
12
- see it at `http://NODE:19999`, replacing `NODE` with `localhost`, the hostname of your node, or its IP address. You
13
- can customize the contents and colors of the standard dashboard [using
14
- JavaScript](/src/web/gui/README.md#customizing-the-local-dashboard).
15
-
16
-2. The [`dashboard.js` JavaScript library](#dashboardjs), which helps you
17
- [customize the standard dashboards](/src/web/gui/README.md#customizing-the-local-dashboard)
18
- using JavaScript, or create entirely new [custom dashboards](/src/web/gui/custom/README.md)
19
-You can also view all the data Netdata collects through the [REST API v1](/src/web/api/README.md#netdata-rest-api).
20
-
21
-## dashboard.js
22
-
23
-Netdata uses the `dashboards.js` file to define, configure, create, and update
24
-all the charts and other visualizations that appear on any Netdata dashboard.
25
-You need to put `dashboard.js` on any HTML page that's going to render Netdata
26
-charts.
27
-
28
-The [custom dashboards documentation](/src/web/gui/custom/README.md) contains examples of such
29
-custom HTML pages.
30
-
31
-### Generating dashboard.js
32
-
33
-We build the `dashboards.js` file by concatenating all the source files located
34
-in the `web/gui/src/dashboard.js/` directory. That's done using the provided
35
-build script:
36
-
37
-```sh
38
-cd web/gui
39
-make
40
-```
41
-
42
-If you make any changes to the `src` directory when developing Netdata, you
43
-should regenerate the `dashboard.js` file before you commit to the Netdata
44
-repository.
7
+- Directly at `http://localhost:19999` or `http://NODE_IP:19999`.
8
+- Through app.netdata.cloud after connecting your Agent.