summaryrefslogtreecommitdiffstats
path: root/docs/get-started.mdx
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-02-06 16:11:34 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-02-06 16:11:34 +0000
commitd079b656b4719739b2247dcd9d46e9bec793095a (patch)
treed2c950c70a776bcf697c963151c5bd959f8a9f03 /docs/get-started.mdx
parentReleasing debian version 1.37.1-2. (diff)
downloadnetdata-d079b656b4719739b2247dcd9d46e9bec793095a.tar.xz
netdata-d079b656b4719739b2247dcd9d46e9bec793095a.zip
Merging upstream version 1.38.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/get-started.mdx')
-rw-r--r--docs/get-started.mdx116
1 files changed, 69 insertions, 47 deletions
diff --git a/docs/get-started.mdx b/docs/get-started.mdx
index 892baa0ce..aa82e811b 100644
--- a/docs/get-started.mdx
+++ b/docs/get-started.mdx
@@ -1,67 +1,96 @@
----
-title: "Get started with Netdata"
+<!--
+title: "Install Netdata"
description: "Download and install the open-source Netdata monitoring agent on physical/virtual servers, Linux (Ubuntu/Debian/CentOS/etc), Docker, Kubernetes, and many others, often with one command."
-type: how-to
-sidebar_label: "Get started"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/get-started.mdx
----
-
-import { OneLineInstallWget } from '@site/src/components/OneLineInstall/'
-import { Install, InstallBox } from '@site/src/components/Install/'
-
-# Get started with Netdata
+sidebar_label: "Install Netdata"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/get-started.mdx"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Getting started"
+-->
+
+import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
+import { InstallRegexLink, InstallBoxRegexLink } from '@site/src/components/InstallRegexLink/'
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from
any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface.
-Together with [Netdata Cloud](https://learn.netdata.cloud/docs/cloud), you can monitor your entire infrastructure in
+Together with [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), you can monitor your entire infrastructure in
real time and troubleshoot problems that threaten the health of your nodes.
Netdata runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices. It
runs on Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters,
Docker), and many other operating systems (FreeBSD, macOS), with no `sudo` required.
+To install Netdata in minutes on your platform:
+
+1. Sign up to https://app.netdata.cloud/
+2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform
+3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it
+
+Upon installation completing successfully, you should be able to see the node live in your Netdata Space!
+
+Continue reading for more advanced instructions and installation options.
+
## Install on Linux with one-line installer
The **recommended** way to install Netdata on a Linux node (physical, virtual, container, IoT) is our one-line
-[kickstart script](/packaging/installer/methods/kickstart.md). This script automatically installs dependencies and
-builds Netdata from its source code.
+[kickstart script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
+This script automatically installs dependencies and builds Netdata from its source code.
-Copy the script, paste it into your node's terminal, and hit `Enter` to begin the installation process.
+To install, copy the script, paste it into your node's terminal, and hit `Enter` to begin the installation process.
-<OneLineInstallWget />
+ <Tabs>
+ <TabItem value="wget" label=<code>wget</code>>
+
+ <OneLineInstallWget/>
+
+ </TabItem>
+ <TabItem value="curl" label=<code>curl</code>>
+
+ <OneLineInstallCurl/>
+
+ </TabItem>
+</Tabs>
+
+:::note
+If you plan to also Claim the node to Netdata Cloud,
+make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space,
+and `YOUR_ROOM_ID` with the ID of the room you are willing to claim to.
+:::
Jump down to [what's next](#whats-next) to learn how to view your new dashboard and take your next steps monitoring and
troubleshooting with Netdata.
## Other installation options
-<Install>
- <InstallBox
- to="/docs/agent/packaging/docker"
+<InstallRegexLink>
+ <InstallBoxRegexLink
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md)"
os="Run with Docker"
svg="docker" />
- <InstallBox
- to="/docs/agent/packaging/installer/methods/kubernetes"
+ <InstallBoxRegexLink
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md)"
os="Deploy on Kubernetes"
svg="kubernetes" />
- <InstallBox
- to="/docs/agent/packaging/installer/methods/macos"
+ <InstallBoxRegexLink
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md)"
os="Install on macOS"
svg="macos" />
- <InstallBox
- to="/docs/agent/packaging/installer/methods/manual"
+ <InstallBoxRegexLink
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md)"
os="Linux from Git"
svg="linux" />
- <InstallBox
- to="/docs/agent/packaging/installer/methods/source"
+ <InstallBoxRegexLink
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md)"
os="Linux from source"
svg="linux" />
- <InstallBox
- to="/docs/agent/packaging/installer/methods/offline"
+ <InstallBoxRegexLink
+ to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md)"
os="Linux for offline nodes"
svg="linux" />
-</Install>
+</InstallRegexLink>
## What's next?
@@ -73,35 +102,28 @@ Where you go from here is based on your use case, immediate needs, and experienc
### Dashboard
-Learn more about [how the dashboard works](/docs/dashboard/how-dashboard-works.mdx), or dive directly into the many ways
-to [interact with charts](/docs/dashboard/interact-charts.mdx).
+Learn more about [how the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx), or dive directly into the many ways
+to [interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx).
### Configuration
-Discover the recommended way to [configure Netdata's settings or behavior](/docs/configure/nodes.md) using our built-in
+Discover the recommended way to [configure Netdata's settings or behavior](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) using our built-in
`edit-config` script, then apply that knowledge to mission-critical tweaks, such as [changing how long Netdata stores
-metrics](/docs/store/change-metrics-storage.md).
+metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md).
### Data collection
If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should
-learn more about [how data collectors work](/docs/collect/how-collectors-work.md). If there's a [supported
-collector](/collectors/COLLECTORS.md) for metrics you need, [configure the collector](/docs/collect/enable-configure.md)
+learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md). If there's a [supported
+collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for metrics you need, [configure the collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.
### Alarms & notifications
Netdata comes with hundreds of preconfigured alarms, designed by our monitoring gurus in parallel with our open-source
-community, but you may want to [edit alarms](/docs/monitor/configure-alarms.md) or [enable
-notifications](/docs/monitor/enable-notifications.md) to customize your Netdata experience.
-
-### Need to monitor multiple nodes in one place?
+community, but you may want to [edit alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or
+[enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to customize your Netdata experience.
-For robust multi-node monitoring from a single interface, consider [Netdata
-Cloud](https://learn.netdata.cloud/docs/cloud), which streams, aggregates, and visualizes metrics from any number of
-nodes. It's all the same out-of-the-box, zero-configuration functionality of the open-source monitoring agent, but for
-any number of distributed nodes, _entirely for free_.
+### Make your deployment production ready
-There is an alternative for those who aren't interested in using Netdata Cloud, albeit with some required configuration.
-Each node can [stream](/streaming/README.md) its metrics to any other node, and the default
-[registry](/registry/README.md) is configurable to create a private "network" of Netdata dashboards.
+Both [securing Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md) and [setting up replication](https://github.com/netdata/netdata/blob/master/streaming/README.md) are strongly recommended.