UserKBDeployment

---

To enable Personalized Data Ownership, this project provides the deployment guidance to allow inviduals install and maintain MediaWiki Knowledge Stores on Laptop or Personal Desktops.

The goal is to help indivdual users to operate a full-featured MediaWiki service as a document server that contains all key-value paired references to personalized knowledge content.

Users will need to follow the instructions below to install relevant solftware from scratch. Based on our current test results, Mac OS X, Windows 10, and Linux Ubuntu should be able to run this configuration. To ensure portability, this project uses Virtualbox, Vagrant, and Docker. So that it standardizes configuration using standardized Docker images. Overtime, this project will deploy these Docker Services on Kubernetes. So that individual users can try out a cluster of services on personal desktops or laptops, and eventually deploy to the cloud.

---

Host Machine Software Installation

Install VirtualBox (Tested with 6.1.18)

Please go to the following link and download appropriate installation binary for your platform. VirtualBox Download.

Install Vagrant

After VirtualBox installation, please install Vagrant: Vagrant Download

Install Git

Your system must have Git installed. Therefore, please go to the website to install Git. Git Installation

Grab code from Git, and Execute the installation activities

Working from this Project Directory

After Git has been installed on your local system, please go to a command line interface (CLI), and use Git to download the this project. To a local directory.

git clone https://github.com/benkoo/UserKBDeployment.git

Then, "change directory" (type "cd" in Command Line Prompt) to the top level directory of this project. On Mac, a typical CLI would be the Terminal.app. On Windows 10, one should use GitBash. On Linux platforms, use the proper command line tool and type the following command:

cd UserKBDeployment

Launch vagrant processes

In the top level working directory, there is a text file named: "VagrantFile". This file contains the configuration information regarding how to download and launch a VirtualBox Ubuntu instance.

You may trigger this sequence of actions using the following command:

vagrant up

Note: Windows users might witness some hickups after Vagrant is installed. When running vagrant up, it might provide a message saying that your Hyper-Visor or VT-x options is disabled. You might need to go to BIOS or UEFI to turn it on.

The sequence in rebooting your Windows machine and changing the BIOS or UEFI configurations can be found here: Rebooting Windows into BIOS/UEFI

Use ssh to get into the Ubuntu-Linux instance running on VirtualBox

After Vagrant launched the Ununtu-Linux intance successful, please use the following instruction to get into the Ubuntu-Linux instance:

vagrant ssh

This should take you to the "vagrant" directory in that Ubuntu instance.

Note: Windows users are likely to face the issue of "$\r command not found" error message when executing script files. This is due to the incompatible end of line symbol set between Windows and other Unix variants. To resolve this problem, one needs to install dos2unix command on Linux, and run dos2unix on the script files.

Please type in the following command in a Command Line Interface on Windows environment, within the vagrant-Linux command prompt:

sudo add-apt-repository universe
sudo apt update && sudo apt install dos2unix
# Then, go to the directory that contains script files, run the following command.
sudo dos2unix *.sh

Some useful references can be found here: Ask Ubuntu's Answer on End of Line problems

Launch the installation script in the InstallationScript directory

To ease the installation process, this instance of Ubuntu-Linux already has access to your host machine's directory: InstallationScript.

This installation script will copy the initialData.zip in the vagrant_data/ directory to Ubuntu-Linux's /data directory and decompress all the data content into /data/initialData/ directory. Please run the following commands to install Docker and other relevant software in your Ubuntu-Linux system.

cd data
./installDockerAndOtherSoftware.sh

Launch MediaWiki from Command Line

Once Docker and other supporting software has been installed, just run the following command to start MediaWiki. Note that it will first install MariaDB, and then MediaWiki, it will take a while.

./up.sh

Exception Handling

Due to the massive size (about 2Gb +) of softwrae downloads, the download procedure might hang, if it waits for too long, just use the following command to stop the download process, and relaunch the "./up.sh" command.

service docker stop

References(All links' references are stored under this hidden portion of the page.)