11 KiB
Remote support of an Internet-in-a-Box using https://remote.it
Remote.it can be a great way to remotely support an Internet-in-a-Box (IIAB).
As of 2024, 5 IIAB devices can be managed for free (their personal / non-commercial plan) and larger numbers for $10+/month.
For other approaches, please see FAQ.IIAB.IO -> "How can I remotely manage my Internet-in-a-Box?"
Getting Started
Create a remote.it account + consider its desktop application
-
Browse to https://remote.it (Web Portal) and sign up for an account.
-
Consider downloading and installing the remote.it desktop application (e.g. for Windows, macOS or Linux) on your own laptop/computer. Their https://remote.it Web Portal and mobile apps are also sometimes sufficient, but less functional.
2023-07-26 WARNING: IIAB no longer installs the
/usr/bin/remoteit
command-line interface (CLI), as it can no longer coexist with the coreremoteit
Device Package. Whereas in the past the remote.it CLI had offered a few more features: "The Desktop and CLI can [each] support both peer to peer connections and proxy connections [whereas] the Web Portal and API can only support proxy connections" according to https://docs.remote.it/software/device-package/usage
OPTION #1: Generate a remote.it claim code for your IIAB + register it + authorize services/ports
Prerequisite: Find any IIAB with remoteit_installed: True
in /etc/iiab/iiab_state.yml
(this is the default!) This means that the remote.it Device Package is already installed on your IIAB, most important.
-
Run
sudo iiab-remoteit
to enable remote.it on your IIAB:-
Hit [Enter] (repeatedly if necessary, to accept all defaults) to quickly generate a claim code for your IIAB.
The claim code must be used within 24 hours (Step 2., below).
Just FYI a copy is also put in:
/etc/remoteit/config.json
-
EXCEPTION #1: If a remote.it license key happens to be found in
/etc/iiab/local_vars.yml
or/etc/remoteit/registration
, that will be tried first (prior to, and instead of generating a claim code).If the license key works, you will not get a claim code (as the IIAB device auto-registers to your remote.it account) so jump to Step 5. in OPTION #2.
-
EXCEPTION #2: If you have an existing
/etc/remoteit/config.json
you will be given the option to try that (e.g. if you already registered the IIAB device to your remote.it account).Verify that after
sudo iiab-remoteit
completes, by jumping to Step 5. in OPTION #2.
-
-
Submit the claim code within the remote.it desktop application on your own laptop/computer. Or if you prefer, do that by logging into their Web Portal at: https://remote.it
Either way, click on the '+' icon to enter the remote.it claim code (to register the IIAB device to your remote.it account) as shown in this screenshot.
-
Authorize services/ports (e.g. SSH, HTTP, etc) for your IIAB device, as shown in these screenshots, and you're all done!
SUMMARY: One or more remote.it "Services" need to be authorized (registered) to allow remote access to your IIAB device.
EXAMPLES: Add an SSH Service on port 22 and/or add an HTTP Service on port 80 (screenshot guide).
OPTION #2: Paste your remote.it license key to IIAB + enable it + authorize services/ports
-
Copy your remote.it account license key from their Desktop Application (https://remote.it/download/) or from their Web Portal (https://remote.it) — as shown in this screenshot.
Paste it into your IIAB's /etc/iiab/local_vars.yml as in this example:
remoteit_license_key: 592AA9BB-XXXX-YYYY-ZZZZ-6E27654C3DF6
FYI to protect your credential, the above line will promptly be redacted (removed) from your /etc/iiab/local_vars.yml — after the key is copied to
/etc/remoteit/registration
in Step 3. or 4. below. -
Also set
remoteit_enabled: True
in /etc/iiab/local_vars.yml(And verify that
remoteit_install: True
is set.) -
If your IIAB software is not yet installed, do that e.g. by running
sudo iiab
and following any on-screen instructions — until "INTERNET-IN-A-BOX (IIAB) SOFTWARE INSTALL IS COMPLETE" eventually appears on screen.When that's complete, skip to Step 5.
-
If your IIAB software is already installed, make sure your IIAB is online.
Now register the IIAB device to your remote.it account, by running
sudo iiab-remoteit
(this also enables remote.it on your IIAB).Or, if you prefer the legacy approach, run:
cd /opt/iiab/iiab sudo ./runrole remoteit
The legacy approach can also reinstall the (latest) remote.it Device Package on your IIAB, if you instead run:
cd /opt/iiab/iiab sudo ./runrole --reinstall remoteit
-
Log in to https://remote.it or its desktop application on your own computer/laptop.
In the "Devices" section on the left, check that your IIAB is now present (i.e. registered to your account).
-
Authorize services/ports (e.g. SSH, HTTP, etc) for your IIAB device, as shown in these screenshots, and you're all done!
SUMMARY: One or more remote.it "Services" need to be authorized (registered) to allow remote access to your IIAB device.
EXAMPLES: Add an SSH Service on port 22 and/or add an HTTP Service on port 80 (screenshot guide).
How to I disable remote.it on my IIAB?
-
Run
sudo iiab-remoteit-off
-
If you also want to completely remove all remote.it software and its settings, run:
sudo apt purge "remoteit*" sudo rm /usr/bin/remoteit
Docs
- https://docs.remote.it
- https://support.remote.it
- https://support.remote.it/hc/en-us/categories/360003417511-Getting-Started
- https://support.remote.it/hc/en-us/articles/360061228252-Oops-I-cloned-an-SD-card-
- https://support.remote.it/hc/en-us/articles/4404156674445-Subscriptions-and-Licensing
- https://support.remote.it/hc/en-us/articles/360041590951-Why-does-the-address-time-out-
- https://support.remote.it/hc/en-us/articles/360047705691-Desktop-Application-Release-Notes
- https://support.remote.it/hc/en-us/articles/4492289672973-Two-ways-of-using-remote-it-Connections
- https://support.remote.it/hc/en-us/articles/4422773654669-Streamlined-installation-for-Linux-and-Raspberry-Pi-platforms
- https://support.remote.it/hc/en-us/articles/360051668711-Updating-the-remoteit-or-connectd-packages-using-a-remote-it-SSH-connection
- https://remote.it/legal/
Known Issues
2021-10-27: This needs to be enhanced rather urgently, so remote.it also works when IIAB is installed on Raspberry Pi OS 11 (Bullseye), Ubuntu, Mint and Debian: #30062021-10-29: The above OS issues should be resolved by PR #3007, PR #3009 and PR #3010 — but this needs final testing! (Initial testing occurred on [1] 32-bit Raspberry Pi OS Lite on Raspberry Pi 4 and [2] Ubuntu Server 20.04 on x86_64 VM.)