TMIServer Demo

TMIServer

This is the dashboard and backend processing database program.

The backend processor is a postgres Docker container, and it needs to be running before TMIServer can be started.

The instructions are split into two catagories,

  • Basic
    • Simplest and fastest way to see TMIServer
  • Full
    • Uses git to clone a prescriptive directory structure used by TMIServer

TMI programs are deployed as Docker containers, which allows the programs to run in a virtual environment, and be independent of your host operating system. This means, for example, that you don’t have to worry about python packages, versions of modules, etc

Requirements

  • Operating System
    • The system was developed on both Windows 10 and Ubuntu 18.04
    • Most testing occurs on Ubuntu given its the expected OS used in the factory because of cost (its free)
    • All these instructions are for Ubuntu 18.04
  • Outside Software Requirements

Postgres

TMIServer needs a postgresql backend to be running in order to work, which will be installed first.

  • postgresql server
    • make a new directory in your home directory, change into it, create a data directory, and run Docker postgres command (this will pull postgres container)
  mkdir ~/postgres
  cd ~/postgres
  mkdir datadir
  docker network create tminet
  docker run --net tminet --name tmidb -v $(pwd)/datadir:/var/lib/postgresql/data -e POSTGRES_PASSWORD=qwerty -d postgres:11

* add `--restart=always` to the docker run command to have this container run every time the computer boots up;
  only do this if you plan on using/evaluating TMI for an extended time, otherwise remember to issue the above docker run
  command
  • now create the required databases - you only need to do this ONCE
docker exec -it tmidb createdb -U postgres resultbasekeysv1

Basic

Run Basic

  • First the tmiserver Docker container must be pulled from docker hub
docker pull mgagcode/tmiserver
  • Run tmiserver container - it doesn’t matter which directory you are in
docker run -d --net tminet -p 6600:6600 mgagcode/tmiserver

  • Open Google Chrome to

    • Note on slower computers, it may take 5-15 seconds for the TMIServer window to display
    • TMIServer login user/password is admin/admin
    • Other users passwords are qwerty
    • To update tmiserver use docker pull mgagcode/tmiserver before running it.

Full

The Full Demo assume you have followed the instructions for the basic demo.

The Full Demo works by creating a local file structure and telling the tmiserver Docker container to use that local file system. This requires a more advanced docker run command.

Git and Github are used.

Clone TMIScripts

  • If you have already cloned tmi_scripts from the TMIStation instructions, you do not need to do this again here.

  • There is a prescriptive directory structure to use, and that is stored on github in a project called tmi_scripts

  • This github repo is where you would ultimately store and version control your own scripts

    • Instead of cloning the repo, you would fork [1] (copy) it, making it your own, and then add your own code

  • The instructions below will create a folder called git/tmiserver which git will copy the required files into

  • Clone tmi_scripts:

    mkdir ~/git
cd ~/git
git clone https://github.com/mgagcode/tmi_scripts.git

Run Full

  • Run postgres:

    cd ~/git/tmi_scripts/public
./tmipostg.sh

  • Run TMIServer:

    cd ~/git/tmi_scripts/public
./tmiserver.sh

  • Open Google Chrome to

[1]This is covered in section TBD