summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo Valente <82235632+hugovalente-pm@users.noreply.github.com>2023-09-11 14:16:27 +0100
committerGitHub <noreply@github.com>2023-09-11 14:16:27 +0100
commitcc9ec062d275cc30917930d66ad1d47c3feb4d3e (patch)
treee68356180d264d95a3c77661a498583a3feee6a0
parenta13d9f3316be9a4f95e2ef7841812b4a0fa5645a (diff)
add specific info on how to access the dashboards (#15925)
* add specific info on how to access the dashboards * also added to README * add specific info on how to access the dashboards * also added to README * added suggestion from PR review * also reflected change on legacy doc * Update docs/category-overview-pages/accessing-netdata-dashboards.md Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> --------- Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
-rw-r--r--README.md3
-rw-r--r--docs/category-overview-pages/accessing-netdata-dashboards.md11
-rw-r--r--web/gui/README.md4
3 files changed, 16 insertions, 2 deletions
diff --git a/README.md b/README.md
index 85a3ba438a..722e70c53e 100644
--- a/README.md
+++ b/README.md
@@ -165,6 +165,9 @@ It scales nicely from just a single server to thousands of servers, even in comp
Check also the [Netdata Deployment Strategies](https://learn.netdata.cloud/docs/architecture/deployment-strategies) to decide how to deploy it in your infrastructure.
+ By default, you will have immediately available a local dashboard. Netdata starts a web server for its dashboard at port `19999`. Open up your web browser of choice and
+navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname of your Agent. If installed on localhost, you can access it through `http://localhost:19999`.
+
### 2. **Configure Collectors** :boom:
Netdata auto-detects and auto-discovers most operating system data sources and applications. However, many data sources require some manual configuration, usually to allow Netdata to get access to the metrics.
diff --git a/docs/category-overview-pages/accessing-netdata-dashboards.md b/docs/category-overview-pages/accessing-netdata-dashboards.md
index dd21ef8442..97df8b8352 100644
--- a/docs/category-overview-pages/accessing-netdata-dashboards.md
+++ b/docs/category-overview-pages/accessing-netdata-dashboards.md
@@ -23,5 +23,16 @@ The Netdata dashboard consists of the following main sections:
> ⚠️ Some sections of the dashboard, when accessed through the agent, may require the user to be signed in to Netdata Cloud or having the Agent claimed to Netdata Cloud for their full functionality. Examples include saving visualization settings on charts or custom dashboards, claiming the node to Netdata Cloud, or executing functions on an Agent.
+## How to access the dashboards?
+
+### Netdata Cloud
+
+You can access the dashboard at https://app.netdata.cloud/ and [sign-in](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.md) with an account or [sign-up](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.md#dont-have-a-netdata-cloud-account-yet) if you don't have an account yet.
+
+### Netdata Agent
+
+Netdata starts a web server for its dashboard at port `19999`. Open up your web browser of choice and
+navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname of your Agent. If installed on localhost, you can access it through `http://localhost:19999`.
+
Documentation for previous Agent dashboard can still be found [here](https://github.com/netdata/netdata/blob/master/web/gui/README.md). \ No newline at end of file
diff --git a/web/gui/README.md b/web/gui/README.md
index 49b6a55b6c..2b73ad2687 100644
--- a/web/gui/README.md
+++ b/web/gui/README.md
@@ -13,8 +13,8 @@ Learn more about how dashboards work and how they're populated using the `dashbo
overview](https://github.com/netdata/netdata/blob/master/web/README.md).
By default, Netdata starts a web server for its dashboard at port `19999`. Open up your web browser of choice and
-navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname of your Agent. If you're unsure, try
-`http://localhost:19999` first.
+navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname of your Agent. If installed on localhost,
+you can access it through `http://localhost:19999`.
Netdata uses an [internal, static-threaded web server](https://github.com/netdata/netdata/blob/master/web/server/README.md) to host the HTML, CSS, and JavaScript
files that make up the local Agent dashboard. You don't have to configure anything to access it, although you can adjust