This is a code extension for MediaWiki to implement the Aqua Protocol.
This is done by using the following modules:
Revisions can be interlinked by immutable links. This leads to links which are pointing to a revision verification hash. This allows to verify if the data which was linked is exactly the data which is seen from the user or machine visiting the link.
Follow the documentation of mediawiki to install the extension. https://www.mediawiki.org/wiki/Manual:Extensions#Installing_an_extension
Requirements:
git clone https://github.com/inblockio/mediawiki-extensions-Aqua
into the mediawiki-extenions folder
Add wfLoadExtension( 'DataAccounting' );
to the Localsettings.php to load the extension.
This is subject to change https://github.com/inblockio/mediawiki-extensions-Aqua/issues/343.
Add wfLoadExtension( 'mediawiki-extensions-Aqua' );
if it's already the new directory path.
This extension implements the recommended entry points of Wikimedia CI for PHP and Front-end projects.
Run composer update
in the extensions/mediawiki-extensions-Aqua/
directory. This pulls in code analysis tools.
You might want to mark extensions/mediawiki-extensions-Aqua/vendor/
as excluded in your IDE or tools to avoid
them loading certain libraries twice.
You can use the Makefile
by running make commands in the mediawiki-extensions-Aqua
directory.
make ci
: Run everything - TODO: include front-end testsmake test
: Run all tests - TODO: include front-end testsmake cs
: Run all style checks and static analysisSee the Makefile
contents for all commands and how to run them without Make.
To run the checks for JavaScript, JSON, and CSS:
npm install
This will install testing software to node_modules/
in the current directory/
Now, run npm test
to run the automated front-end code checks.
Login to docker 'docker exec -it pkc_database_1 bash' to enter the docker commandline. Access MYSQL Database: Inside the bash prompt: 'mysql -u wikiuser -p my_wiki' and enter your password which you can find in the dockercompose.yml file. SHOW DATABASES; USE my_wiki; SELECT FROM revision_verification; SELECT FROM page_witness;
If the extension is running and working, you will see entries in revision_verification after doing your first page edits with the extension activated.
If you wan't to test a branch by using our current deployment pipe-line (GitHub autobuild actions) use the following steps:
Known Limitations: