From 1a9025050085f394cce9d8f1caaaaf523da52a33 Mon Sep 17 00:00:00 2001 From: A Holt Date: Fri, 8 Apr 2022 23:46:13 -0400 Subject: [PATCH] remoteit/README.md: Clear(er) Instructions --- roles/remoteit/README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/roles/remoteit/README.md b/roles/remoteit/README.md index 62cf4c12e..489af24fb 100644 --- a/roles/remoteit/README.md +++ b/roles/remoteit/README.md @@ -22,15 +22,17 @@ For other approaches, please see http://FAQ.IIAB.IO -> "How can I remotely manag 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](https://docs.remote.it/software/device-package) is already installed on your IIAB, most important. It also means the _strictly optional_ `/usr/bin/remoteit` [command-line interface (CLI)](https://docs.remote.it/software/cli) is installed, offering [a few more features](https://support.remote.it/hc/en-us/articles/4412786750861-Install-the-remoteit-agent-on-your-device) than the Device Package. -1. Run `sudo iiab-remoteit` to enable remote.it on your IIAB. +1. Run `sudo iiab-remoteit` to enable remote.it on your IIAB: - Hit `[Enter]` if this is a fresh install, to quickly generate a claim code for your IIAB. + - Hit [Enter] if this is a fresh install, to quickly generate a claim code for your IIAB. - (The claim code is put in `/etc/remoteit/config.json` and must be used [within 24 hours](https://docs.remote.it/device-package/installation#2.-update-your-package-manager-and-install).) + The claim code must be used [within 24 hours](https://docs.remote.it/device-package/installation#2.-update-your-package-manager-and-install) (Step 2., below). - NOTE: If a remote.it license key is found in `/etc/iiab/local_vars.yml` or `/etc/remoteit/registration`, that will be tried first (prior to generating a claim code). + Just FYI a copy is also put in: `/etc/remoteit/config.json` - *If the license key works, you will not get a claim code (as the IIAB device auto-registers to your remote.it account) and you can skip to Step 3.* + - EXCEPTION: 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.*