diff options
Diffstat (limited to 'DOCUMENTATION.md')
| -rw-r--r-- | DOCUMENTATION.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md new file mode 100644 index 000000000..c24c011f1 --- /dev/null +++ b/DOCUMENTATION.md @@ -0,0 +1,53 @@ +# Netdata Documentation + +**Netdata is real-time health monitoring and performance troubleshooting for systems and applications.** It helps you instantly diagnose slowdowns and anomalies in your infrastructure with thousands of metrics, interactive visualizations, and insightful health alarms. + +## Navigating the Netdata documentation + +Welcome! You've arrived at the documentation for Netdata. Use the links below to find answers to the most common questions about Netdata, such as how to install it, getting started guides, basic configuration, and adding more charts. Or, explore all of Netdata's documentation using the table of contents to your left. + +<div class="homepage-nav"> + + <div class="nav-install"> + <a class="nav-button" href="packaging/installer/#one-line-installation">One-line installation</a> + <p>Use our completely automated one-line installation process to get Netdata on all Linux distributions. Or, find detailed instructions for binary packages, Kubernetes, macOS, and more.</p> + + </div> + <div class="nav-getting-started"> + <a class="nav-button" href="docs/GettingStarted/">Getting started guide</a> + <p>The perfect place for Netdata beginners to start. Learn how to access Netdata's dashboard, start and stop the service, basic configuration, and more.</p> + + </div> + <div class="nav-configuration"> + <a class="nav-button" href="docs/configuration-guide/">Configuration guide</a> + <p>Take your configuration options from the <em>getting started guide</em> to the next level. Increase metrics retention, modify how charts are displayed, disable collectors, and modify alarms.</p> + </div> + +</div> + +**Netdata Cloud**: Use [Netdata Cloud](docs/netdata-cloud/) and the [Nodes View](docs/netdata-cloud/nodes-view.md) to view real-time, distributed health monitoring and performance troubleshooting data for all your systems in one place. Add as many nodes as you'd like! + +**Advanced users**: For those who already understand how to access a Netdata dashboard and perform basic configuration, feel free to see what's behind any of these other doors. + +- [Netdata Behind Nginx](docs/Running-behind-nginx.md): Use an Nginx web server instead of Netdata's built-in server to enable TLS, HTTPS, and basic authentication. +- [Add More Charts](docs/Add-more-charts-to-netdata.md): Enable new internal or external plugins and understand when auto-detection works. +- [Performance](docs/Performance.md): Tips on running Netdata on devices with limited CPU and RAM resources, such as embedded devices, IoT, and edge devices. +- [Streaming](streaming/): Information for those who want to centralize Netdata metrics from any number of distributed agents. +- [Backends](backends/): Learn how to archive Netdata's real-time metrics to a time series database (like Prometheus) for long-term archiving. + +Visit the [contributing guide](CONTRIBUTING.md), [contributing to documentation guide](docs/contributing/contributing-documentation.md), and [documentation style guide](docs/contributing/style-guide.md) to learn more about our community and how you can get started contributing to Netdata. + +## Subscribe for news and tips from monitoring pros + +<script charset="utf-8" type="text/javascript" src="//js.hsforms.net/forms/shell.js"></script> + +<script> + hbspt.forms.create({ + portalId: "4567453", + formId: "6a20deb5-a1e6-4312-9c4d-f6862f947fe0" +}); +</script> + +--- + + |