mirror of
https://github.com/netdata/netdata.git
synced 2025-04-29 15:10:02 +00:00
134 lines
5.4 KiB
Markdown
134 lines
5.4 KiB
Markdown
import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
|
|
import { Install, InstallBox } from '@site/src/components/Install/'
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# Install Netdata with kickstart.sh
|
|
|
|
`kickstart.sh` is the recommended way to install Netdata.
|
|
|
|
This installation script works on all major Linux distributions. It automatically detects the best way to install Netdata for your system.
|
|
|
|
<details><summary>What does kickstart.sh actually do?</summary>
|
|
|
|
1. Detects your OS and environment
|
|
2. Checks for an existing Netdata installation
|
|
3. Installs using:
|
|
- Native packages (preferred)
|
|
- Static build (fallback)
|
|
- Build from source (last resort)
|
|
4. Installs an auto-update cron job (unless disabled)
|
|
5. Optionally connects your node to Netdata Cloud
|
|
|
|
</details>
|
|
|
|
---
|
|
|
|
## Quick Overview
|
|
|
|
| Task | Command / Location | Notes |
|
|
|-----------------------|--------------------------------|-----------------------------------------|
|
|
| Install Netdata | Run `kickstart.sh` | Choose nightly or stable release |
|
|
| Connect to Cloud | Use claim token | Connect node to Netdata Cloud |
|
|
| Customize install | Pass flags to control behavior | Directory, release, update control |
|
|
| Export config for IaC | Copy config from Cloud UI | For automation & Infrastructure as Code |
|
|
|
|
---
|
|
|
|
## Run the One-Line Install Command
|
|
|
|
To install and connect to Netdata Cloud in a single step from your terminal:
|
|
|
|
<Tabs>
|
|
<TabItem value="wget" label="wget">
|
|
|
|
<OneLineInstallWget/>
|
|
|
|
</TabItem>
|
|
<TabItem value="curl" label="curl">
|
|
|
|
<OneLineInstallCurl/>
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
> **Tip**
|
|
> Pick **Stable** or **Nightly**: Check the [guide](/docs/netdata-agent/versions-and-platforms.md) for differences.
|
|
|
|
<details><summary>🔍 Where to find your claim token</summary>
|
|
|
|
1. Log in to [Netdata Cloud](https://app.netdata.cloud)
|
|
2. Navigate to your Space
|
|
3. Go to **Space Settings** → **Nodes**
|
|
4. Click **Add Node** → Copy Claim Token
|
|
|
|
<!-- Screenshot Placeholder -->
|
|
<!--  -->
|
|
|
|
</details>
|
|
|
|
---
|
|
|
|
## Optional Parameters for kickstart.sh
|
|
|
|
Use these flags to customize your installation.
|
|
|
|
| Category | Parameter | Purpose |
|
|
|-------------------------|------------------------|-------------------------------------|
|
|
| **Directory Options** | `--install-prefix` | Custom install directory |
|
|
| | `--old-install-prefix` | Clean previous install directory |
|
|
| **Interactivity** | `--non-interactive` | No prompts (good for scripts) |
|
|
| | `--interactive` | Force interactive prompts |
|
|
| **Release Channel** | `--release-channel` | `nightly` or `stable` |
|
|
| | `--install-version` | Install specific version |
|
|
| **Auto-Updates** | `--auto-update` | Enable updates |
|
|
| | `--no-updates` | Disable updates |
|
|
| **Netdata Cloud** | `--claim-token` | Provide claim token |
|
|
| | `--claim-rooms` | Assign node to specific Cloud Rooms |
|
|
| **Reinstall/Uninstall** | `--reinstall` | Reinstall existing Netdata |
|
|
| | `--uninstall` | Uninstall Netdata completely |
|
|
|
|
---
|
|
|
|
## Environment Variables
|
|
|
|
These environment variables provide additional customization options (most users won't need these):
|
|
|
|
| Variable | Purpose | Default Behavior |
|
|
|---------------------|----------------------------------------------|---------------------------------------------|
|
|
| `TMPDIR` | Specify directory for temporary files | System default temp directory |
|
|
| `ROOTCMD` | Command to run with root privileges | Uses `sudo`, `doas`, or `pkexec` (in order) |
|
|
| `DISABLE_TELEMETRY` | Disable telemetry when set to non-zero value | Telemetry enabled |
|
|
|
|
> [!NOTE]
|
|
> The user running the script needs write and execute permissions in the temporary directory specified by TMPDIR.
|
|
|
|
---
|
|
|
|
## Verify Script Integrity
|
|
|
|
Before running the installation script, you can verify its integrity using the following command:
|
|
|
|
```bash
|
|
[ "@KICKSTART_CHECKSUM@" = "$(curl -Ss https://get.netdata.cloud/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"
|
|
```
|
|
|
|
If the script is valid, this command will return `OK, VALID`. We recommend verifying script integrity before installation, especially in production environments.
|
|
|
|
---
|
|
|
|
## Notes & Best Practices
|
|
|
|
- Stop the Agent with `sudo systemctl stop netdata` before reinstalling
|
|
- Customize install location or behavior with flags
|
|
- Always verify the downloaded script for security
|
|
- Use the `--non-interactive` flag in CI/CD pipelines
|
|
|
|
---
|
|
|
|
## Related Docs
|
|
|
|
- [Connect to Netdata Cloud](/docs/netdata-cloud/connect-agent-to-cloud)
|
|
- [Release Channels & Versions](/docs/netdata-agent/versions-and-platforms.md)
|
|
- [Uninstall Guide](/docs/netdata-agent/maintenance/uninstall)
|
|
- [Offline Installation Guide](/packaging/installer/methods/offline.md)
|