Install and Start-Up

NOTE
The start script is at the root of the installation directory and is run as sudo ./ubuntu-start.sh.
All other scripts live in the toolkit/ folder, have plain names, and are also run with sudo — for example sudo ./toolkit/backup.sh.
See Script Naming and Usage.

Obtaining Software and Keyfile

Follow the instructions from you NetAlly Order Fulfillment Acknowledgement to download the Link-Live Private Software and Keyfile.

Downloading Files

  1. Go to the public Link-Live.com and create an account.

  2. In the left-side menu, navigate to Support > Software Downloads, and scroll down to Link-Live Private.

  3. Enter your Serial Number to download both the Software and Keyfile. Both files are used to install your Private Instance of Link-Live.

Extracting Files

The name of the tar.gz file you receive includes the version and build number of your release, so it changes with every release. In the examples below, <version> stands in for that part of the name. To check the version you are running, see version.txt at the root of the installation directory.

The recommended location for the installation directory is /opt. Installing elsewhere works, but the start script prints a warning naming /opt as the recommended location before continuing normally.

  1. In the terminal, extract the tar.gz file provided into /opt:

    sudo tar -xvzf link-live_<version>_ubuntu-focal_initial_install.tar.gz -C /opt

    The extracted folder should contain the following:

    • nginx/ – NGINX configuration and the default self-signed certificates.

    • docker-images/ – Container images and the software installed by the start script.

    • db-migrations/ – Database migration scripts, applied automatically.

    • firmware/ – Tester firmware shipped with this release.

    • toolkit/ – backup.sh, restore.sh, cert-renew.sh, and export-logs.sh.

    • docker-compose.yml – Container definitions.

    • version.txt – The Link-Live Private version contained in this bundle.

    • README.md

    • ubuntu-start.sh – The start script, and the only script at the root of the folder.

    NOTE: Only the start script carries an operating system prefix. Every other script sits in toolkit/ under a plain name.

  2. Move into the new installation directory. For example:

    cd /opt/link-live_<version>_ubuntu-focal_initial_install

  3. Run the start script:

    sudo ./ubuntu-start.sh

    Your system will provide a series of prompts to complete installation.

Setting Up your Environment

The start script prompts you for each setting it needs, including the host address that users and tester units will connect to.

CAUTION! At the host prompt, do not enter 127.0.0.1 or localhost.

Enter the server's real IP address or DNS hostname, the same address you will configure on your tester units. This one value is used by three different things, and a loopback address only works for one of them:

Used by

Requires

Your web browser

An address reachable from your computer.

Link-Live Private internal services

An address reachable from inside the application.

Tester units

An address routable on your network.

If you enter 127.0.0.1, the web interface still appears to work when you browse to it from the server itself, but uploaded files (including AirMapper surveys) remain stuck on Processing indefinitely, and tester units cannot upload at all. See Troubleshoot.

  • An environment file is created as part of setup. Rerunning the start script loads the corresponding environment configuration automatically. The file is saved at /etc/link-live/ll.env.

  • Run the script with the same user and permissions each time to avoid access issues.

Superuser Account Creation

The user and password variables are used on container startup to create a superuser account, which is necessary for the application to function correctly.

  • Use your superuser account to upload a new keyfile, create OTA unit updates, and for uploading Android applications.

  • Do not change the password on this account through the Link-Live UI, use it to claim units, or for other routine Link-Live functionality. You should instead create a new account via the "Create account" link on the login screen, or, if that button is disabled, by inviting users to an organization.

  • If you need to change the password on the super account, run sudo ./ubuntu-start.sh auth.

Server Information and SSL/TLS Certificates

When Link-Live Private is started without any NGINX template configuration, it serves on port 443, with the NGINX container managing certificates. Note that the NGINX container binds that port to the host machine automatically.

  • Link-Live Private serves on port 443 with NGINX handling SSL certificates. Port 80 is not used, and there is no redirect from HTTP, so browse to https:// explicitly.

  • Either supply the path to your certificate and key while the start script runs, or replace default certificates in nginx/certs with your own trusted SSL certificate.

    NOTE: Failing to replace these will result in port 443 using invalid, self-signed certificates.

  • Obtain an official SSL certificate by registering a domain (e.g., mycompany.com) with a certificate provider.

    NOTE: Ensure you do not have www. in your host name. For example, Link-Live-Private.mycompany.com.

  • To update certificates without restarting, run the cert-renew.sh script in the toolkit folder:

    sudo ./toolkit/cert-renew.sh

    This script, like the start script, optionally prompts you to supply paths to certificate files. If you have replaced the files manually, skip that prompt. It will then restart the NGINX container for you, with the new instance utilizing the new certificate files.

  • If desired, see the NGINX configuration template at nginx/templates/default.conf.template to implement your own certificate management strategy.

NOTE: NetAlly does not provide support for custom NGINX configurations.