# Remote.It Docs ## Remote.It - [Remote.It Overview](https://docs.remote.it/introduction/readme.md): Remote.It makes secure remote connections between devices without open ports or port forwarding, crossing NATs and firewalls over SSH, VNC, RDP, HTTP/S and more. - [Get Started](https://docs.remote.it/introduction/get-started.md): Create a Remote.It account, install the Desktop app or CLI on your target device, and make your first secure connection — no port forwarding required. - [Platforms & Packages](https://docs.remote.it/introduction/get-started/platforms-and-packages.md): Compare the Remote.It Device Package, CLI and Desktop app across Linux, Raspberry Pi, Mac, Windows, OpenWrt, Synology, NVIDIA Jetson and more. - [Remote Access Over Starlink](https://docs.remote.it/introduction/get-started/starlink.md): Reach cameras, DVRs, NAS boxes and PCs behind a Starlink connection. Starlink uses CGNAT, so port forwarding can't work — Remote.It gets you in without it. - [Use Cases](https://docs.remote.it/introduction/get-started/use-cases.md): How Remote.It is used in industrial automation, cloud infrastructure, and cellular or Starlink deployments — including real bandwidth consumption figures. - [Glossary of Terms](https://docs.remote.it/introduction/glossary-of-terms.md): Definitions of core Remote.It concepts — target and initiator devices, services, the Service Agent, organizations, licensing, and connection types. - [Bluetooth Wifi Onboarding Package (r3onboard)](https://docs.remote.it/software/bluetooth-wifi-onboarding-package-r3onboard.md): Configure WiFi and register headless Raspberry Pi and Debian Bookworm devices over Bluetooth LE with r3onboard — no keyboard or monitor required. - [Device Package](https://docs.remote.it/software/device-package.md): The Device Package installs the Remote.It target agent — the smallest-footprint way to make a headless or embedded Linux device reachable for inbound connections. - [Device Package Supported Platforms](https://docs.remote.it/software/device-package/supported-platforms.md): Platforms and architectures supported by the Remote.It Device Package, including Linux distributions, Raspberry Pi, OpenWrt, and AWS cloud instances. - [Device Package Installation](https://docs.remote.it/software/device-package/installation.md): Install and register the Remote.It Device Package on Debian, Ubuntu and Linux devices with a single terminal command, then set up your first services. - [Device Package Usage](https://docs.remote.it/software/device-package/usage.md): Connect to services on a device running the Remote.It Device Package, and use connectd network diagnostics to verify the target device's connectivity. - [NPM Package](https://docs.remote.it/software/npm-package.md): Socket-Link 🔗 is the Remote.It NodeJS package for creating fast secure remote connections in your application or workflow. - [CLI](https://docs.remote.it/software/cli.md): The Remote.It CLI is a unified command line tool for configuring devices and initiating outbound connections without the Desktop application. - [CLI Supported Platforms](https://docs.remote.it/software/cli/supported-platforms.md): Platforms and architectures supported by the Remote.It CLI, including Linux, Raspberry Pi, macOS, Windows and AWS cloud instances. - [CLI Installation](https://docs.remote.it/software/cli/overview.md): Install and register the Remote.It CLI on Linux, Raspberry Pi OS, macOS and Windows using the quick install command or a manual package download. - [Docker](https://docs.remote.it/software/docker.md): Run Remote.It in Docker — the remoteit-agent image based on OpenWRT, and the Alpine-based Docker Desktop Extension that talks to the Docker daemon. - [Remote.It Agent](https://docs.remote.it/software/docker/remote.it-agent.md): Run the Remote.It Device Package inside a Docker container with the remoteit-agent image, including the settings needed for a recoverable production deployment. - [Remote.it Docker Extension](https://docs.remote.it/software/docker/remote.it-docker-extension.md): Install the Remote.It Docker Extension from Docker Desktop, or run the same image as a standalone container on a server or Raspberry Pi. - [Desktop](https://docs.remote.it/software/desktop.md): The Remote.It Desktop application installs the full ecosystem and provides a UI to configure devices, manage services and make connections. - [Desktop Installation](https://docs.remote.it/software/desktop/overview-and-installation.md): Download and install the Remote.It Desktop application for Windows, macOS and Linux to manage devices, services and connections from a single UI. - [Web Portal & Mobile](https://docs.remote.it/software/web-portal-and-mobile.md): Manage devices, view logs and run bulk scripts from the Remote.It web portal, or connect to SSH, RDP and web services from the iOS and Android apps. - [Custom Solutions](https://docs.remote.it/software/custom-solutions.md): Remote.It supports platforms beyond the standard packages — Ansible automation, side-loaded Android, Dragino LoRaWAN routers and custom builds. - [Services](https://docs.remote.it/features/services.md): A Remote.It service maps an application, port and host address on a target device so you can reach it remotely. Learn the attributes of a service. - [SSH](https://docs.remote.it/features/services/ssh.md): Connect over SSH to devices behind NAT, CGNAT or a firewall with no port forwarding — auto-launching Terminal, PuTTY or Termius from Remote.It. - [RDP and VNC](https://docs.remote.it/features/services/rdp-and-vnc.md): Set up Remote.It RDP and VNC services to reach a remote desktop across NAT using the remote desktop clients you already use. - [SMB and CIFS](https://docs.remote.it/features/services/smb-and-cifs.md): Reach SMB and CIFS network file shares remotely as if you were on the same LAN, by adding a Remote.It service to the device hosting the shared folders. - [HTTP/S](https://docs.remote.it/features/services/http-s.md): Host a private website or API behind NAT and reach it through a Remote.It HTTP/S service pointed at the port your web server is listening on. - [Database](https://docs.remote.it/features/services/database.md): Query remote databases securely over Remote.It — Microsoft SQL on port 1433 by default, or any database reachable on a TCP port via the service host address. - [Redis](https://docs.remote.it/features/services/redis.md): Connect to a remote Redis instance on port 6379 through Remote.It, or any other cache service listening on a TCP port. - [UDP](https://docs.remote.it/features/services/udp.md): Create a Remote.It UDP service on any port you need. There is no default service port for UDP — you specify the one your application listens on. - [VPN](https://docs.remote.it/features/services/vpn.md): Register one or more VPN services on a device to reach multiple VPNs through Remote.It without constantly reconnecting and disconnecting. - [Connection Options](https://docs.remote.it/features/connection-options.md): Ways to route a Remote.It connection — peer-to-peer, proxy, LAN sharing, and jump services that reach devices where Remote.It isn't installed. - [LAN Sharing](https://docs.remote.it/features/connection-options/lan-sharing.md): Share a Remote.It peer-to-peer connection with others on your local network, scoped to a single LAN address or a range of IPs. - [Jump Service](https://docs.remote.it/features/connection-options/jump-service.md): Use one device as a jump box to reach TCP services on other devices on the same LAN — printers, appliances or an AWS VPC — without installing Remote.It on each. - [Peer-2-Peer & Proxy](https://docs.remote.it/features/connection-options/peer-2-peer-and-proxy.md): How Remote.It peer-to-peer and proxy connections differ, and when each routing method is used. - [Logging](https://docs.remote.it/features/logging.md): Event logging in Remote.It — audit device, service and connection activity across your account. - [Organizations](https://docs.remote.it/features/organizations.md): Create a Remote.It organization to share devices with your team, manage seat licenses and member roles, and integrate SAML single sign-on. - [Authentication](https://docs.remote.it/developer-tools/authentication.md): Authenticate to the Remote.It GraphQL API using HTTP Request Signature with non-expiring access keys you can revoke at any time. - [API](https://docs.remote.it/developer-tools/api.md): Use Remote.It APIs to manage devices, services, connections and event logs in code, with GraphQL coverage supplemented by the legacy REST API. - [Using Developer Tools](https://docs.remote.it/developer-tools/api/using-developer-tools.md): There are multiple developer tool IDEs such as Insomnia, Postman, and Altair. Here are examples using Insomnia and Postman. - [API Usage](https://docs.remote.it/developer-tools/api/usage.md): Get started with the Remote.It GraphQL API — endpoint, authentication, the Insomnia sample collection, and how GraphQL replaces the legacy REST API. - [Devices and Services](https://docs.remote.it/developer-tools/api/usage/devices-and-services.md): GraphQL queries and mutations for listing, creating and updating Remote.It devices and services, plus the supported application types. - [Event Logs](https://docs.remote.it/developer-tools/api/usage/event-logs.md): Query Remote.It event logs through the GraphQL API — event types, attributes, and the users and devices each event affects. - [Connections](https://docs.remote.it/developer-tools/api/usage/usage-examples.md): Create on-demand, proxy and reverse proxy connections through the Remote.It GraphQL API, including peer-to-peer with proxy failover. - [Access Keys](https://docs.remote.it/developer-tools/api/usage/access-keys.md): Create, disable and delete the access keys that authenticate you to the Remote.It API. Secret keys cannot be retrieved once lost. - [Device Sharing](https://docs.remote.it/developer-tools/api/usage/device-sharing.md): Share and unshare Remote.It devices and individual services with other users through the GraphQL API, with optional scripting permission. - [Custom Attributes](https://docs.remote.it/developer-tools/api/usage/custom-attributes.md): Attach your own metadata to Remote.It users, devices and services with custom attributes, including per-context value overrides. - [Scripting](https://docs.remote.it/developer-tools/api/usage/scripting.md): Upload script files and execute them against your Remote.It devices through the GraphQL API, including passing arguments and checking job status. - [CLI Usage](https://docs.remote.it/developer-tools/cli-usage.md): Remote.It CLI command reference — register devices, add and manage services, start connections and check status from the command line. - [Webhooks](https://docs.remote.it/developer-tools/webhooks.md): Receive HTTP push notifications when your devices go online or offline, and build integrations on top of Remote.It webhooks. - [Slack Integration](https://docs.remote.it/developer-tools/webhooks/slack-integration.md): Send Remote.It device online and offline notifications to a Slack channel by creating a Slack app with an incoming webhook. - [Docker Video Walkthroughs](https://docs.remote.it/developer-tools/docker.md): Video walkthroughs of the Remote.It Docker Desktop Extension, including running it as a standalone container on an ECS cluster. - [Device Scripting](https://docs.remote.it/developer-tools/device-scripting.md): Run unattended scripts across any number of Linux or Windows devices with the Remote.It GraphQL API — in bash, Python, Ruby, Node or any installed language. - [Zero-Trust AWS Access](https://docs.remote.it/developer-tools/zero-trust-aws-access.md): Use an EC2 instance as a jump server to reach databases, Kubernetes and other VPC services with zero inbound security group rules and no open ports. - [AWS RDS (Postgres and MySQL)](https://docs.remote.it/developer-tools/zero-trust-aws-access/aws-rds-postgres-and-mysql.md): Reach an AWS RDS Postgres or MySQL instance through an EC2 bastion host with Remote.It — no public accessibility required. - [Zero Trust Azure Cloud Access](https://docs.remote.it/developer-tools/zero-trust-azure-cloud-access.md): Use an Azure Virtual Machine as a jump server to reach databases, Kubernetes and other VNet services with no inbound rules and no open ports. - [Zero Trust Google Cloud Access](https://docs.remote.it/developer-tools/zero-trust-google-cloud-access.md): Use a Google Compute Engine instance as a jump server to reach databases, Kubernetes and other VPC services with no inbound rules and no open ports. - [MCP Server Overview](https://docs.remote.it/mcp-server/mcp.md): The hosted Remote.It MCP server lets AI assistants like Claude inventory devices, open connections, manage services and run scripts on your fleet. - [Connect Claude](https://docs.remote.it/mcp-server/connect-claude.md): Add Remote.It as a connector in Claude so it can inventory and manage your devices in conversation, using OAuth sign-in with no API keys. - [Tool Reference](https://docs.remote.it/mcp-server/tools.md): Every tool the Remote.It MCP server exposes to your AI assistant — devices, connections, services, networks and scripting — and which ones need approval. - [Permissions & Safety](https://docs.remote.it/mcp-server/permissions-and-safety.md): How the Remote.It MCP server protects your infrastructure — OAuth 2.1 scopes, your existing account permissions, and confirmation gates on risky operations. - [OEM & Bulk Provisioning Overview](https://docs.remote.it/oem-and-bulk-provisioning/overview.md): Bulk registration methods for OEMs shipping devices at scale — register into your own account with pre-configured services, or into an end user's account. - [Auto Registration into Your Account](https://docs.remote.it/oem-and-bulk-provisioning/auto-registration-into-your-account.md): Two ways to register manufactured devices into your own Remote.It account — a production image written at manufacturing time, or a per-device field command. - [Create a Product](https://docs.remote.it/oem-and-bulk-provisioning/auto-registration-into-your-account/create-a-product.md): Define a Remote.It product — the reusable service template (HTTPS, HTTP, SSH, RDP and more) applied to every device you bulk register. - [Production Image](https://docs.remote.it/oem-and-bulk-provisioning/auto-registration-into-your-account/registration-with-pre-configured-services.md): Build a single production OS image that auto-registers every device it is flashed to, with services pre-configured at manufacturing time. - [Field Production](https://docs.remote.it/oem-and-bulk-provisioning/auto-registration-into-your-account/field-production.md): The simplest bulk registration method — run a one-line command on each device to install Remote.It with a custom name and pre-defined services. - [Registration into a User's Account](https://docs.remote.it/oem-and-bulk-provisioning/registration-into-a-users-account.md): Ship devices that register themselves into your customer's Remote.It account on first boot, using a license key written to the device registration file. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.remote.it/introduction/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.