Ctrlk
HomeSupportCommunity
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Device Package Installation

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.

New Installation

This guide will step you through the set up of remote.it on Debian, Ubuntu and Linux devices using the command line/terminal and an installation package on a device which remoteit has not been previously installed.

Prerequisites:

  1. You have a remote.it account (If not, please go ahead and create an account at https://app.remote.it)

  2. You are on https://app.remote.it OR have installed the remote.it Desktop application on a machine you will be using to configure and connect to your device. (This doesn't need to be on the same network as the device you are setting up) See https://remote.it/download/ for the different options available.

  3. SSH access to the device you want to install remote.it and connect to

Quick Install

This quick install allows you to just paste a single command into the terminal of the target device. You must have the Desktop App or access to https://app.remote.it installed and a remote.it account created before proceeding.

1. Open the remote.it Desktop App or https://app.remote.it

If using the desktop app, it must be version 3.5.2 or greater.

2. Click add device and select your system

The Add Device screen in the Remote.It Desktop app with a system type selected

3. Copy the registration command and paste into the terminal window of your target device

Devices are registered using the Host name of the device. You can add a variable to the command to override this before you run the command by adding the following before the the R3_REGISTRATION_CODE plus a space.

R3_DEVICE_NAME="Your device name"

Otherwise, you can rename the device after in the RemoteIt Desktop, app.remote.it or Mobile application. See documentation on devices and Editing Device Name

This command will automatically detect the platform and architecture of your device. It then downloads and installs the appropriate package. It will then register the device to your account.

4. Set up services

Your desktop app should notify you that your new device has been registered. remote.it will automatically detect and set up SSH.

If you have additional services you would like to add, follow the directions provided here.

Manual Installation

We recommend using the quick install method above since it will download the package and install it automatically. You can use this method if you prefer to select the package and install it manually.

1. Download the package

Open a terminal window on the device where remote.it will be installed, then download the package.

Example below is for a specific pi package. Please use the appropriate package url. This will place the file in your home directory click here for specific packages and urls.

For Debian OS distributions, if you are not sure of the architecture, you can run the following command:

sudo command is only required on systems where you are not logged in as root.

2. Update your package manager and install

Continue in terminal on the target device

Once that completes, then continue with the installation replacing the path and file name as appropriate

When this completes you will see the claim code to use in the desktop application to complete the setup.

Continue in terminal on the target device

Once that completes, then continue with the installation replacing the path and file name as appropriate

When this completes you will see the claim code to use in the desktop application to complete the setup.

Continue in terminal on the target device

Once that completes, then continue with the installation replacing the path and file name as appropriate

When this completes you will see the claim code to use in the desktop application to complete the setup.

Continue in terminal on the target device

Once that completes, then continue with the installation replacing the path and file name as appropriate

When this completes you will see the claim code to use in the desktop application to complete the setup.

You will need this claim code to complete the setup in the next steps. Save it until you complete registering the device.

This claim code is valid for 24 hours. If not used before then, re-run your installation command to get a new code.

Terminal output from the install command showing the generated registration claim code

3. Claim and register the device

Open your remote.it desktop application and log in. Then add the device using the registration claim code by clicking the + (Device Registration) in the upper left, then enter the claim code in the provided field.

The Device Registration field in the Remote.It Desktop app where the claim code is entered

You have now successfully registered the device to your account and should see it in your device list. If you get a message that it was not found, this indicates that the device was already claimed.

4. Set up services on your device

You will now define the services/ports for connections. For example SSH, HTTP, VNC, etc.

The device itself must be online to set up any services. The services you define in remote.it need to be set up and running on the device. For example if you set up VNC in remote.it, but do not have it running, it will not be reachable by remote.it

Click on the device to see its details and click the + in the Services panel to add a new service.

Device details view with the Services panel and its add service button

Select the appropriate service type. Then provide a name and port (Defaults are provided for most services). Only override default port if you have assigned a different port for this service on your device. Override the service host address if you are using this device as a jump service.

Click save. You will now see the new service.

A saved SSH service shown on the device, ready to connect

Repeat this process until you have all the services you want available via remote.it. You are now ready to connect and/or share this device. Visit connections page or the sharing page.

Upgrades

If you have a device with Desktop or CLI installed, upgrade those applications directly. If you have a version of remoteit which is older than 3.0, please contact support so that we can assist you directly.

To upgrade a device with remoteit device package Version 3.0 and higher installed follow these instructions.

1. Connect to ssh service on your device

Start an ssh connection (either directly or through remoteit) OR terminal and direct access to the target device

2. Download the package

Create an ssh connection to the device via remote.it and open terminal. (If you do not have a remoteit ssh service defined, you can create one or connect directly by using either the LAN or direct hardware console access)

Download the installation package to the device where remote.it will be installed. Example below is for a specific pi package. Please use the appropriate package url. This will place the file in your home directory See above.

3. Install the new package

This will step will update the remoteit target daemon and preserve the previously defined services and configurations. age manager as appropriate. i.e. Opkg, RPM or another package manager

Continue in terminal on the target device

If using remoteit to access ssh to the device, you will lose your ssh connection to the device during this step. This is normal since we are replacing the daemon and remoteit will restart the service.

During this step your desktop app will notify you that the device has gone offline. This is normal as the remoteit target service will stop during upgrade. Once this step completes you will again be notified that the device has come back online. If you were using the desktop for your connection, this connection will resume.

Continue in terminal on the target device

If using remoteit to access ssh to the device, you will lose your ssh connection to the device during this step. This is normal since we are replacing the daemon and remoteit will restart the service.

You may also need to install nohup which is not installed by default on most systems. This allows the installation to continue once the upgrade is in process and ssh hangs up temporarily.

During this next step your desktop app will notify you that the device has gone offline. This is normal as the remoteit target service will stop during upgrade. Once this step completes you will again be notified that the device has come back online. If you were using the desktop for your connection, this connection will resume.

Continue in terminal on the target device

If using remoteit to access ssh to the device, you will lose your ssh connection to the device during this step. This is normal since we are replacing the daemon and remoteit will restart the service.

You may also need to install nohup which is not installed by default on most systems. This allows the installation to continue once the upgrade is in process and ssh hangs up temporarily.

During this next step your desktop app will notify you that the device has gone offline. This is normal as the remoteit target service will stop during upgrade. Once this step completes you will again be notified that the device has come back online. If you were using the desktop for your connection, this connection will resume.

Uninstall

These instructions apply to the remoteit Device Package Version 4 and higher.

If you remove remote.it software while using a remote.it connection you will lose access to the device through our service immediately.

Follow this link:

https://support.remote.it/hc/en-us/articles/360054866351-Removing-the-remoteit-package-or-Desktop-application

At this point, you can then go to your device list (either in the Desktop Application or in the web portal at https://app.remote.it/#devices and delete the device to remove it from your device registry.

PreviousSupported Platforms
NextUsage

Last updated

Was this helpful?