Merge pull request #3005 from holta/remote.it

Lint & Clarify roles/remoteit [remote.it for remote support]

roles/0-init/tasks/validate_vars.yml

@@ -63,7 +63,7 @@
 #
 # 2020-11-04: Fix validation of 5 [now 4] core dependencies, for ./runrole etc
 
-- name: Set vars_checklist for 43 + 43 + 39 vars ("XYZ_install" + "XYZ_enabled" + "XYZ_installed") to be checked
+- name: Set vars_checklist for 44 + 44 + 40 vars ("XYZ_install" + "XYZ_enabled" + "XYZ_installed") to be checked
   set_fact:
     vars_checklist:
       - hostapd
@@ -74,6 +74,7 @@
       #- wondershaper       # Unmaintained
       - sshd
       - openvpn
+      - remoteit
       - admin_console
       #- nginx              # MANDATORY
       #- apache             # Unmaintained - former dependency

roles/1-prep/tasks/main.yml

@@ -13,6 +13,11 @@
     name: openvpn
   when: openvpn_install
 
+- name: REMOTE.IT
+  include_role:
+    name: remoteit
+  when: remoteit_install
+
 - name: IIAB-ADMIN -- includes roles/iiab-admin/tasks/access.yml
   include_role:
     name: iiab-admin

roles/remoteit/README.md

@@ -1,12 +1,22 @@
-# Installing Remoteit on a Raspberry Pi
-1. Set remoteit_install and remoteit_enabled to "True" in /etc/local_vars.yml.
-2. Run the role that installs remote.it.`
+# 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:
    ```
-    ./runroles remoteit
+   cd /opt/iiab/iiab
+   sudo ./runrole remoteit
    ```
-3. The last step installs the remoteit code. But the last part of the install is designed to be interactive, and returns a registration code which i required to make the connection from your remoteit global registration. So run the last step to retrieve and record the registration number.
+   EXPLANATION: The above installs remote.it code, in a way that was originally designed to be interactive, and provide you the registration code needed to make remote connections to this IIAB.
+
+3. To obtain this IIAB's remote.it registration code, run:
    ```
-    cd /opt/iiab/downloads
-    apt reinstall ./remoteit-4.13.5.armhf.rpi.deb
+   sudo apt reinstall /opt/iiab/downloads/remoteit-4.13.5.armhf.rpi.deb
    ```
-4. After you have installed the remote.it client desktop on your laptop, click on the + icon, and enter the registration number displayed in step #3.
+4. Record this registration code in a safe place, similar to a password!
+5. 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 registration number (for the IIAB that you need to connect to).

roles/remoteit/defaults/main.yml

@@ -1,4 +1,11 @@
-# Remote.it  allows you to make secure remote connections between two computers.
-# See https://docs.remote.it/cli/overview for possible values for remoteit_url
+# https://remote.it can help you remotely maintain an IIAB.
+
+# remoteit_install: True
+# remoteit_enabled: False
+
+# All above are set in: github.com/iiab/iiab/blob/master/vars/default_vars.yml
+# If nec, change them by editing /etc/iiab/local_vars.yml prior to installing!
+
+# See https://docs.remote.it/cli/overview to refine either value below:
 remoteit_cli_url: https://downloads.remote.it/cli/latest/remoteit_linux_armv7
 remoteit_device_url: https://downloads.remote.it/remoteit/v4.13.5/remoteit-4.13.5.armhf.rpi.deb

roles/remoteit/tasks/enable-or-disable.yml

@@ -1,5 +1,4 @@
-
-- name: Enable & (Re)Start connectd daemon which calls home
+- name: Enable & (Re)Start remote.it's connectd daemon which calls home
   systemd:
     name: connectd
     daemon_reload: yes
@@ -7,10 +6,9 @@
     state: restarted    
   when: remoteit_enabled
 
-- name: Disable & Stop connectd daemon
+- name: Disable & Stop remote.it's connectd daemon
   systemd:
     name: connectd
     enabled: no
     state: stopped
   when: not remoteit_enabled
-

roles/remoteit/tasks/install.yml

@@ -1,23 +1,24 @@
-- name: Download the command line interface for this device
+- name: Download the command line interface for this device to /usr/bin/{{ remoteit_cli_url }} (755)
   get_url:
-      url: '{{ remoteit_cli_url }}'
-      dest: /usr/bin/
-      mode: 0755
+    url: '{{ remoteit_cli_url }}'
+    dest: /usr/bin/
+    mode: 0755
 
-- name: Fetch the remoteit device package
+- name: Download {{ remoteit_device_url }} device package to {{ downloads_dir }}
   get_url:
-      url: '{{ remoteit_device_url }}'
-      dest: '{{ downloads_dir }}'
+    url: '{{ remoteit_device_url }}'
+    dest: '{{ downloads_dir }}'
 
-- name: uninstall the device package
+- name: Uninstall the device package {{ remoteit_device_url | basename }}
   apt:
-      name: '{{ remoteit_device_url | basename }}'
-      state: absent
-      
-- name: Install the device package
+    name: '{{ remoteit_device_url | basename }}'
+    state: absent
+
+- name: Install device package {{ downloads_dir }}/{{ remoteit_device_url | basename }}
   apt:
-      deb: '{{ downloads_dir }}/{{ remoteit_device_url | basename }}'
-      state: present
+    deb: '{{ downloads_dir }}/{{ remoteit_device_url | basename }}'
+    state: present
+
 
 # RECORD remoteit AS INSTALLED
 

roles/remoteit/tasks/main.yml

@@ -27,10 +27,9 @@
     value: "{{ item.value | string }}"
   with_items:
   - option: name
-    value: Remote It
+    value: remote.it
   - option: description
-    value: '"remote.it allows you to make secure remote connections between two computers. Some of the benefits include:
-Crossing multiple NATs/firewallsUsing a single TCP portportforwardless: without requiring port forwarding in the router, significantly reducing your network''s vulnerability."'
+    value: '"remote.it allows you to make secure remote connections between two computers.  Some benefits include: crossing multiple NATs/firewalls using a single TCP port, without requiring router port forwarding, and reducing your network''s vulnerability."'
   - option: remoteit_install
     value: "{{ remoteit_install }}"
   - option: remoteit_enabled

tests/test.yml

@@ -66,6 +66,7 @@
     - { role: postgresql }
     - { role: pylibs }
     #- { role: rachel }
+    - { role: remoteit }
     - { role: samba }
     #- { role: schooltool }
     - { role: sshd }

vars/default_vars.yml

@@ -194,6 +194,10 @@ sshd_install: True    # Required by OpenVPN
 sshd_enabled: True
 sshd_port: 22    # Not fully functional.  SEE: roles/sshd/tasks/install.yml
 
+# https://remote.it can help you remotely maintain an IIAB.
+remoteit_install: True
+remoteit_enabled: False
+
 openvpn_install: True
 openvpn_enabled: False
 # For /etc/iiab/openvpn_handle

vars/local_vars_big.yml

@@ -109,7 +109,7 @@ dns_jail_enabled: False
 sshd_install: True    # Required by OpenVPN
 sshd_enabled: True
 
-# Remote.it  allows you to make secure remote connections between two computers.
+# https://remote.it can help you remotely maintain an IIAB.
 remoteit_install: True
 remoteit_enabled: False
 

vars/local_vars_medium.yml

@@ -109,7 +109,7 @@ dns_jail_enabled: False
 sshd_install: True    # Required by OpenVPN
 sshd_enabled: True
 
-# Remote.it  allows you to make secure remote connections between two computers.
+# https://remote.it can help you remotely maintain an IIAB.
 remoteit_install: True
 remoteit_enabled: False
 

vars/local_vars_min.yml

@@ -109,7 +109,7 @@ dns_jail_enabled: False
 sshd_install: True    # Required by OpenVPN
 sshd_enabled: True
 
-# Remote.it  allows you to make secure remote connections between two computers.
+# https://remote.it can help you remotely maintain an IIAB.
 remoteit_install: True
 remoteit_enabled: False
 

vars/local_vars_unittest.yml

@@ -109,7 +109,7 @@ dns_jail_enabled: False
 sshd_install: True    # Required by OpenVPN
 sshd_enabled: True
 
-# Remote.it  allows you to make secure remote connections between two computers.
+# https://remote.it can help you remotely maintain an IIAB.
 remoteit_install: True
 remoteit_enabled: False