summaryrefslogtreecommitdiffstats
path: root/docs/get-started.mdx
blob: aa82e811b1b6bc819b592274cfd21b894aaec75f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<!--
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."
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://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](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).  
This script automatically installs dependencies and builds Netdata from its source code.

To install, copy the script, paste it into your node's terminal, and hit `Enter` to begin the installation process.

 <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

<InstallRegexLink>
  <InstallBoxRegexLink
    to="[](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md)"
    os="Run with Docker" 
    svg="docker" />
  <InstallBoxRegexLink
    to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md)"
    os="Deploy on Kubernetes" 
    svg="kubernetes" />
   <InstallBoxRegexLink
    to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md)"
    os="Install on macOS" 
    svg="macos" />
  <InstallBoxRegexLink
    to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md)"
    os="Linux from Git" 
    svg="linux" />
  <InstallBoxRegexLink
    to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md)"
    os="Linux from source"
    svg="linux" />
  <InstallBoxRegexLink
    to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md)" 
    os="Linux for offline nodes"
    svg="linux" />
</InstallRegexLink>


## What's next?

To start using Netdata, open a browser and navigate to `http://NODE:19999`, replacing `NODE` with either `localhost` or
the hostname/IP address of a remote node.

Where you go from here is based on your use case, immediate needs, and experience with monitoring and troubleshooting.

### Dashboard

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](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](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](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](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.

### Make your deployment production ready

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.