1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-02-13 03:32:12 +00:00
iiab/roles/remoteit/README.md

9.8 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 April 2022, 5 IIAB devices can be managed for free, and an unlimited number can be managed for $6/month.

For other approaches, please see http://FAQ.IIAB.IO -> "How can I remotely manage my Internet-in-a-Box?"

Getting Started

Create a remote.it account + install its desktop application

  1. Browse to https://remote.it (Web Portal) and sign up for an account.

  2. Download and install 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.

    COMPARISON: "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!) It means that the remote.it Device Package is installed on your IIAB, most important. It also means the strictly optional /usr/bin/remoteit command-line interface (CLI) is installed, offering a few more features than the Device Package.

  1. Run sudo iiab-remoteit to enable remote.it on your IIAB.

    Hit [Enter] twice if you want to quickly generate a new claim code for your IIAB.

    (The claim code is put in /etc/remoteit/config.json and must be used within 24 hours.)

  1. 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.

  2. Authorize services/ports (e.g. SSH, HTTP, etc) for your IIAB device, as shown in these screenshots.

    SUMMARY: One or more remote.it "Services" needs 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

  1. 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
    
  2. Also set remoteit_enabled: True in /etc/iiab/local_vars.yml

    (And verify that remoteit_install: True is set.)

  3. 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.

  4. If your IIAB software is already installed, make sure your IIAB is online.

    Now register your IIAB to your remote.it account (while enabling remote.it on your IIAB device) by running:

    cd /opt/iiab/iiab
    sudo ./runrole remoteit
    

    If you also want to reinstall the (latest) remote.it Device Package on your IIAB, you can instead run:

    cd /opt/iiab/iiab
    sudo ./runrole --reinstall remoteit
    
  5. Authorize services/ports (e.g. SSH, HTTP, etc) for your IIAB device, as shown in these screenshots.

    SUMMARY: One or more remote.it "Services" needs 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?

  1. Run sudo iiab-remoteit-off

  2. 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

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: #3006
  • 2021-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.)