Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/setup-sensor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
2 changes: 1 addition & 1 deletion navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down