Windows 10 PKC Installation

From PKC
Revision as of 16:35, 20 August 2021 by Benkoo (talk | contribs) (→‎Caveats)
Jump to navigation Jump to search

For Windows 10, you need to use Command Prompt.

Download PKC to your local machine

Once you had Git and Docker installed on your Windows 10 machine, you may launch Command Prompt and see the following prompt:

C:\Users\userName\Workspace>

Download the entire package using the git command. You may copy the instruction (after the > sign) as follows:

C:\Users\userName\Workspace>git clone https://github.com/benkoo/PKC.git

Caveats

Thanks to Mitch Altman, he identified the following scenarios, which indicate that Windows users will face many unexpected problems during installation, the following lists are some important ones.

Choosing adequate directories

Make sure that you don't pick a directory outside of your usual Users/Documents directory. If you choose some directories outside of your User/Documents directory, it is possible that certain batch script commands will stop to work, due to file right access authority issues.

GNU TAR might not work

We found that tar command may not work on certain machines. Therefore, we put a file unzip.exe in the resources directory. We also made sure that a initial data package, namely mountPoint.zip is included in the resources directory, so that the up.bat script will be able to conduct the automatic installation and initial launch process completely.

Kick off the microservice launch process

  1. After the git clone instruction copied relevant data to your working directory, using the command cd to the PKC directory that contains the script up.sh, and type: up.sh to execute the script. Note that Windows 10 requires the script command to be up.sh, not ./up.sh.
C:\Users\userName\Workspace>cd PKC
C:\Users\userName\Workspace\PKC>up.sh
  1. After you submitted the up.sh in your command prompt, you will need to launch one more command to make Semantic MediaWiki work properly.
  2. Depends on your network connection, this process will download around 3GB of data, so that it will take a while.

Copy and paste the following command to your command prompt.

docker exec pkc_mediawiki_1 php /var/www/html/maintenance/update.php
  1. It will first wait for 5 seconds before updating content in the database, so that the whole process will take up to a minute to finish.
  2. Open a browser: type the following URL to the browser's URL field: http://localhost:9352.