MHK/Timelink manager and installer

Installs MHK/Timelink on Linux, MacOS and Windows machines, using Docker and provides command line management commands for MHK.

You need to install Docker Desktop on MacOS and Windows, and on Linux using the system package manager.

This Docker version is work in progress, under tests

First time install of MHK

The installer needs be run the first time in an empty directory.

The directory will become the mhk-home where all the MHK related files will be kept.

Most users will create a directory named mhk-homein their home directory. If you want to create mhk-home in another location on your computer you must navigate to the desired directory before executing the commands bellow.

On MacOS

First install Docker Desktop from https://www.docker.com/products/docker-desktop.

To create the mhk-home directory in the home directory and install MHK open a terminal window and type:

mkdir -p mhk-home
cd mhk-home
docker run -v ${PWD}:/mhk-home -it joaquimrcarvalho/mhk-manager mhk-install && sh app/manager init

or in a single line:

mkdir -p mhk-home && cd mhk-home && docker run -v ${PWD}:/mhk-home -it joaquimrcarvalho/mhk-manager mhk-install && sh app/manager init

Close the terminal window and open a new one.

Test if the install was successful with

mhk --version

On Windows

MHK is tested on Windows 10 with WSL (Windows subsystem for linux).

For current documentation on how to install WSL on Windows 10 see https://docs.microsoft.com/en-us/windows/wsl/install

Currently:

1. Install WSL: on windows command prompt or PowerShell type

wsl --install

Restart windows

1. Setup Linux user info

Check https://docs.microsoft.com/en-us/windows/wsl/setup/environment#set-up-your-linux-user-info

1. Install docker desktop

Goto https://docs.docker.com/docker-for-windows/wsl/#download

1. Configure docker permissions

Before installing mhk it is necessary to configure permissions for docker on wsl. This is done only once after installing docker. (see https://stackoverflow.com/questions/72528606/docker-rancher-permission-denied-when-using-docker-from-wsl)

sudo addgroup --system docker
sudo adduser $USER docker
newgrp docker
sudo chown root:docker /var/run/docker.sock
sudo chmod g+w /var/run/docker.sock
exit

1. Enter the WSL command window:

Type wsl in the search field of the windows task bar.

On the terminal window type:

cd 
mkdir -p mhk-home
cd mhk-home
docker run -v ${PWD}:/mhk-home -it  --user "$(id -u):$(id -g)"  joaquimrcarvalho/mhk-manager mhk-install && sh app/manager init

After installation type

cd
source .bash_profile
mhk --help

1. To see the contents mhk-home in windows file explorer:

• open windows file explorer
• in the address bar type \wsl$
• open the Ubuntu folder, then the home folder and then then folder of the user created in step 2
• mhk-home folder will be found in the user folder. You can create an alias or pin it to the start menu for convenience

For more information on this see: https://devblogs.microsoft.com/commandline/access-linux-filesystems-in-windows-and-wsl-2/

On Linux (tested on CentOs )###

Make sure that user running the docker command is part of group docker (sudo usermod -a -G docker $USER)

On a terminal window do:

mkdir -p mhk-home
cd mhk-home
docker run -v ${PWD}:/mhk-home -it  --user "$(id -u):$(id -g)"  joaquimrcarvalho/mhk-manager mhk-install && sh app/manager init

After installation

Test if the install was successful in a new terminal window :

mhk --version

Starting and stopping MHK

To start MHK after the install do

mhk up

Point your browser to http://localhost:8080/mhk2019

To stop:

mhk stop

To check if MHK components are running:

mhk ps

For more MHK commands:

mhk --help