iiab/roles/remoteit/README.md

# 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).  

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

To install remote.it onto a Raspberry Pi IIAB:

1. Set `remoteit_install` and `remoteit_enabled` to `True` in your IIAB's [/etc/iiab/local_vars.yml](http://wiki.laptop.org/go/IIAB/FAQ#What_is_local_vars.yml_and_how_do_I_customize_it.3F)
2. Install it (remote.it) onto your IIAB, by running:
   ```
   cd /opt/iiab/iiab
   sudo ./runrole remoteit
   ```
   <!--EXPLANATION: The above installs remote.it, in a way that was originally designed to be interactive, and provide you the claim code needed to make a remote connection to this IIAB.  The claim code is further explained below.-->

3. To obtain this IIAB's 8-letter remote.it claim code, allowing you to make a remote connection to this IIAB, run:
   ```
   grep claim /etc/remoteit/config.json
   ```
   *The claim code must be used within 24 hours, per:* https://docs.remote.it/device-package/installation#2.-update-your-package-manager-and-install

   If not used before then, re-run this installation command to get a new claim code:
   ```
   sudo apt reinstall /opt/iiab/downloads/remoteit-4.13.5.armhf.rpi.deb
   ```
4. After you've installed the https://remote.it client software onto a separate computer or device (e.g. your own laptop) click on the '+' icon, then enter the remote.it claim code (for the IIAB that you need to connect to).

   As shown in the screenshot here: https://docs.remote.it/device-package/installation#3.-claim-and-register-the-device

# Advanced

For "auto-registration" of remote.it, and other more advanced configuration options, please review:

- https://docs.remote.it
- https://support.remote.it
- https://support.remote.it/hc/en-us/articles/360044424612-1-Create-an-Auto-Registration
- https://support.remote.it/hc/en-us/articles/360044424672-1-Device-Setup-for-Auto-Bulk-Registration

# 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](https://github.com/iiab/iiab/issues/3006)
- 2021-10-28: The above OS issues should be resolved by [PR #3007](https://github.com/iiab/iiab/pull/3007), but this needs final testing!