Skip to content

Commit 710c977

Browse files
Update UDM Pro docs to be UniFi router agnostic (#30)
* Update UDM Pro docs to be UniFi Router agnostic * Update navigation * Make Router plural
1 parent aa34ac5 commit 710c977

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

docs/setup-sensor/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ The best sensor device for you depends on your specific needs:
3232
- [Podman](/docs/setup-sensor/podman.md)
3333
- [Home Assistant](/docs/setup-sensor/home-assistant.md)
3434
- [Proxmox](/docs/setup-sensor/proxmox.md)
35+
- [UniFi Routers](/docs/setup-sensor/unifi-routers.md)
3536
- [MikroTik](/docs/setup-sensor/mikrotik.md)
3637
- [Firewalla](/docs/setup-sensor/firewalla.md)
3738
- [Synology NAS](/docs/setup-sensor/synology.md)
3839
- [QNAP NAS](/docs/setup-sensor/qnap.md)
39-
- [Unifi Dream Machine Pro](/docs/setup-sensor/udm-pro.md)
4040
- [Steam Deck](/docs/setup-sensor/steam-deck.md)
4141
- [GL.iNet Brume 2](/docs/setup-sensor/gl-mt2500-standalone.md)
4242
- [Spare iPhone](/docs/setup-sensor/spare-iphone.md)

docs/setup-sensor/udm-pro.md renamed to docs/setup-sensor/unifi-routers.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
---
2-
title: Install Orb on Unifi Dream Machine Pro
3-
shortTitle: Unifi Dream Machine Pro
4-
metaDescription: Install the Orb sensor on your Unifi Dream Machine Pro
2+
title: Install Orb on UniFi Routers
3+
shortTitle: UniFi Routers
4+
metaDescription: Install the Orb sensor on your UniFi Routers including the Dream Machine and Dream Router.
55
section: setup-sensor
66
layout: guides
77
subtitle: 'Difficulty: Intermediate 🧑‍🔬'
88
---
99

10-
# Install Orb on Unifi Dream Machine Pro with UniFi OS >= 4.2.0
10+
# Install Orb on UniFi Routers with UniFi OS >= 4.2.0
1111

1212
## Introduction
1313

14-
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.
14+
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.
1515

16-
**NOTE: This may work on other UniFi OS routers, but is currently untested.**
16+
**NOTE: These instructions have been tested on the Dream Machine Pro, but should work on other UniFi OS routers as well.**
1717

1818
## Step 1: Enable SSH
1919

20-
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.
20+
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.
2121

22-
1. Browse to your UDM control interface
22+
1. Browse to your UniFi Router control interface.
2323
2. Go to Settings -> Control Plane -> Console.
2424
3. Enable the SSH option and click 'Confirm'.
2525
4. Optional: Generate a new password if you have lost it.
2626

2727
## Step 2: Install Orb
2828

29-
You can now login to your UDM device over ssh, so we can install the Orb sensor:
29+
You can now login to your UniFi Router over ssh, so we can install the Orb sensor:
3030

31-
1. Open your terminal and type `ssh root@[udm-ip]`. It will ask for the password.
31+
1. Open your terminal and type `ssh root@[router-ip]`. It will ask for the password.
3232

3333
2. Create Orb install script:
3434

navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@
2525
- [Podman](/docs/setup-sensor/podman.md)
2626
- [Home Assistant](/docs/setup-sensor/home-assistant.md)
2727
- [Proxmox](/docs/setup-sensor/proxmox.md)
28+
- [UniFi Routers](/docs/setup-sensor/unifi-routers.md)
2829
- [MikroTik](/docs/setup-sensor/mikrotik.md)
2930
- [Firewalla](/docs/setup-sensor/firewalla.md)
3031
- [Synology NAS](/docs/setup-sensor/synology.md)
3132
- [QNAP NAS](/docs/setup-sensor/qnap.md)
32-
- [Unifi Dream Machine Pro](/docs/setup-sensor/udm-pro.md)
3333
- [Steam Deck](/docs/setup-sensor/steam-deck.md)
3434
- [GL.iNet Brume 2](/docs/setup-sensor/gl-mt2500-standalone.md)
3535
- [Spare iPhone](/docs/setup-sensor/spare-iphone.md)

0 commit comments

Comments
 (0)