Difference between revisions of "PKC Data Package"

From PKC
Jump to navigation Jump to search
(Created page with "PKC Data Package is a compressed file in the tar.gz format. It contains all configuration information of a PKC. For the smallest initial data set, once DockerizedPKC...")
 
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:


For the smallest initial data set, once [[DockerizedPKC]] is cloned from Github.com, one can follow the following procedure to create a fully functional PKC Data Package from scratch.
For the smallest initial data set, once [[DockerizedPKC]] is cloned from Github.com, one can follow the following procedure to create a fully functional PKC Data Package from scratch.
# Clone DockerizedPKC from [http://github.com/benkoo/DockerizedPKC]
==Clone DockerizedPKC from Github==
Clone DockerizedPKC from [http://github.com/benkoo/DockerizedPKC]
  git clone http://github.com/benkoo/DockerizedPKC
  git clone http://github.com/benkoo/DockerizedPKC
  cd DockerizedPKC
  cd DockerizedPKC
# Temporarily comment out the volume entry of - ./mountPoint/LocalSettings.php
==Temporarily hide LocalSettings.php file from MediaWiki==
Temporarily comment out the volume entry of - ./mountPoint/LocalSettings.php in the file: <code>docker-compose.yml</code> under the <code> DockerizedPKC</code> project home directory.
  # - ./mountPoint/LocalSettings.php
  # - ./mountPoint/LocalSettings.php
# Use the following command:
==Configure your version of MediaWiki==
# Kickoff the Docker-compose process to start both database and mediawiki services:
  docker-compose up -d
  docker-compose up -d
# Use a browser and enter the URL: <code>http://localhost:9352</code>
# Use a browser and enter the URL: <code>http://localhost:9352</code>
# Go through the configuration process
# Go through the configuration process
# Download the newly generated <code>LocalSettings.php</code> file and put that file under the home of <code> DockerizedPKC</code> project
## A typical setting for PKC is shown here: [[PKC MediaWiki configuration data]]
# Download the newly generated <code>LocalSettings.php</code> file and put that file under the <code>./mountPoint</code> directory under <code> DockerizedPKC</code> project
# Stop the Docker-compose process
docker-compose down
# Uncomment the entry in <code>docker-compose.yml</code> file (take out the <code>#</code> in front of the <code>- ./mountPoint/LocalSettings.php</code> entry.
# Kickoff the Docker-compose process again to start both database and mediawiki services:
docker-compose up -d
# Use a browser and enter the URL: <code>http://localhost:9352</code>, and you should see MediaWiki running.
# After verifying the data is correct and the service are running, shutdown the service,
docker-compose down
# You must wait for the docker processes to be turn down, before your can use <code>tar -czvf</code> command to package up all the data. For Windows 10 environment, use the following command:
tar -czvf <archive.tar.gz> ".\mountPoint"
For Mac, Linux and other Unix variants, use the following command:
tar -czvf <archive.tar.gz> ./mountPoint
=Tested Data Packages=
Due to the fact that Windows 10 tends to be the most unreliable runtime environment for Docker containers, we suggest that all data packages to be eventually tested on Windows before publishing the Data Package. This place will list a Github repository that stores some of these tested files:
When the Data Package file ends with a platform name, particularly, <code>windows</code> as the last part of its file name before the <code>.tar.gz</code>, we assume that this file is tested on Windows platform.
[https://github.com/xlp0/XLPWikiMountPoint A PKC Data Package Repository on GitHub.com]

Latest revision as of 04:06, 18 August 2021

PKC Data Package is a compressed file in the tar.gz format. It contains all configuration information of a PKC.

For the smallest initial data set, once DockerizedPKC is cloned from Github.com, one can follow the following procedure to create a fully functional PKC Data Package from scratch.

Clone DockerizedPKC from Github

Clone DockerizedPKC from [1] 

git clone http://github.com/benkoo/DockerizedPKC
cd DockerizedPKC

Temporarily hide LocalSettings.php file from MediaWiki

Temporarily comment out the volume entry of - ./mountPoint/LocalSettings.php in the file: docker-compose.yml under the DockerizedPKC project home directory. 

# - ./mountPoint/LocalSettings.php

Configure your version of MediaWiki

  1. Kickoff the Docker-compose process to start both database and mediawiki services:
docker-compose up -d
  1. Use a browser and enter the URL: http://localhost:9352
  2. Go through the configuration process
    1. A typical setting for PKC is shown here: PKC MediaWiki configuration data
  3. Download the newly generated LocalSettings.php file and put that file under the ./mountPoint directory under DockerizedPKC project
  4. Stop the Docker-compose process
docker-compose down
  1. Uncomment the entry in docker-compose.yml file (take out the # in front of the - ./mountPoint/LocalSettings.php entry.
  2. Kickoff the Docker-compose process again to start both database and mediawiki services:
docker-compose up -d
  1. Use a browser and enter the URL: http://localhost:9352, and you should see MediaWiki running.
  2. After verifying the data is correct and the service are running, shutdown the service,
docker-compose down
  1. You must wait for the docker processes to be turn down, before your can use tar -czvf command to package up all the data. For Windows 10 environment, use the following command:
tar -czvf <archive.tar.gz> ".\mountPoint"

For Mac, Linux and other Unix variants, use the following command: 

tar -czvf <archive.tar.gz> ./mountPoint

Tested Data Packages

Due to the fact that Windows 10 tends to be the most unreliable runtime environment for Docker containers, we suggest that all data packages to be eventually tested on Windows before publishing the Data Package. This place will list a Github repository that stores some of these tested files: When the Data Package file ends with a platform name, particularly, windows as the last part of its file name before the .tar.gz, we assume that this file is tested on Windows platform. 

A PKC Data Package Repository on GitHub.com
Retrieved from "https://pkc.pub/index.php?title=PKC_Data_Package&oldid=9646"