diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Add-more-charts-to-netdata.md | 3 | ||||
-rw-r--r-- | docs/get-started.mdx | 69 | ||||
-rw-r--r-- | docs/guides/export/export-netdata-metrics-graphite.md | 5 | ||||
-rw-r--r-- | docs/guides/monitor/lamp-stack.md | 5 | ||||
-rw-r--r-- | docs/guides/monitor/pi-hole-raspberry-pi.md | 7 | ||||
-rw-r--r-- | docs/guides/step-by-step/step-00.md | 14 | ||||
-rw-r--r-- | docs/guides/step-by-step/step-09.md | 4 |
7 files changed, 37 insertions, 70 deletions
diff --git a/docs/Add-more-charts-to-netdata.md b/docs/Add-more-charts-to-netdata.md index a16f2e9d..44aa1aba 100644 --- a/docs/Add-more-charts-to-netdata.md +++ b/docs/Add-more-charts-to-netdata.md @@ -5,8 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-ch # Add more charts to Netdata -This file has been deprecated. Please see our [collectors docs](/collectors/README.md) or the collectors [quickstart -guide](/collectors/QUICKSTART.md) for more information. +This file has been deprecated. Please see our [collectors docs](/collectors/README.md) for more information. ## Available data collection modules diff --git a/docs/get-started.mdx b/docs/get-started.mdx index 562c587e..ec36c6a2 100644 --- a/docs/get-started.mdx +++ b/docs/get-started.mdx @@ -6,28 +6,39 @@ sidebar_label: "Get started" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/get-started.mdx --- -import { OneLineInstall } from '../src/components/OneLineInstall/' +import { OneLineInstallWget } from '../src/components/OneLineInstall/' import { Install, InstallBox } from '../src/components/Install/' # Get started with Netdata 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_) and organizes them in an easy-to-use and -navigate interface. +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 -real time and troubleshoot problems that threaten the health of your nodes before they occur. +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. +## 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. + +Copy the script, paste it into your node's terminal, and hit `Enter` to begin the installation process. + +<OneLineInstallWget /> + +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="#install-on-linux-with-one-line-installer-recommended" - os="General Linux with one-line installer (recommended)" - svg="linux" /> - <InstallBox - to="#run-netdata-with-docker" + to="/docs/agent/packaging/docker" os="Run with Docker" svg="docker" /> <InstallBox @@ -39,14 +50,6 @@ Docker), and many other operating systems (FreeBSD, macOS), with no `sudo` requi os="Install on macOS" svg="macos" /> <InstallBox - to="/docs/agent/packaging/installer/methods/packages" - os="Linux with .deb/.rpm packages" - svg="linux" /> - <InstallBox - to="/docs/agent/packaging/installer/methods/kickstart-64" - os="Linux with static 64-bit binary" - svg="linux" /> - <InstallBox to="/docs/agent/packaging/installer/methods/manual" os="Linux from Git" svg="linux" /> @@ -60,40 +63,6 @@ Docker), and many other operating systems (FreeBSD, macOS), with no `sudo` requi svg="linux" /> </Install> -## Install on Linux with one-line installer (recommended) - -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. - -Copy the script, paste it into your node's terminal, and hit `Enter` to begin the installation process. - -<OneLineInstall /> - -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. - -## Run Netdata with Docker - -You can also try out Netdata's capabilities in a [Docker container](/packaging/docker/README.md). Copy the following -`docker run` command into your node and hit `Enter` to download and run the container. - -```bash -docker run -d --name=netdata \ - -p 19999:19999 \ - -v netdataconfig:/etc/netdata \ - -v netdatalib:/var/lib/netdata \ - -v netdatacache:/var/cache/netdata \ - -v /etc/passwd:/host/etc/passwd:ro \ - -v /etc/group:/host/etc/group:ro \ - -v /proc:/host/proc:ro \ - -v /sys:/host/sys:ro \ - -v /etc/os-release:/host/etc/os-release:ro \ - --restart unless-stopped \ - --cap-add SYS_PTRACE \ - --security-opt apparmor=unconfined \ - netdata/netdata -``` ## What's next? diff --git a/docs/guides/export/export-netdata-metrics-graphite.md b/docs/guides/export/export-netdata-metrics-graphite.md index ad18980b..37d2fdb5 100644 --- a/docs/guides/export/export-netdata-metrics-graphite.md +++ b/docs/guides/export/export-netdata-metrics-graphite.md @@ -3,6 +3,7 @@ title: Export and visualize Netdata metrics in Graphite description: "Use Netdata to collect and export thousands of metrics to Graphite for long-term storage or further analysis." image: /img/seo/guides/export/export-netdata-metrics-graphite.png --> +import { OneLineInstallWget } from '../../src/components/OneLineInstall/' # Export and visualize Netdata metrics in Graphite @@ -31,9 +32,7 @@ Let's get started. If you don't have the Netdata Agent installed already, visit the [installation guide](/packaging/installer/README.md) for the recommended instructions for your system. In most cases, you can use the one-line installation script: -```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) -``` +<OneLineInstallWget/> Once installation finishes, open your browser and navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname of your system, to find the Agent dashboard. diff --git a/docs/guides/monitor/lamp-stack.md b/docs/guides/monitor/lamp-stack.md index fbf9ae0b..4fe0defb 100644 --- a/docs/guides/monitor/lamp-stack.md +++ b/docs/guides/monitor/lamp-stack.md @@ -7,6 +7,7 @@ author_title: "Editorial Director, Technical & Educational Resources" author_img: "/img/authors/joel-hans.jpg" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/lamp-stack.md --> +import { OneLineInstallWget } from '../../src/components/OneLineInstall/' # LAMP stack monitoring (Linux, Apache, MySQL, PHP) with Netdata @@ -59,9 +60,7 @@ To follow this tutorial, you need: If you don't have the free, open-source Netdata monitoring agent installed on your node yet, get started with a [single kickstart command](/docs/get-started.mdx): -```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) -``` +<OneLineInstallWget/> The Netdata Agent is now collecting metrics from your node every second. You don't need to jump into the dashboard yet, but if you're curious, open your favorite browser and navigate to `http://localhost:19999` or `http://NODE:19999`, diff --git a/docs/guides/monitor/pi-hole-raspberry-pi.md b/docs/guides/monitor/pi-hole-raspberry-pi.md index 4147ca97..9dc60d3a 100644 --- a/docs/guides/monitor/pi-hole-raspberry-pi.md +++ b/docs/guides/monitor/pi-hole-raspberry-pi.md @@ -4,6 +4,7 @@ description: "Monitor Pi-hole metrics, plus Raspberry Pi system metrics, in minu image: /img/seo/guides/monitor/netdata-pi-hole-raspberry-pi.png custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/pi-hole-raspberry-pi.md --> +import { OneLineInstallWget } from '../../src/components/OneLineInstall/' # Monitor Pi-hole (and a Raspberry Pi) with Netdata @@ -52,9 +53,7 @@ possible historic data. On Raspberry Pis running Raspbian, the best way to install Netdata is our one-line kickstart script. This script asks you to install dependencies, then compiles Netdata from source via [GitHub](https://github.com/netdata/netdata). -```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) -``` +<OneLineInstallWget/> Once installed on a Raspberry Pi 4 with no accessories, Netdata starts collecting roughly 1,500 metrics every second and populates its dashboard with more than 250 charts. @@ -100,7 +99,7 @@ part of your system might affect another. action](https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98-11ea-8f60-0d7824667cd3.gif) If you're completely new to Netdata, look at our [step-by-step guide](/docs/guides/step-by-step/step-00.md) for a -walkthrough of all its features. For a more expedited tour, see the [get started guide](/docs/get-started.md). +walkthrough of all its features. For a more expedited tour, see the [get started guide](/docs/get-started.mdx). ### Enable temperature sensor monitoring diff --git a/docs/guides/step-by-step/step-00.md b/docs/guides/step-by-step/step-00.md index 0a49defe..3cb85ced 100644 --- a/docs/guides/step-by-step/step-00.md +++ b/docs/guides/step-by-step/step-00.md @@ -3,6 +3,7 @@ title: "The step-by-step Netdata guide" date: 2020-03-31 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-00.md --> +import { OneLineInstallWget, OneLineInstallCurl } from '../../src/components/OneLineInstall/' # The step-by-step Netdata guide @@ -17,7 +18,7 @@ completely new to Netdata, or have never tried health monitoring/performance tro guide is perfect for you. If you have monitoring experience, or would rather get straight into configuring Netdata to your needs, you can jump -straight into code and configurations with our [getting started guide](/docs/get-started.md). +straight into code and configurations with our [getting started guide](/docs/get-started.mdx). > This guide contains instructions for Netdata installed on a Linux system. Many of the instructions will work on > other supported operating systems, like FreeBSD and macOS, but we can't make any guarantees. @@ -46,9 +47,14 @@ This script will install Netdata from source, keep it up to date with nightly re [registry](/registry/README.md), and sends [_anonymous statistics_](/docs/anonymous-statistics.md) about how you use Netdata. We use this information to better understand how we can improve the Netdata experience for all our users. -```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) -``` +To install Netdata, run the following as your normal user: + +<OneLineInstallWget/> + +Or, if you have cURL but not wget (such as on macOS): + +<OneLineInstallCurl/> + Once finished, you'll have Netdata installed, and you'll be set up to get _nightly updates_ to get the latest features, improvements, and bugfixes. diff --git a/docs/guides/step-by-step/step-09.md b/docs/guides/step-by-step/step-09.md index c5b2ecd5..6e29d84c 100644 --- a/docs/guides/step-by-step/step-09.md +++ b/docs/guides/step-by-step/step-09.md @@ -122,10 +122,6 @@ libraries to make this exporting connection exist. Since you most likely install script, all you have to do is run that script again. Don't worry—any configuration changes you made along the way will be retained! -```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) -``` - Now, from your Netdata config directory, initialize and edit a `exporting.conf` file to tell Netdata where to find the database you just created. |