diff --git a/docs/setup-sensor/README.md b/docs/setup-sensor/README.md index d6a2134..f2e5e45 100644 --- a/docs/setup-sensor/README.md +++ b/docs/setup-sensor/README.md @@ -32,11 +32,11 @@ The best sensor device for you depends on your specific needs: - [Podman](/docs/setup-sensor/podman.md) - [Home Assistant](/docs/setup-sensor/home-assistant.md) - [Proxmox](/docs/setup-sensor/proxmox.md) +- [UniFi Routers](/docs/setup-sensor/unifi-routers.md) - [MikroTik](/docs/setup-sensor/mikrotik.md) - [Firewalla](/docs/setup-sensor/firewalla.md) - [Synology NAS](/docs/setup-sensor/synology.md) - [QNAP NAS](/docs/setup-sensor/qnap.md) -- [Unifi Dream Machine Pro](/docs/setup-sensor/udm-pro.md) - [Steam Deck](/docs/setup-sensor/steam-deck.md) - [GL.iNet Brume 2](/docs/setup-sensor/gl-mt2500-standalone.md) - [Spare iPhone](/docs/setup-sensor/spare-iphone.md) diff --git a/docs/setup-sensor/udm-pro.md b/docs/setup-sensor/unifi-routers.md similarity index 54% rename from docs/setup-sensor/udm-pro.md rename to docs/setup-sensor/unifi-routers.md index 2fb39a8..65e27b0 100644 --- a/docs/setup-sensor/udm-pro.md +++ b/docs/setup-sensor/unifi-routers.md @@ -1,34 +1,34 @@ --- -title: Install Orb on Unifi Dream Machine Pro -shortTitle: Unifi Dream Machine Pro -metaDescription: Install the Orb sensor on your Unifi Dream Machine Pro +title: Install Orb on UniFi Routers +shortTitle: UniFi Routers +metaDescription: Install the Orb sensor on your UniFi Routers including the Dream Machine and Dream Router. section: setup-sensor layout: guides subtitle: 'Difficulty: Intermediate 🧑‍🔬' --- -# Install Orb on Unifi Dream Machine Pro with UniFi OS >= 4.2.0 +# Install Orb on UniFi Routers with UniFi OS >= 4.2.0 ## Introduction -This guide walks you through installing the Orb sensor on your Unifi Dream Machine (UDM) Pro. This will allow you to monitor your network connectivity right on your router, and access the information from anywhere within or outside the network. +This guide walks you through installing the Orb sensor on UniFi Routers, including the Dream Machine and Dream Router. This will allow you to monitor your network connectivity right on your router, and access the information from anywhere within or outside the network using the Orb app. -**NOTE: This may work on other UniFi OS routers, but is currently untested.** +**NOTE: These instructions have been tested on the Dream Machine Pro, but should work on other UniFi OS routers as well.** ## Step 1: Enable SSH -In order to install Orb on your UDM (Pro), we'll need enable SSH access. If you already have SSH access enabled, skip ahead to Step 2. +In order to install Orb on your UniFi Router, you'll need enable SSH access. If you already have SSH access enabled, skip ahead to Step 2. -1. Browse to your UDM control interface +1. Browse to your UniFi Router control interface. 2. Go to Settings -> Control Plane -> Console. 3. Enable the SSH option and click 'Confirm'. 4. Optional: Generate a new password if you have lost it. ## Step 2: Install Orb -You can now login to your UDM device over ssh, so we can install the Orb sensor: +You can now login to your UniFi Router over ssh, so we can install the Orb sensor: -1. Open your terminal and type `ssh root@[udm-ip]`. It will ask for the password. +1. Open your terminal and type `ssh root@[router-ip]`. It will ask for the password. 2. Create Orb install script: diff --git a/navigation.md b/navigation.md index 0f51997..19138e0 100644 --- a/navigation.md +++ b/navigation.md @@ -25,11 +25,11 @@ - [Podman](/docs/setup-sensor/podman.md) - [Home Assistant](/docs/setup-sensor/home-assistant.md) - [Proxmox](/docs/setup-sensor/proxmox.md) +- [UniFi Routers](/docs/setup-sensor/unifi-routers.md) - [MikroTik](/docs/setup-sensor/mikrotik.md) - [Firewalla](/docs/setup-sensor/firewalla.md) - [Synology NAS](/docs/setup-sensor/synology.md) - [QNAP NAS](/docs/setup-sensor/qnap.md) -- [Unifi Dream Machine Pro](/docs/setup-sensor/udm-pro.md) - [Steam Deck](/docs/setup-sensor/steam-deck.md) - [GL.iNet Brume 2](/docs/setup-sensor/gl-mt2500-standalone.md) - [Spare iPhone](/docs/setup-sensor/spare-iphone.md)