Ansible playbook for setting up LoRa Server
Clone or download

README.md

LoRa Server setup

This repository provides an Ansible playbook to setup the LoRa Server. project (including dependencies). With the included Vagrant file, the LoRa Server can also be setup locally (e.g. on VirtualBox).

It will:

Vagrant (local environment using VirtualBox)

The included Vagrantfile will setup an Ubuntu Xenial (16.04) virtual machine with the latest LoRa Server components installed. It will also forward the following ports to your host system:

  • 8080: LoRa App Server UI and API
  • 1700: UDP listener for the packet-forwarder data
  • 1883: Mosquitto MQTT
  • 1884: Mosquitto Websockets

Note: when using Vagrant, there is no need to install Ansible (this will be automatically installed inside the Vagrant machine).

Requirements

When setting up the LoRa Server environment, make sure you have a recent version of Vagrant installed.

Also make sure you have a recent version of VirtualBox installed, including the VirtualBox Extension Pack.

Getting started

  1. Update roles/loraserver/templates/loraserver.toml so that the network_server.band.name matches the LoRaWAN band to use. Depending the chosen band, you might also be interested in updating other network-server settings listed under the network_server.network_settings section.

  2. Within the root of this repository execute the following command:

    vagrant up

    As this will import the Vagrant box, install all requirements etc... this is going to take a while.

  3. Configure your LoRa Gateway so that it points to the IP address of your computer (port 1700).

  4. Point your browser to http://localhost:8080/. As a self-signed certificate is used, your browser will prompt that the certificate can't be trusted. This is ok for testing.

  5. For updating your Vagrant environment (e.g. updating the configuration or to upgrade installed packages, execute the following command:

    vagrant provision
  6. Other useful commands:

    # stop the vagrant machine
    vagrant halt 
    
    # restart the vagrant machine
    vagrant reload
    
    # ssh into the vagrant machine
    vagrant ssh
    
    # destroy the vagrant machine
    vagrant destroy

Remote deployment

This playbook has been tested on DigitalOcean.com but should also work on bare-metal, AWS, ...

Don't have a DigitalOcean account yet? Use this link and get $10 in credits for free :-)

Requirements

On the machine from where you will execute this Ansible playbook (e.g. your own computer), make sure you have Ansible 2.1+ installed. You can install Ansible with pip (pip install ansible) or using Homebrew (OS X) (brew install ansible). Refer to the Ansible installation guide for more installation instructions.

The Ansible playbook has been tested on the following images:

  • Debian

    • Stretch (9.x)
  • Ubuntu

    • Xenial (16.04.x LTS)
    • Bionic (18.04.x LTS)

Configuration

  1. Create a new Ubuntu 16.04.x instance and make sure that from your own machine on which Ansible is installed, you can ssh to this machine using public-key authentication (e.g. ssh user@ip).

  2. Configure a DNS record for your target instance and wait until this record resolves to your IP address. This is required in case you configured LetsEncrypt. You can skip this step when not using LetsEncrypt ( accept_letsencrypt_tos: False in single_server.yml).

  3. Copy the inventory.example inside this repository to inventory and replace example.com with the hostname created in step 2.

  4. Copy the group_vars/single_server.example.yml inside this repository to group_vars/single_server.yml and change the settings where needed.

  5. Update the LoRa Gateway Bridge, LoRa App Server and LoRa Server configuration files under:

    • roles/lora-gateway-bridge/templates/lora-gateway-bridge.toml
    • roles/lora-app-server/templates/lora-app-server.toml
    • roles/loraserver/templates/loraserver.toml

See also the following links for more documentation:

Provisioning

Run the following command from your machine to deploy LoRa Server to your target instance, to upgrade to the latest versions or to update the configuration:

ansible-playbook -i inventory full_deploy.yml

After the playbook has been completed, the dashboard should be accessible from http://yourdomain.com:8080/.

Changelog (playbook changes)

2018-10-30

  • LoRa App Server default configuration now uses http (no TLS certificate).

2018-09-17

  • Updated playbook to support Ubuntu 18.04.x, 16.04.x and Debian Stretch (9.x).
  • postgresql package is always installed from distribution repository.
  • mosquitto package is always installed from distribution repository.
  • Added installation of LoRa Geo Server service.

2018-07-30

  • Change to LoRa Server v2 apt repository.

2018-04-22

  • Remove mosquitto-auth-plug setup (which was causing a lot of issues)
  • Update configuration .yml files under group_vars and host_vars (for Vagrant)

2018-02-22

  • Include LoRa Gateway Bridge, LoRa App Server and LoRa Server configuration files as templates. See Configuration.

2017-12-16

  • auth_opt_aclquery query of the mosquitto-auth-plug has been updated as application users have been deprecated.

2017-07-26

  • GW_SERVER_JWT_SECRET configuration option has been added to the example configuration file, which will be mandatory for LoRa Server 0.20.0.

  • Port 8002 (used by LoRa Gateway Config) has been added as public accessible port in the example configuration.

  • letsencrypt cli has been changed to certbot cli (as per installation instructions documented at https://certbot.eff.org).

2017-06-20

  • Mosquitto authentication / authorization has been added (using mosquitto-auth-plug). The loraserver_hosts.example.yml has been updated with example configuration. Note that anonymous connections will be rejected. This allows users to connect to the MQTT broker using their LoRa App Server credentials.

2017-03-28