get-started.mdx 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. <!--
  2. title: "Install Netdata"
  3. 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."
  4. sidebar_label: "Install Netdata"
  5. custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/get-started.mdx"
  6. learn_status: "Published"
  7. learn_topic_type: "Tasks"
  8. learn_rel_path: "Getting started"
  9. -->
  10. import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
  11. import { InstallRegexLink, InstallBoxRegexLink } from '@site/src/components/InstallRegexLink/'
  12. import Tabs from '@theme/Tabs';
  13. import TabItem from '@theme/TabItem';
  14. Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from
  15. any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface.
  16. Together with [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), you can monitor your entire infrastructure in
  17. real time and troubleshoot problems that threaten the health of your nodes.
  18. Netdata runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices. It
  19. runs on Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters,
  20. Docker), and many other operating systems (FreeBSD, macOS), with no `sudo` required.
  21. To install Netdata in minutes on your platform:
  22. 1. Sign up to https://app.netdata.cloud/
  23. 2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform
  24. 3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it
  25. Upon installation completing successfully, you should be able to see the node live in your Netdata Space!
  26. Continue reading for more advanced instructions and installation options.
  27. ## Install on Linux with one-line installer
  28. The **recommended** way to install Netdata on a Linux node (physical, virtual, container, IoT) is our one-line
  29. [kickstart script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).
  30. This script automatically installs dependencies and builds Netdata from its source code.
  31. To install, copy the script, paste it into your node's terminal, and hit `Enter` to begin the installation process.
  32. <Tabs>
  33. <TabItem value="wget" label=<code>wget</code>>
  34. <OneLineInstallWget/>
  35. </TabItem>
  36. <TabItem value="curl" label=<code>curl</code>>
  37. <OneLineInstallCurl/>
  38. </TabItem>
  39. </Tabs>
  40. :::note
  41. If you plan to also Claim the node to Netdata Cloud,
  42. make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space,
  43. and `YOUR_ROOM_ID` with the ID of the room you are willing to claim to.
  44. :::
  45. Jump down to [what's next](#whats-next) to learn how to view your new dashboard and take your next steps monitoring and
  46. troubleshooting with Netdata.
  47. ## Other installation options
  48. <InstallRegexLink>
  49. <InstallBoxRegexLink
  50. to="[](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md)"
  51. os="Run with Docker"
  52. svg="docker" />
  53. <InstallBoxRegexLink
  54. to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md)"
  55. os="Deploy on Kubernetes"
  56. svg="kubernetes" />
  57. <InstallBoxRegexLink
  58. to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md)"
  59. os="Install on macOS"
  60. svg="macos" />
  61. <InstallBoxRegexLink
  62. to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md)"
  63. os="Linux from Git"
  64. svg="linux" />
  65. <InstallBoxRegexLink
  66. to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md)"
  67. os="Linux from source"
  68. svg="linux" />
  69. <InstallBoxRegexLink
  70. to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md)"
  71. os="Linux for offline nodes"
  72. svg="linux" />
  73. </InstallRegexLink>
  74. ## What's next?
  75. To start using Netdata, open a browser and navigate to `http://NODE:19999`, replacing `NODE` with either `localhost` or
  76. the hostname/IP address of a remote node.
  77. Where you go from here is based on your use case, immediate needs, and experience with monitoring and troubleshooting.
  78. ### Dashboard
  79. 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
  80. to [interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx).
  81. ### Configuration
  82. 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
  83. `edit-config` script, then apply that knowledge to mission-critical tweaks, such as [changing how long Netdata stores
  84. metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md).
  85. ### Data collection
  86. If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should
  87. 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
  88. 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)
  89. or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.
  90. ### Alarms & notifications
  91. Netdata comes with hundreds of preconfigured alarms, designed by our monitoring gurus in parallel with our open-source
  92. community, but you may want to [edit alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or
  93. [enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to customize your Netdata experience.
  94. ### Make your deployment production ready
  95. 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.