Author: inblockio / 23. August 2021
Installation for Linux (Tested in Ubuntu 20.04) of your Personal Knowledge Container
This should work for other environments like Windows and Mac if the requirements are met.
Recommended hardware requirements:
- x86_64 architecture with
- 1 CPU 2.2 GHZ
- 1 GB RAM
- 8 GB SSD Harddrive (do more to store media files)
- Install git, for Ubuntu:
sudo apt-get install git - Install docker.
- for macOS
- for Ubuntu
- for Windows, note: be sure you have WSL 2 installed first.
- Clone this repo:
git clone https://github.com/inblockio/micro-PKC
cd micro-PKC- Run
./pkc setup --wallet-address <your wallet address>
If you want to install the PKC so that it is publicly accessible from the web:
- Register your subdomains, e.g.
pkc.yourdomain.comandeauth.yourdomain.comto the public IP address of your server - Run
./pkc setup --web-public --wallet-address <your wallet address> --server <mediawiki.domain> --eauth-server <eauth.domain> --le-email <[email protected]>
Other flags:
./pkc setup --privateis setting the wiki into private mode by default. Except the main page all pages will not be visible to not registered users../pkc setup --empty-wikiwill not pre-populate the wiki from https://github.com/inblockio/PKC-Content which includes default pages for how to use the PKC and other helpful resources../pkc nukeis a command which deletes the mountpoint (the persistent data) and deletes the current instances of the docker containers.
Test if deployment was successful:
Go to localhost:9352 and see if you can open your 'Personal Knowledge Container'
If the special pages work, congratulations! You successfully deployed PKC!
- You have the choice to use the command line verification tool or the online-chrome extension (recommended) to verify your page.
- Visit https://github.com/inblockio/data-accounting-external-verifier for the command line tool.
- Visit https://github.com/inblockio/VerifyPage for the chrome extension.
Keep in mind that this software is in alpha-release stage. Please report bugs and issues back to us.
Those repositories are automatically installed by the pkc CLI during the setup.
- MediaWiki extension https://github.com/inblockio/DataAccounting This contains all scripts and information for the 'Verified Page History' implementation. languages: PHP, JavaScript, Shell
- Dockerized PKC https://github.com/inblockio/micro-PKC For running the PKC MediaWiki including the DataAccounting extension via Docker Compose. languages: Shell, PHP, JavaScript (and Docker of course)
- Content for population of a fresh installed pkc https://github.com/inblockio/PKC-Content This contains all the content which is pulled into the PKC through the create of an initial set of pages.
- Smart Contract for Witnessing / Timestamping https://github.com/inblockio/DataSymmetry This Smart Contract is part of the infrastructure required to interact with the Ethereum network for time-stamping and 'proof of existence' of a set of verified page fields.
- Backup-Script for PKC https://github.com/rht/MediaWiki_Backup.git This repository includes all backup and restore logic for the dockerized-mediawiki
- To install the OAuth2 Client in MW https://github.com/rht/MW-OAuth2Client This is a modified fork which does no allow new user creation.
Those repositories need to be manually set up and installed. For more details visit each repository.
- CLI page verifier https://github.com/inblockio/data-accounting-external-verifier A CLI JavaScript client for verifying DataAccounting pages. languages: JavaScript
- Chrome extension https://github.com/inblockio/VerifyPage which wraps the CLI page verifier. This is used to remotely interface and verify with servers which integrate the verification protocol. languages: TypeScript, HTML
- Authentication server for ethereum wallets via OAUTH2 pelith/node-eauth-server
- Custom build mediawiki image based on the standard MediaWiki docker image fantasticofox/docker-aqua-mediawiki
- A mariadb database container as a database endpoint for the above services xlp0/mariadb