summaryrefslogtreecommitdiffstats
path: root/packaging/installer/methods/kickstart.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-12-01 06:15:04 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-12-01 06:15:04 +0000
commite970e0b37b8bd7f246feb3f70c4136418225e434 (patch)
tree0b67c0ca45f56f2f9d9c5c2e725279ecdf52d2eb /packaging/installer/methods/kickstart.md
parentAdding upstream version 1.31.0. (diff)
downloadnetdata-e970e0b37b8bd7f246feb3f70c4136418225e434.tar.xz
netdata-e970e0b37b8bd7f246feb3f70c4136418225e434.zip
Adding upstream version 1.32.0.upstream/1.32.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'packaging/installer/methods/kickstart.md')
-rw-r--r--packaging/installer/methods/kickstart.md64
1 files changed, 40 insertions, 24 deletions
diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md
index e874d637..7792989e 100644
--- a/packaging/installer/methods/kickstart.md
+++ b/packaging/installer/methods/kickstart.md
@@ -11,15 +11,23 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal
This page covers detailed instructions on using and configuring the automatic one-line installation script named
`kickstart.sh`.
-This method is fully automatic on all Linux distributions. To install Netdata from source, including all dependencies
+This method is fully automatic on all Linux distributions and macOS environments. To install Netdata from source, including all dependencies
required to connect to Netdata Cloud, and get _automatic nightly updates_, run the following as your normal user:
+**Linux**
+
```bash
bash <(curl -Ss https://my-netdata.io/kickstart.sh)
```
-> See our [installation guide](../README.md) for details about [automatic updates](../README.md#automatic-updates) or
-> [nightly vs. stable releases](../README.md#nightly-vs-stable-releases).
+**macOS**
+
+```bash
+bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/
+```
+
+> See our [installation guide](/packaging/installer/README.md) for details about [automatic updates](/packaging/installer/README.md#automatic-updates) or
+> [nightly vs. stable releases](/packaging/installer/README.md#nightly-vs-stable-releases).
## What does `kickstart.sh` do?
@@ -40,33 +48,39 @@ The `kickstart.sh` script does the following after being downloaded and run usin
The `kickstart.sh` script passes all its parameters to `netdata-installer.sh`, which you can use to customize your
installation. Here are a few important parameters:
-- `--dont-wait`: Enable automated installs by not prompting for permission to install any required packages.
-- `--dont-start-it`: Prevent the installer from starting Netdata automatically.
-- `--stable-channel`: Automatically update only on the release of new major versions.
-- `--nightly-channel`: Automatically update on every new nightly build.
-- `--disable-telemetry`: Opt-out of [anonymous statistics](/docs/anonymous-statistics.md) we use to make
- Netdata better.
-- `--no-updates`: Prevent automatic updates of any kind.
-- `--reinstall`: If an existing install is detected, reinstall instead of trying to update it. Note that this
- cannot be used to change installation types.
-- `--local-files`: Used for [offline installations](offline.md). Pass four file paths: the Netdata
+- `--dont-wait`: Synonym for `--non-interactive`
+- `--non-interactive`: Don’t prompt for anything and assume yes whenever possible.
+- `--no-updates`: Disable automatic updates.
+- `--stable-channel`: Use a stable build instead of a nightly build.
+- `--reinstall`: If an existing install is found, reinstall instead of trying to update it in place.
+- `--dont-start-it`: Don’t auto-start the daemon after installing. This parameter is not guaranteed to work.
+- `--install`: Specify an alternative install prefix.
+- `--disable-cloud`: For local builds, don’t build any of the cloud code at all. For native packages and static builds,
+ use runtime configuration to disable cloud support.
+- `--auto-update-type`: Specify how auto-updates are to be scheduled, overriding auto-detection.
+- `--disable-telemetry`: Disable anonymous statistics.
+- `--local-files`: Used for [offline installations](offline.md). Pass four file paths: the Netdata
tarball, the checksum file, the go.d plugin tarball, and the go.d plugin config tarball, to force kickstart run the
process using those files. This option conflicts with the `--stable-channel` option. If you set this _and_
`--stable-channel`, Netdata will use the local files.
+- `all`: Ask for all dependencies in the dependency handling script.
+
+ > Note: The `all` and `--local-files` parameters are scheduled to be removed in a forthcoming update.
+
+### Connect node to Netdata Cloud during installation
-### Claim node to Netdata Cloud during installation
-
-The `kickstart.sh` script accepts additional parameters to automatically [claim](/claim/README.md) your node to Netdata
+The `kickstart.sh` script accepts additional parameters to automatically [connect](/claim/README.md) your node to Netdata
Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata
-Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Claim Nodes** in the [Spaces management
+Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Connect Nodes** in the [Spaces management
area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
-- `--claim-token`: The unique token associated with your Space in Netdata Cloud.
-- `--claim-rooms`: A comma-separated list of tokens for each War Room this node should appear in.
-- `--claim-proxy`: Should take the form of `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or
- `http://[user:pass@]host:ip` for an HTTP(S) proxy.See [claiming through a
- proxy](/claim/README.md#claim-through-a-proxy) for details.
-- `--claim-url`: Defaults to `https://app.netdata.cloud`.
+- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
+ after the install.
+- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in.
+- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of
+ `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or `http://[user:pass@]host:ip` for an HTTP(S) proxy.
+ See [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details.
+- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`.
For example:
@@ -74,13 +88,15 @@ For example:
bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
```
+Please note that to run it you will either need to have root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](#connect-an-agent-without-root-privileges) section.
+
## Verify script integrity
To use `md5sum` to verify the integrity of the `kickstart.sh` script you will download using the one-line command above,
run the following:
```bash
-[ "a708de3790fa39188babe71eb1639c66" = "$(curl -Ss https://my-netdata.io/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"
+[ "7e8b449ca44e49b7074b5b9d6022cbcc" = "$(curl -Ss https://my-netdata.io/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"
```
If the script is valid, this command will return `OK, VALID`.