<commit_before>Role Name
=========

TTN setup for a Multi-Tech Conduit

Requirements
------------

The following setup must be set up performed on the Contduit:

+ Install mLinux (not AEP)
+ Configure Network
+ Install a few packages for Ansible to run:
    + python-pkgutils
	+ python-distutils
+ Install a root key
    + This is required to allow secure login to the gateway
+ Configure ssh tunnel
    + If the Conduit is not available on the public Internet, an ssh
      tunnel must be configured to the host on which Ansible is run

Role Variables
--------------

A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.

<dl>
	<dt>hostname</dt>
	<dd>The hostname of this node in the format <i>ttn-<b>ORG</b>-<b>NODE</b></i></dd>
	<dt>timezone</dt>
	<dd>The timezone for this node, i.e. a file path rooted at
	<i>/usr/share/zoneinfo</i>.  E.g.: <b>US/Eastern</b></dd>
	<dt>region</dt>
	<dd>The region sets the frequency band, one of <b>AU</b>, <b>EU</b>, or <b>US</b></dd>
	<dt>contact_email</dt>
	<dd>An e-mail address to contact if there is a problem with the gateway</dd>
	<dt>description</dt>
	<dd>Description of the gateway's location</dd>
	<dt>ntp_servers</dt>
	<dd>A list of region appropriate NTP servers
	(i.e. 0,1,2.north-america.pool.ntp.org).  The first is used with
	ntpdate to set the hwclock and the others are used to keep the
	time in sync</dd>
	<dt>latitude</dt>
	<dt>longitude</dt>
	<dd>Co-ordinates of this gateway</dd>
	<dt>altitude</dt>
	<dd>Altitude of this gateway in meters</dd>
</dl>

Dependencies
------------

A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.

Example Playbook
----------------

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

    - hosts: all
      roles:
         - common

License
-------

MIT

Author Information
------------------

<NAME> <<EMAIL>>

<commit_msg>Document tags<commit_after>Role Name
=========

TTN setup for a Multi-Tech Conduit

Requirements
------------

The following setup must be set up performed on the Contduit:

+ Install mLinux (not AEP)
+ Configure Network
+ Install a few packages for Ansible to run:
    + python-pkgutils
	+ python-distutils
+ Install a root key
    + This is required to allow secure login to the gateway
+ Configure ssh tunnel
    + If the Conduit is not available on the public Internet, an ssh
      tunnel must be configured to the host on which Ansible is run

Role Variables
--------------

A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.

<dl>
	<dt>hostname</dt>
	<dd>The hostname of this node in the format <i>ttn-<b>ORG</b>-<b>NODE</b></i></dd>
	<dt>timezone</dt>
	<dd>The timezone for this node, i.e. a file path rooted at
	<i>/usr/share/zoneinfo</i>.  E.g.: <b>US/Eastern</b></dd>
	<dt>region</dt>
	<dd>The region sets the frequency band, one of <b>AU</b>, <b>EU</b>, or <b>US</b></dd>
	<dt>contact_email</dt>
	<dd>An e-mail address to contact if there is a problem with the gateway</dd>
	<dt>description</dt>
	<dd>Description of the gateway's location</dd>
	<dt>ntp_servers</dt>
	<dd>A list of region appropriate NTP servers
	(i.e. 0,1,2.north-america.pool.ntp.org).  The first is used with
	ntpdate to set the hwclock and the others are used to keep the
	time in sync</dd>
	<dt>latitude</dt>
	<dt>longitude</dt>
	<dd>Co-ordinates of this gateway</dd>
	<dt>altitude</dt>
	<dd>Altitude of this gateway in meters</dd>
</dl>

Dependencies
------------

A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.

Example Playbook
----------------

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

    - hosts: all
      roles:
         - common

Tags
----

The following tags can be used to run a subset of the playbook.

<dl>
	<dt>setup</dt>
	<dd>Initial Ansible setup, including setting up for custom facts</dd>
	<dt>hostname</dt>
	<dd>Sets the Conduit's hostname</dd>
	<dt>time</dt>
	<dd>Configures the timezone and syncs to time servers<dd>
	<dt>users</dt>
	<dd>Adds the <i>ttn</i> user and sets ssh login keys</dd>
	<dt>sshd</dt>
	<dd>Configurs sshd</dd>
	<dt>localtree</dt>
	<dd>Builds a <i>/usr/local</i> tree in <i>/var/config/local</i></dd>
	<dt>forwarder</dt>
	<dd>Removes the Multi-Tech packet forwarder and installs the TTN Poly Packet Forwarder</dd>
	<dt>loraconfig</dt>
	<dd>Sets up <i>/var/config/lora</i> and the necessary config files</dd>
	<dt>letsencrypt</dt>
	<dd>Installs the Let's Encrypt signing certificate for validating https connections</dt>
</dl>

License
-------

MIT

Author Information
------------------

<NAME> <<EMAIL>>


{'fraction_non_alphanumeric': 0.13468567251461988, 'fraction_numerical': 0.0010964912280701754, 'mean_word_length': 3.388933440256616, 'pattern_counts': {'":': 0, '<': 159, '<?xml version=': 0, '>': 159, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1321315', 'n_tokens_mistral': 1819, 'n_tokens_neox': 1768, 'n_words': 712}