# Orb Documentation

Installation guides, tutorials, and reference material for Orb apps, sensors, and Orb Cloud.

Each link below opens the Markdown version of a documentation page.

## Search

Search the documentation with `GET https://orb.net/api/docs/search?q=YOUR_QUERY&limit=5`. URL-encode the query (1–200 characters). The optional limit is 1–20 and defaults to 8. The JSON response contains `query`, `total` (matching sections), and `results`. Each result includes `title`, `heading`, `section`, `excerpt`, `url` (HTML with a heading anchor), and `markdownUrl` (the full Markdown article). For example: https://orb.net/api/docs/search?q=install%20macos&limit=5

## [Getting started](https://orb.net/docs/getting-started.md)

- [Orb Quickstart](https://orb.net/docs/getting-started/orb-quickstart.md)
- [What is Orb?](https://orb.net/docs/getting-started/what-is-orb.md)
- [Intro to the Orb app](https://orb.net/docs/getting-started/intro-to-the-orb-app.md)

## [Install Orb apps](https://orb.net/docs/install-orb.md)

- [macOS](https://orb.net/docs/install-orb/macos.md)
- [Windows](https://orb.net/docs/install-orb/windows.md)
- [iOS](https://orb.net/docs/install-orb/ios.md)
- [Android](https://orb.net/docs/install-orb/android.md)
- [Updating Orb](https://orb.net/docs/install-orb/updating-orb.md)
- [Uninstall Orb](https://orb.net/docs/install-orb/uninstall-orb.md)

## [Set up an Orb sensor](https://orb.net/docs/setup-sensor.md)

- [Windows](https://orb.net/docs/setup-sensor/windows.md)
- [macOS](https://orb.net/docs/setup-sensor/macos.md)
- [Linux](https://orb.net/docs/setup-sensor/linux.md)
- [FreeBSD](https://orb.net/docs/setup-sensor/freebsd.md)
- [Raspberry Pi](https://orb.net/docs/setup-sensor/raspberry-pi.md)
- [OpenWrt](https://orb.net/docs/setup-sensor/linux/openwrt.md)
- [Docker](https://orb.net/docs/setup-sensor/docker.md)
- [Docker Multi-WAN](https://orb.net/docs/setup-sensor/docker-multiple-interfaces.md)
- [Interface Binding](https://orb.net/docs/setup-sensor/interface-binding.md)
- [Podman](https://orb.net/docs/setup-sensor/podman.md)
- [Home Assistant](https://orb.net/docs/setup-sensor/home-assistant.md)
- [Proxmox](https://orb.net/docs/setup-sensor/proxmox.md)
- [UniFi Routers](https://orb.net/docs/setup-sensor/unifi-routers.md)
- [MikroTik](https://orb.net/docs/setup-sensor/mikrotik.md)
- [Cisco IOx](https://orb.net/docs/setup-sensor/cisco.md)
- [Firewalla](https://orb.net/docs/setup-sensor/firewalla.md)
- [Synology NAS](https://orb.net/docs/setup-sensor/synology.md)
- [QNAP NAS](https://orb.net/docs/setup-sensor/qnap.md)
- [Steam Deck](https://orb.net/docs/setup-sensor/steam-deck.md)
- [GL.iNet Brume 2](https://orb.net/docs/setup-sensor/gl-mt2500-standalone.md)
- [Spare iPhone](https://orb.net/docs/setup-sensor/spare-iphone.md)
- [Spare Android](https://orb.net/docs/setup-sensor/spare-android.md)
- [WLAN Pi](https://orb.net/docs/setup-sensor/wlan-pi.md)

## [Using Orb apps](https://orb.net/docs/orb-app.md)

- [The Orb app at a glance](https://orb.net/docs/orb-app/orb-app-at-a-glance.md)
- [Orb summary view](https://orb.net/docs/orb-app/orb-summary-view.md)
- [Orb detail view](https://orb.net/docs/orb-app/orb-detail-view.md)
- [Orb scores & metrics](https://orb.net/docs/orb-app/orb-scores-metrics.md)
- [Responsiveness](https://orb.net/docs/orb-app/responsiveness.md)
- [Reliability](https://orb.net/docs/orb-app/reliability.md)
- [Speed](https://orb.net/docs/orb-app/speed.md)
- [Creating an account](https://orb.net/docs/orb-app/creating-an-account.md)
- [Linking an Orb to your account](https://orb.net/docs/orb-app/linking-orb-to-account.md)
- [Deleting an Orb account](https://orb.net/docs/orb-app/deleting-orb-account.md)
- [Notifications](https://orb.net/docs/orb-app/notifications.md)
- [App Settings](https://orb.net/docs/orb-app/app-settings.md)
- [Orb Settings](https://orb.net/docs/orb-app/orb-settings.md)

## [Using Orb Cloud](https://orb.net/docs/orb-cloud.md)

- [Status](https://orb.net/docs/orb-cloud/status.md)
- [Events and Alerts](https://orb.net/docs/orb-cloud/events-alerts.md)
- [Analytics](https://orb.net/docs/orb-cloud/analytics.md)
- [Manage Users](https://orb.net/docs/orb-cloud/manage-users.md)
- [Subspace Management](https://orb.net/docs/orb-cloud/subspace-management.md)

## [Deploy & Configure](https://orb.net/docs/deploy-and-configure.md)

- [Configuration](https://orb.net/docs/deploy-and-configure/configuration.md)
- [Datasets configuration](https://orb.net/docs/deploy-and-configure/datasets-configuration.md)
- [Datasets](https://orb.net/docs/deploy-and-configure/datasets.md)
- [Local Analytics](https://orb.net/docs/deploy-and-configure/local-analytics.md)
- [Deployment Tokens](https://orb.net/docs/deploy-and-configure/deployment-tokens.md)
- [MDM](https://orb.net/docs/deploy-and-configure/mdm.md)
- [Guest Orbs](https://orb.net/docs/deploy-and-configure/guest-orbs.md)
- [Endpoints & Engines](https://orb.net/docs/deploy-and-configure/endpoints.md)
- [Orb LAN Tester](https://orb.net/docs/deploy-and-configure/orb-lan-tester.md)

## [Integrations](https://orb.net/docs/integrations.md)

- [Hamina Live](https://orb.net/docs/integrations/hamina.md)
- [API](https://orb.net/docs/integrations/api.md)
- [MCP](https://orb.net/docs/integrations/mcp.md)
- [Claude](https://orb.net/docs/integrations/claude-mcp.md)
- [ChatGPT Desktop & Codex](https://orb.net/docs/integrations/codex.md)
- [ChatGPT Web](https://orb.net/docs/integrations/chatgpt-web.md)
- [Copilot Studio](https://orb.net/docs/integrations/copilot.md)
- [OpenCode](https://orb.net/docs/integrations/opencode.md)
- [Microsoft Teams](https://orb.net/docs/integrations/microsoft-teams.md)
- [Elgato Stream Deck](https://orb.net/docs/integrations/stream-deck.md)

## [Sensorbox](https://orb.net/docs/sensorbox.md)

- [Radxa E20C](https://orb.net/docs/sensorbox/radxa-e20c.md)
- [NanoPi Zero2](https://orb.net/docs/sensorbox/nanopi-zero2.md)