Skip to content

Installing Resultra on an Ubuntu Linux Server

Steve Roehling edited this page Apr 8, 2019 · 2 revisions

Resultra is designed to run on Linux servers from within a Docker container. The software can be run on a dedicated server or a Linux virtual machine (VM) with at least 1GB memory.

Install Docker

The first prerequisite for running Resultra is that Docker is installed on the system where you plan to run Resultra. If docker is already installed, this step can be skipped. To install Docker, follow the official docker installation instructions; i.e.:

  1. Update the apt package index:

     $ sudo apt-get update
    
  2. Install packages needed to use the Docker repository over HTTPS:

     $ sudo apt-get install apt-transport-https ca-certificates curl software-properties-common
    
  3. Add Docker’s official GPG key:

     $ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
    
  4. Verify the fingerprint:

     $ sudo apt-key fingerprint 0EBFCD88
    
  5. Inspect the last 8 characters of the fingerprint to verify you now have the key with the fingerprint:

     9DC8 5822 9FC7 DD38 854A E2D8 8D81 803C 0EBF CD88
    
  6. Setup the stable repository for Docker:

     $ sudo add-apt-repository \
     "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
     $(lsb_release -cs) \
     Stable"
    
  7. Install Docker CE

     $ sudo apt-get update
     $ sudo apt-get install docker-ce		
    
  8. Verify docker is installed

     $ sudo docker run hello
    

Install Docker Compose

Secondly, Docker Compose needs to be installed to run Resultra’s server alongside a Postgres database container. If Docker and Docker Compose are already installed, this step can be skipped. Install Docker Compose using the official installation instructions, i.e.:

  1. Download the latest stable release of Docker compose:

     $ sudo curl -L "https://github.com/docker/compose/releases/download/1.23.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
    
  2. Apply executable permissions to the binary:

     $ sudo chmod +x /usr/local/bin/docker-compose
    
  3. Verify the installation:

     $ sudo docker-compose --version
    

Download and Install Resultra

All the software for setting up and running resultra is installed under the /usr/local/resultra directory.

  1. Download the latest software distribution:

     $ cd ~/Downloads
     $ curl -OJL https://github.com/resultra/resultra/releases/download/v1.0.0-beta.1/resultra.linux-amd64.v1.0.0-beta.1.tar.gz
    
  2. If there is an existing installation, first uninstall it (remove it):

     $ sudo rm -Rf /usr/local/resultra
    

    Important Note: Only the software to run Resultra is located under the /usr/local/resultra directory, not the data files. By following Resultra's standard installation instructions, none of Resultra's data files will be removed when uninstalling just the software.

  3. Extract into the folder for Resultra’s software installation and adjust file permissions:

     $ sudo tar -xvzf resultra.linux-amd64.v1.0.0-beta.1.tar.gz -C /usr/local/
     $ sudo chown -R root:root /usr/local/resultra
    

Email Setup

Email is necessary for Resultra to be setup and function properly. In particular, Resultra needs access to an SMTP email server to send emails for account notifications, password resets, and the like.

If you don't already have an email server configured, using a dedicated email service is strongly recommended. Many of these services offer free or very low cost service to deliver email. Some recommended email service providers include:

Setup Resultra

Resultra comes with a setup program to:

  • Configure the directory structure under /var/resultra for data and configuration files.
  • Initialize the database.
  • Configure email settings for sending email.

When first installing Resultra, this setup program can be run as follows:

$ sudo /usr/local/resultra/bin/resultraSetup

The setup program will prompt for configuration information needed to setup the server. Upon conclusion of the setup, Resultra is ready to be launched for the first time.

Launching Resultra

Once setup is complete, Resultra is launched using the docker-compose command. This will launch both the Resultra application and database servers.

sudo docker-compose /usr/local/resultra/dockerImage/docker-compose.yml up -d

The first time docker-compose is run, some initialization of the Docker containers will occur, and it may take a couple minutes to first launch the application. Since the application was launched in the background using the -d option, the application will be restarted if the server reboots.

Registering the Administrative User

Once the application is first launched, the first person to register will be designated as the site's administrative user. If the system is running on localhost, this administrative registration can be performed by opening a web browser and visiting the following address:

http://localhost/setup
You can’t perform that action at this time.