| 1 | - &linux |
| 2 | id: deploy-linux-generic |
| 3 | meta: &linux_meta |
| 4 | name: Linux |
| 5 | link: "" |
| 6 | categories: |
| 7 | - deploy.operating-systems |
| 8 | icon_filename: "linux.svg" |
| 9 | keywords: |
| 10 | - linux |
| 11 | install_description: "Run the following command on your node to install and connnect Netdata to your Space:" |
| 12 | methods: |
| 13 | - &ks_wget |
| 14 | method: wget |
| 15 | commands: |
| 16 | - channel: nightly |
| 17 | command: > |
| 18 | wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --nightly-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %} |
| 19 | - channel: stable |
| 20 | command: > |
| 21 | wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --stable-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %} |
| 22 | - &ks_curl |
| 23 | method: curl |
| 24 | commands: |
| 25 | - channel: nightly |
| 26 | command: > |
| 27 | curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --nightly-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %} |
| 28 | - channel: stable |
| 29 | command: > |
| 30 | curl https://get.netdata.cloud/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --stable-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %} |
| 31 | additional_info: &ref_containers > |
| 32 | Did you know you can also deploy Netdata on your OS using {% goToCategory navigateToSettings=$navigateToSettings categoryId="deploy.docker-kubernetes" %}Kubernetes{% /goToCategory %} or {% goToCategory categoryId="deploy.docker-kubernetes" %}Docker{% /goToCategory %}? |
| 33 | clean_additional_info: &ref_clean_containers > |
| 34 | Did you know you can also deploy Netdata on your OS using Kubernetes or Docker? |
| 35 | related_resources: {} |
| 36 | platform_info: |
| 37 | group: "" |
| 38 | distro: "" |
| 39 | quick_start: 1 |
| 40 | - <<: *linux |
| 41 | id: deploy-ubuntu |
| 42 | meta: |
| 43 | <<: *linux_meta |
| 44 | name: Ubuntu |
| 45 | link: https://ubuntu.com/ |
| 46 | icon_filename: "ubuntu.svg" |
| 47 | platform_info: |
| 48 | group: "include" |
| 49 | distro: "ubuntu" |
| 50 | quick_start: -1 |
| 51 | - <<: *linux |
| 52 | id: deploy-debian |
| 53 | meta: |
| 54 | <<: *linux_meta |
| 55 | name: Debian |
| 56 | link: https://www.debian.org/ |
| 57 | icon_filename: "debian.svg" |
| 58 | platform_info: |
| 59 | group: "include" |
| 60 | distro: "debian" |
| 61 | quick_start: -1 |
| 62 | - <<: *linux |
| 63 | id: deploy-fedora |
| 64 | meta: |
| 65 | <<: *linux_meta |
| 66 | name: Fedora |
| 67 | link: https://www.fedoraproject.org/ |
| 68 | icon_filename: "fedora.png" |
| 69 | platform_info: |
| 70 | group: "include" |
| 71 | distro: "fedora" |
| 72 | quick_start: -1 |
| 73 | - <<: *linux |
| 74 | id: deploy-rhel |
| 75 | meta: |
| 76 | <<: *linux_meta |
| 77 | name: Red Hat Enterprise Linux |
| 78 | link: https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux |
| 79 | icon_filename: "rhel.png" |
| 80 | platform_info: |
| 81 | group: "no_include" |
| 82 | distro: "rhel" |
| 83 | quick_start: -1 |
| 84 | - <<: *linux |
| 85 | id: deploy-rockylinux |
| 86 | meta: |
| 87 | <<: *linux_meta |
| 88 | name: Rocky Linux |
| 89 | link: https://rockylinux.org/ |
| 90 | icon_filename: "rocky.svg" |
| 91 | platform_info: |
| 92 | group: "include" |
| 93 | distro: "rockylinux" |
| 94 | quick_start: -1 |
| 95 | - <<: *linux |
| 96 | id: deploy-alpinelinux |
| 97 | meta: |
| 98 | <<: *linux_meta |
| 99 | name: Alpine Linux |
| 100 | link: https://www.alpinelinux.org/ |
| 101 | icon_filename: "alpine.svg" |
| 102 | platform_info: |
| 103 | group: "include" |
| 104 | distro: "alpinelinux" |
| 105 | quick_start: -1 |
| 106 | - <<: *linux |
| 107 | id: deploy-amazonlinux |
| 108 | meta: |
| 109 | <<: *linux_meta |
| 110 | name: Amazon Linux |
| 111 | link: https://aws.amazon.com/amazon-linux-2/ |
| 112 | icon_filename: "amazonlinux.png" |
| 113 | platform_info: |
| 114 | group: "include" |
| 115 | distro: "amazonlinux" |
| 116 | quick_start: -1 |
| 117 | - <<: *linux |
| 118 | id: deploy-archlinux |
| 119 | meta: |
| 120 | <<: *linux_meta |
| 121 | name: Arch Linux |
| 122 | link: https://archlinux.org/ |
| 123 | icon_filename: "archlinux.png" |
| 124 | platform_info: |
| 125 | group: "include" |
| 126 | distro: "archlinux" |
| 127 | quick_start: -1 |
| 128 | - <<: *linux |
| 129 | id: deploy-centos |
| 130 | meta: |
| 131 | <<: *linux_meta |
| 132 | name: CentOS |
| 133 | link: https://www.centos.org/ |
| 134 | icon_filename: "centos.svg" |
| 135 | platform_info: |
| 136 | group: "include" |
| 137 | distro: "centos" |
| 138 | quick_start: -1 |
| 139 | - <<: *linux |
| 140 | id: deploy-centos-stream |
| 141 | meta: |
| 142 | <<: *linux_meta |
| 143 | name: CentOS Stream |
| 144 | link: https://www.centos.org/centos-stream |
| 145 | icon_filename: "centos.svg" |
| 146 | platform_info: |
| 147 | group: "include" |
| 148 | distro: "centos-stream" |
| 149 | quick_start: -1 |
| 150 | - <<: *linux |
| 151 | id: deploy-manjarolinux |
| 152 | meta: |
| 153 | <<: *linux_meta |
| 154 | name: Manjaro Linux |
| 155 | link: https://manjaro.org/ |
| 156 | icon_filename: "manjaro.svg" |
| 157 | platform_info: |
| 158 | group: "include" |
| 159 | distro: "archlinux" |
| 160 | quick_start: -1 |
| 161 | - <<: *linux |
| 162 | id: deploy-oraclelinux |
| 163 | meta: |
| 164 | <<: *linux_meta |
| 165 | name: Oracle Linux |
| 166 | link: https://www.oracle.com/linux/ |
| 167 | icon_filename: "oraclelinux.svg" |
| 168 | platform_info: |
| 169 | group: "include" |
| 170 | distro: "oraclelinux" |
| 171 | quick_start: -1 |
| 172 | - <<: *linux |
| 173 | id: deploy-opensuse |
| 174 | meta: |
| 175 | <<: *linux_meta |
| 176 | name: SUSE Linux |
| 177 | link: https://www.suse.com/ |
| 178 | icon_filename: "openSUSE.svg" |
| 179 | platform_info: |
| 180 | group: "include" |
| 181 | distro: "opensuse" |
| 182 | quick_start: -1 |
| 183 | - id: deploy-macos |
| 184 | meta: |
| 185 | name: macOS |
| 186 | link: "" |
| 187 | categories: |
| 188 | - deploy.operating-systems |
| 189 | icon_filename: "macos.svg" |
| 190 | keywords: |
| 191 | - macOS |
| 192 | - mac |
| 193 | - apple |
| 194 | install_description: "Run the following command on your Intel based OSX, macOS servers to install and claim Netdata:" |
| 195 | methods: |
| 196 | - *ks_curl |
| 197 | additional_info: *ref_containers |
| 198 | clean_additional_info: *ref_clean_containers |
| 199 | related_resources: {} |
| 200 | platform_info: |
| 201 | group: "no_include" |
| 202 | distro: "macos" |
| 203 | quick_start: 5 |
| 204 | - id: deploy-docker |
| 205 | meta: |
| 206 | name: Docker |
| 207 | link: "https://www.docker.com/" |
| 208 | categories: |
| 209 | - deploy.docker-kubernetes |
| 210 | icon_filename: "docker.svg" |
| 211 | keywords: |
| 212 | - docker |
| 213 | - container |
| 214 | - containers |
| 215 | install_description: | |
| 216 | Install and connect new Docker containers |
| 217 | Find the commands for `docker run`, `docker compose` or `Docker Swarm`. On the last two you can copy the configs, then run `docker-compose up -d` in the same directory as the `docker-compose.yml` |
| 218 | |
| 219 | > Netdata container requires different privileges and mounts to provide functionality similar to that provided by Netdata installed on the host. More info [here](https://learn.netdata.cloud/docs/installing/docker?_gl=1*f2xcnf*_ga*MTI1MTUwMzU0OS4xNjg2NjM1MDA1*_ga_J69Z2JCTFB*MTY5MDMxMDIyMS40MS4xLjE2OTAzMTAzNjkuNTguMC4w#create-a-new-netdata-agent-container) |
| 220 | > Netdata will use the hostname from the container in which it is run instead of that of the host system. To change the default hostname check [here](https://learn.netdata.cloud/docs/agent/packaging/docker?_gl=1*i5weve*_ga*MTI1MTUwMzU0OS4xNjg2NjM1MDA1*_ga_J69Z2JCTFB*MTY5MDMxMjM4Ny40Mi4xLjE2OTAzMTIzOTAuNTcuMC4w#change-the-default-hostname) |
| 221 | methods: |
| 222 | - method: Docker CLI |
| 223 | commands: |
| 224 | - channel: nightly |
| 225 | command: | |
| 226 | docker run -d --name=netdata \ |
| 227 | --pid=host \ |
| 228 | --network=host \ |
| 229 | -v netdataconfig:/etc/netdata \ |
| 230 | -v netdatalib:/var/lib/netdata \ |
| 231 | -v netdatacache:/var/cache/netdata \ |
| 232 | -v /:/host/root:ro,rslave \ |
| 233 | -v /etc/passwd:/host/etc/passwd:ro \ |
| 234 | -v /etc/group:/host/etc/group:ro \ |
| 235 | -v /etc/localtime:/etc/localtime:ro \ |
| 236 | -v /proc:/host/proc:ro \ |
| 237 | -v /sys:/host/sys:ro \ |
| 238 | -v /etc/os-release:/host/etc/os-release:ro \ |
| 239 | -v /var/log:/host/var/log:ro \ |
| 240 | -v /var/run/docker.sock:/var/run/docker.sock:ro \ |
| 241 | -v /run/dbus:/run/dbus:ro \ |
| 242 | --restart unless-stopped \ |
| 243 | --cap-add SYS_PTRACE \ |
| 244 | --cap-add SYS_ADMIN \ |
| 245 | --security-opt apparmor=unconfined \ |
| 246 | {% if $showClaimingOptions %} |
| 247 | -e NETDATA_CLAIM_TOKEN={% claim_token %} \ |
| 248 | -e NETDATA_CLAIM_URL={% claim_url %} \ |
| 249 | -e NETDATA_CLAIM_ROOMS={% $claim_rooms %} \ |
| 250 | {% /if %} |
| 251 | netdata/netdata:edge |
| 252 | - channel: stable |
| 253 | command: | |
| 254 | docker run -d --name=netdata \ |
| 255 | --pid=host \ |
| 256 | --network=host \ |
| 257 | -v netdataconfig:/etc/netdata \ |
| 258 | -v netdatalib:/var/lib/netdata \ |
| 259 | -v netdatacache:/var/cache/netdata \ |
| 260 | -v /:/host/root:ro,rslave \ |
| 261 | -v /etc/passwd:/host/etc/passwd:ro \ |
| 262 | -v /etc/group:/host/etc/group:ro \ |
| 263 | -v /etc/localtime:/etc/localtime:ro \ |
| 264 | -v /proc:/host/proc:ro \ |
| 265 | -v /sys:/host/sys:ro \ |
| 266 | -v /etc/os-release:/host/etc/os-release:ro \ |
| 267 | -v /var/log:/host/var/log:ro \ |
| 268 | -v /var/run/docker.sock:/var/run/docker.sock:ro \ |
| 269 | -v /run/dbus:/run/dbus:ro \ |
| 270 | --restart unless-stopped \ |
| 271 | --cap-add SYS_PTRACE \ |
| 272 | --cap-add SYS_ADMIN \ |
| 273 | --security-opt apparmor=unconfined \ |
| 274 | {% if $showClaimingOptions %} |
| 275 | -e NETDATA_CLAIM_TOKEN={% claim_token %} \ |
| 276 | -e NETDATA_CLAIM_URL={% claim_url %} \ |
| 277 | -e NETDATA_CLAIM_ROOMS={% $claim_rooms %} \ |
| 278 | {% /if %} |
| 279 | netdata/netdata:stable |
| 280 | - method: Docker Compose |
| 281 | commands: |
| 282 | - channel: nightly |
| 283 | command: | |
| 284 | version: '3' |
| 285 | services: |
| 286 | netdata: |
| 287 | image: netdata/netdata:edge |
| 288 | container_name: netdata |
| 289 | pid: host |
| 290 | network_mode: host |
| 291 | restart: unless-stopped |
| 292 | cap_add: |
| 293 | - SYS_PTRACE |
| 294 | - SYS_ADMIN |
| 295 | security_opt: |
| 296 | - apparmor:unconfined |
| 297 | volumes: |
| 298 | - netdataconfig:/etc/netdata |
| 299 | - netdatalib:/var/lib/netdata |
| 300 | - netdatacache:/var/cache/netdata |
| 301 | - /:/host/root:ro,rslave |
| 302 | - /etc/passwd:/host/etc/passwd:ro |
| 303 | - /etc/group:/host/etc/group:ro |
| 304 | - /etc/localtime:/etc/localtime:ro |
| 305 | - /proc:/host/proc:ro |
| 306 | - /sys:/host/sys:ro |
| 307 | - /etc/os-release:/host/etc/os-release:ro |
| 308 | - /var/log:/host/var/log:ro |
| 309 | - /var/run/docker.sock:/var/run/docker.sock:ro |
| 310 | - /run/dbus:/run/dbus:ro |
| 311 | {% if $showClaimingOptions %} |
| 312 | environment: |
| 313 | - NETDATA_CLAIM_TOKEN={% claim_token %} |
| 314 | - NETDATA_CLAIM_URL={% claim_url %} |
| 315 | - NETDATA_CLAIM_ROOMS={% $claim_rooms %} |
| 316 | {% /if %} |
| 317 | volumes: |
| 318 | netdataconfig: |
| 319 | netdatalib: |
| 320 | netdatacache: |
| 321 | - channel: stable |
| 322 | command: | |
| 323 | version: '3' |
| 324 | services: |
| 325 | netdata: |
| 326 | image: netdata/netdata:stable |
| 327 | container_name: netdata |
| 328 | pid: host |
| 329 | network_mode: host |
| 330 | restart: unless-stopped |
| 331 | cap_add: |
| 332 | - SYS_PTRACE |
| 333 | - SYS_ADMIN |
| 334 | security_opt: |
| 335 | - apparmor:unconfined |
| 336 | volumes: |
| 337 | - netdataconfig:/etc/netdata |
| 338 | - netdatalib:/var/lib/netdata |
| 339 | - netdatacache:/var/cache/netdata |
| 340 | - /:/host/root:ro,rslave |
| 341 | - /etc/passwd:/host/etc/passwd:ro |
| 342 | - /etc/group:/host/etc/group:ro |
| 343 | - /etc/localtime:/etc/localtime:ro |
| 344 | - /proc:/host/proc:ro |
| 345 | - /sys:/host/sys:ro |
| 346 | - /etc/os-release:/host/etc/os-release:ro |
| 347 | - /var/log:/host/var/log:ro |
| 348 | - /var/run/docker.sock:/var/run/docker.sock:ro |
| 349 | - /run/dbus:/run/dbus:ro |
| 350 | {% if $showClaimingOptions %} |
| 351 | environment: |
| 352 | - NETDATA_CLAIM_TOKEN={% claim_token %} |
| 353 | - NETDATA_CLAIM_URL={% claim_url %} |
| 354 | - NETDATA_CLAIM_ROOMS={% $claim_rooms %} |
| 355 | {% /if %} |
| 356 | volumes: |
| 357 | netdataconfig: |
| 358 | netdatalib: |
| 359 | netdatacache: |
| 360 | - method: Docker Swarm |
| 361 | commands: |
| 362 | - channel: nightly |
| 363 | command: | |
| 364 | version: '3' |
| 365 | services: |
| 366 | netdata: |
| 367 | image: netdata/netdata:edge |
| 368 | pid: host |
| 369 | network_mode: host |
| 370 | cap_add: |
| 371 | - SYS_PTRACE |
| 372 | - SYS_ADMIN |
| 373 | security_opt: |
| 374 | - apparmor:unconfined |
| 375 | volumes: |
| 376 | - netdataconfig:/etc/netdata |
| 377 | - netdatalib:/var/lib/netdata |
| 378 | - netdatacache:/var/cache/netdata |
| 379 | - /:/host/root:ro,rslave |
| 380 | - /etc/passwd:/host/etc/passwd:ro |
| 381 | - /etc/group:/host/etc/group:ro |
| 382 | - /etc/localtime:/etc/localtime:ro |
| 383 | - /proc:/host/proc:ro |
| 384 | - /sys:/host/sys:ro |
| 385 | - /etc/os-release:/host/etc/os-release:ro |
| 386 | - /etc/hostname:/etc/hostname:ro |
| 387 | - /var/log:/host/var/log:ro |
| 388 | - /var/run/docker.sock:/var/run/docker.sock:ro |
| 389 | - /run/dbus:/run/dbus:ro |
| 390 | {% if $showClaimingOptions %} |
| 391 | environment: |
| 392 | - NETDATA_CLAIM_TOKEN={% claim_token %} |
| 393 | - NETDATA_CLAIM_URL={% claim_url %} |
| 394 | - NETDATA_CLAIM_ROOMS={% $claim_rooms %} |
| 395 | {% /if %} |
| 396 | deploy: |
| 397 | mode: global |
| 398 | restart_policy: |
| 399 | condition: on-failure |
| 400 | volumes: |
| 401 | netdataconfig: |
| 402 | netdatalib: |
| 403 | netdatacache: |
| 404 | - channel: stable |
| 405 | command: | |
| 406 | version: '3' |
| 407 | services: |
| 408 | netdata: |
| 409 | image: netdata/netdata:stable |
| 410 | pid: host |
| 411 | network_mode: host |
| 412 | cap_add: |
| 413 | - SYS_PTRACE |
| 414 | - SYS_ADMIN |
| 415 | security_opt: |
| 416 | - apparmor:unconfined |
| 417 | volumes: |
| 418 | - netdataconfig:/etc/netdata |
| 419 | - netdatalib:/var/lib/netdata |
| 420 | - netdatacache:/var/cache/netdata |
| 421 | - /:/host/root:ro,rslave |
| 422 | - /etc/passwd:/host/etc/passwd:ro |
| 423 | - /etc/group:/host/etc/group:ro |
| 424 | - /etc/localtime:/etc/localtime:ro |
| 425 | - /proc:/host/proc:ro |
| 426 | - /sys:/host/sys:ro |
| 427 | - /etc/os-release:/host/etc/os-release:ro |
| 428 | - /etc/hostname:/etc/hostname:ro |
| 429 | - /var/log:/host/var/log:ro |
| 430 | - /var/run/docker.sock:/var/run/docker.sock:ro |
| 431 | - /run/dbus:/run/dbus:ro |
| 432 | {% if $showClaimingOptions %} |
| 433 | environment: |
| 434 | - NETDATA_CLAIM_TOKEN={% claim_token %} |
| 435 | - NETDATA_CLAIM_URL={% claim_url %} |
| 436 | - NETDATA_CLAIM_ROOMS={% $claim_rooms %} |
| 437 | {% /if %} |
| 438 | deploy: |
| 439 | mode: global |
| 440 | restart_policy: |
| 441 | condition: on-failure |
| 442 | volumes: |
| 443 | netdataconfig: |
| 444 | netdatalib: |
| 445 | netdatacache: |
| 446 | additional_info: "" |
| 447 | related_resources: {} |
| 448 | platform_info: |
| 449 | group: "no_include" |
| 450 | distro: "docker" |
| 451 | quick_start: 3 |
| 452 | - id: deploy-kubernetes |
| 453 | meta: |
| 454 | name: Kubernetes (Helm) |
| 455 | link: "" |
| 456 | categories: |
| 457 | - deploy.docker-kubernetes |
| 458 | icon_filename: "kubernetes.svg" |
| 459 | keywords: |
| 460 | - kubernetes |
| 461 | - container |
| 462 | - Orchestrator |
| 463 | install_description: | |
| 464 | **Use helm install to install Netdata on your Kubernetes cluster** |
| 465 | For a new installation use `helm install` or for existing clusters add the content below to your `override.yaml` and then run `helm upgrade -f override.yml netdata netdata/netdata` |
| 466 | |
| 467 | methods: |
| 468 | - method: Helm |
| 469 | commands: |
| 470 | - channel: nightly |
| 471 | command: | |
| 472 | helm repo add netdata https://netdata.github.io/helmchart/ && helm repo update |
| 473 | helm install netdata netdata/netdata \ |
| 474 | --set image.tag=edge{% if $showClaimingOptions %} \ |
| 475 | --set parent.claiming.enabled="true" \ |
| 476 | --set parent.claiming.token={% claim_token %} \ |
| 477 | --set parent.claiming.rooms={% $claim_rooms %} \ |
| 478 | --set child.claiming.enabled="true" \ |
| 479 | --set child.claiming.token={% claim_token %} \ |
| 480 | --set child.claiming.rooms={% $claim_rooms %}{% /if %} |
| 481 | - channel: stable |
| 482 | command: | |
| 483 | helm repo add netdata https://netdata.github.io/helmchart/ && helm repo update |
| 484 | helm install netdata netdata/netdata \ |
| 485 | --set image.tag=stable{% if $showClaimingOptions %} \ |
| 486 | --set parent.claiming.enabled="true" \ |
| 487 | --set parent.claiming.token={% claim_token %} \ |
| 488 | --set parent.claiming.rooms={% $claim_rooms %} \ |
| 489 | --set child.claiming.enabled="true" \ |
| 490 | --set child.claiming.token={% claim_token %} \ |
| 491 | --set child.claiming.rooms={% $claim_rooms %}{% /if %} |
| 492 | - method: Existing Cluster |
| 493 | commands: |
| 494 | - channel: nightly |
| 495 | command: | |
| 496 | image: |
| 497 | tag: edge |
| 498 | |
| 499 | restarter: |
| 500 | enabled: true |
| 501 | {% if $showClaimingOptions %} |
| 502 | |
| 503 | parent: |
| 504 | claiming: |
| 505 | enabled: true |
| 506 | token: {% claim_token %} |
| 507 | rooms: {% $claim_rooms %} |
| 508 | |
| 509 | child: |
| 510 | claiming: |
| 511 | enabled: true |
| 512 | token: {% claim_token %} |
| 513 | rooms: {% $claim_rooms %} |
| 514 | {% /if %} |
| 515 | - channel: stable |
| 516 | command: | |
| 517 | image: |
| 518 | tag: stable |
| 519 | |
| 520 | restarter: |
| 521 | enabled: true |
| 522 | {% if $showClaimingOptions %} |
| 523 | |
| 524 | parent: |
| 525 | claiming: |
| 526 | enabled: true |
| 527 | token: {% claim_token %} |
| 528 | rooms: {% $claim_rooms %} |
| 529 | |
| 530 | child: |
| 531 | claiming: |
| 532 | enabled: true |
| 533 | token: {% claim_token %} |
| 534 | rooms: {% $claim_rooms %} |
| 535 | {% /if %} |
| 536 | additional_info: "" |
| 537 | related_resources: {} |
| 538 | platform_info: |
| 539 | group: "" |
| 540 | distro: "" |
| 541 | quick_start: 4 |
| 542 | - id: deploy-windows |
| 543 | meta: |
| 544 | name: Windows |
| 545 | link: "https://www.microsoft.com/en-us/windows" |
| 546 | categories: |
| 547 | - deploy.operating-systems |
| 548 | icon_filename: "windows.svg" |
| 549 | keywords: |
| 550 | - windows |
| 551 | install_description: | |
| 552 | Netdata offers a convenient Windows installer for easy setup. This executable provides two distinct installation modes, outlined below. |
| 553 | |
| 554 | ## Graphical User Interface (GUI) |
| 555 | |
| 556 | **Download the MSI Installer**: |
| 557 | - [Stable version](https://github.com/netdata/netdata/releases/latest/download/netdata-x64.msi) |
| 558 | - [Nightly version](https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-x64.msi) |
| 559 | |
| 560 | Double-click the installer to start the installation process. As Netdata adds a service to your system, you'll need to provide administrator privileges. |
| 561 | |
| 562 | Once installed, you can access your Netdata dashboard at `localhost:19999`. |
| 563 | |
| 564 | ## Silent Mode (Command line) |
| 565 | |
| 566 | If you prefer to install Netdata through the command line, you can do so by running the following command on Windows Powershell with administrator rights. |
| 567 | methods: |
| 568 | - method: Silent Mode (Command line) |
| 569 | commands: |
| 570 | - channel: stable |
| 571 | command: > |
| 572 | $ProgressPreference = 'SilentlyContinue'; |
| 573 | Invoke-WebRequest https://github.com/netdata/netdata/releases/latest/download/netdata-x64.msi -OutFile "netdata-x64.msi"; |
| 574 | msiexec /qn /i netdata-x64.msi {% if $showClaimingOptions %}TOKEN={% claim_token %} ROOMS={% $claim_rooms %}{% /if %} |
| 575 | - channel: nightly |
| 576 | command: > |
| 577 | $ProgressPreference = 'SilentlyContinue'; |
| 578 | Invoke-WebRequest https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-x64.msi -OutFile "netdata-x64.msi"; |
| 579 | msiexec /qn /i netdata-x64.msi {% if $showClaimingOptions %}TOKEN={% claim_token %} ROOMS={% $claim_rooms %}{% /if %} |
| 580 | additional_info: | |
| 581 | ### Available CLI Options |
| 582 | |
| 583 | | Option | Description | |
| 584 | |--------------|--------------------------------------------------------------------------------------------------| |
| 585 | | `/qn` | Enables silent mode installation. | |
| 586 | | `/i` | Specifies the path to the MSI installer file. | |
| 587 | | `INSECURE=1` | Forces insecure connections, bypassing hostname verification (use only if absolutely necessary). | |
| 588 | | `TOKEN=` | Sets the Claim Token for your Netdata Cloud Space. | |
| 589 | | `ROOMS=` | Comma-separated list of Room IDs where you want your node to appear. | |
| 590 | | `PROXY=` | Sets the proxy server address if your network requires one. | |
| 591 | related_resources: {} |
| 592 | platform_info: |
| 593 | group: "" |
| 594 | distro: "" |
| 595 | quick_start: 2 |
| 596 | - id: deploy-freebsd |
| 597 | meta: |
| 598 | name: FreeBSD |
| 599 | link: "https://www.freebsd.org/" |
| 600 | categories: |
| 601 | - deploy.operating-systems |
| 602 | icon_filename: "freebsd.svg" |
| 603 | keywords: |
| 604 | - freebsd |
| 605 | install_description: | |
| 606 | ## Install dependencies |
| 607 | Please install the following packages using the command below: |
| 608 | |
| 609 | ```pkg install bash e2fsprogs-libuuid git curl autoconf automake pkgconf pidof liblz4 libuv json-c cmake gmake``` |
| 610 | This step needs root privileges. Please respond in the affirmative for any relevant prompts during the installation process. |
| 611 | |
| 612 | Run the following command on your node to install and claim Netdata: |
| 613 | methods: |
| 614 | - *ks_curl |
| 615 | - method: fetch |
| 616 | commands: |
| 617 | - channel: nightly |
| 618 | command: > |
| 619 | fetch -o /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --nightly-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %} |
| 620 | - channel: stable |
| 621 | command: > |
| 622 | fetch -o /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --stable-channel{% if $showClaimingOptions %} --claim-token {% claim_token %} --claim-rooms {% $claim_rooms %} --claim-url {% claim_url %}{% /if %} |
| 623 | additional_info: | |
| 624 | Netdata can also be installed via [FreeBSD ports](https://www.freshports.org/net-mgmt/netdata). |
| 625 | related_resources: {} |
| 626 | platform_info: |
| 627 | group: "no_include" |
| 628 | distro: "freebsd" |
| 629 | quick_start: 6 |