| 1 | import { OneLineInstall } from '@site/src/components/OneLineInstall/' |
| 2 | import { Install, InstallBox } from '@site/src/components/Install/' |
| 3 | import Tabs from '@theme/Tabs'; |
| 4 | import TabItem from '@theme/TabItem'; |
| 5 | |
| 6 | # Install Netdata with kickstart.sh |
| 7 | |
| 8 | `kickstart.sh` is the recommended way to install Netdata. |
| 9 | |
| 10 | This installation script works on all major Linux distributions. It automatically detects the best way to install Netdata for your system. |
| 11 | |
| 12 | <details><summary>What does kickstart.sh actually do?</summary> |
| 13 | |
| 14 | 1. Detects your OS and environment |
| 15 | 2. Checks for an existing Netdata installation |
| 16 | 3. Installs using: |
| 17 | - Native packages (preferred) |
| 18 | - Static build (fallback) |
| 19 | - Build from source (last resort) |
| 20 | 4. Installs an auto-update cron job (unless disabled) |
| 21 | 5. Optionally connects your node to Netdata Cloud |
| 22 | |
| 23 | </details> |
| 24 | |
| 25 | ## Quick Overview |
| 26 | |
| 27 | | Task | Command / Location | Notes | |
| 28 | |-----------------------|--------------------------------|-----------------------------------------| |
| 29 | | Install Netdata | Run `kickstart.sh` | Choose nightly or stable release | |
| 30 | | Connect to Cloud | Use claim token | Connect node to Netdata Cloud | |
| 31 | | Customize install | Pass flags to control behavior | Directory, release, update control | |
| 32 | | Export config for IaC | Copy config from Cloud UI | For automation & Infrastructure as Code | |
| 33 | |
| 34 | ## Run the One-Line Install Command |
| 35 | |
| 36 | To install and connect to Netdata Cloud in a single step from your terminal: |
| 37 | |
| 38 | <Tabs> |
| 39 | <TabItem value="wget" label="wget"> |
| 40 | <OneLineInstall |
| 41 | method="wget" |
| 42 | privacyMd="[anonymous statistics?](/docs/netdata-agent/configuration/anonymous-telemetry-events.md)" |
| 43 | connectMd="[connect](/src/claim/README.md)" |
| 44 | /> |
| 45 | </TabItem> |
| 46 | |
| 47 | <TabItem value="curl" label="curl"> |
| 48 | <OneLineInstall |
| 49 | method="curl" |
| 50 | privacyMd="[anonymous statistics?](/docs/netdata-agent/configuration/anonymous-telemetry-events.md)" |
| 51 | connectMd="[connect](/src/claim/README.md)" |
| 52 | /> |
| 53 | </TabItem> |
| 54 | </Tabs> |
| 55 | |
| 56 | :::tip |
| 57 | |
| 58 | Pick **Stable** or **Nightly**: Check the [guide](/packaging/PLATFORM_SUPPORT.md) for differences. |
| 59 | |
| 60 | ::: |
| 61 | |
| 62 | <details><summary>🔍 Where to find your claim token</summary> |
| 63 | |
| 64 | 1. Log in to [Netdata Cloud](https://app.netdata.cloud) |
| 65 | 2. Navigate to your Space |
| 66 | 3. Go to **Space Settings** → **Nodes** |
| 67 | 4. Click **Add Node** → Copy Claim Token |
| 68 | |
| 69 | </details> |
| 70 | |
| 71 | ## Optional Parameters for kickstart.sh |
| 72 | |
| 73 | Use these flags to customize your installation. |
| 74 | |
| 75 | | Category | Parameter | Purpose | |
| 76 | |-------------------------|------------------------|-------------------------------------| |
| 77 | | **Directory Options** | `--install-prefix` | Custom install directory | |
| 78 | | | `--old-install-prefix` | Clean previous install directory | |
| 79 | | **Interactivity** | `--non-interactive` | No prompts (good for scripts) | |
| 80 | | | `--interactive` | Force interactive prompts | |
| 81 | | **Release Channel** | `--release-channel` | `nightly` or `stable` | |
| 82 | | | `--install-version` | Install specific version | |
| 83 | | **Auto-Updates** | `--auto-update` | Enable updates | |
| 84 | | | `--no-updates` | Disable updates | |
| 85 | | **Netdata Cloud** | `--claim-token` | Provide claim token | |
| 86 | | | `--claim-rooms` | Assign node to specific Cloud Rooms | |
| 87 | | **Reinstall/Uninstall** | `--reinstall` | Reinstall existing Netdata | |
| 88 | | | `--uninstall` | Uninstall Netdata completely | |
| 89 | |
| 90 | ## Environment Variables |
| 91 | |
| 92 | These environment variables provide additional customization options (most users won't need these): |
| 93 | |
| 94 | | Variable | Purpose | Default Behavior | |
| 95 | |---------------------|----------------------------------------------|---------------------------------------------| |
| 96 | | `TMPDIR` | Specify directory for temporary files | System default temp directory | |
| 97 | | `ROOTCMD` | Command to run with root privileges | Uses `sudo`, `doas`, or `pkexec` (in order) | |
| 98 | | `DISABLE_TELEMETRY` | Disable telemetry when set to non-zero value | Telemetry enabled | |
| 99 | |
| 100 | :::note |
| 101 | |
| 102 | The user running the script needs write and execute permissions in the temporary directory specified by TMPDIR. |
| 103 | |
| 104 | ::: |
| 105 | |
| 106 | ## Verify Script Integrity |
| 107 | |
| 108 | Before running the installation script, you can verify its integrity using the following command: |
| 109 | |
| 110 | ```bash |
| 111 | [ "@KICKSTART_CHECKSUM@" = "$(curl -Ss https://get.netdata.cloud/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID" |
| 112 | ``` |
| 113 | |
| 114 | If the script is valid, this command will return `OK, VALID`. We recommend verifying script integrity before installation, especially in production environments. |
| 115 | |
| 116 | ## Notes & Best Practices |
| 117 | |
| 118 | - Stop the Agent with `sudo systemctl stop netdata` before reinstalling |
| 119 | - Customize install location or behavior with flags |
| 120 | - Always verify the downloaded script for security |
| 121 | - Use the `--non-interactive` flag in CI/CD pipelines |
| 122 | |
| 123 | ## Related Docs |
| 124 | |
| 125 | - [Connect to Netdata Cloud](/src/claim/README.md) |
| 126 | - [Release Channels & Versions](/packaging/PLATFORM_SUPPORT.md) |
| 127 | - [Uninstall Guide](/packaging/installer/UNINSTALL.md) |
| 128 | - [Offline Installation Guide](/packaging/installer/methods/offline.md) |