Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 4.41 KB

README.md

File metadata and controls

61 lines (36 loc) · 4.41 KB

Semantic Mediawiki Docker Images

deploy

A project to continuously release Docker images that are pre-installed with MediaWiki and the Semantic MediaWiki extension. Basic checks are run to verify we're using the latest stable versions of dependencies and that the extension is working correctly.

Releases are on DockerHub.

Reach out for support @kabircreates, or post issues directly to the Github repo.

Docker Usage

A lot of the installation mess is abstracted away in released Docker images, but unfortunately there's still a lot to do after pulling one.

If you want to just play around with a pre-configured, SQLite-based minimal install and skip these steps, you can pull a demo image. It's not recommended that you deploy it anywhere without properly load testing it.

  1. Pull an image from the repository. e.g with: docker pull naimkabir/semantic-mediawiki:3.2.3
  2. Run the image in order to stand up the MediaWiki instance. e.g with: docker run --name smw -d -p 8080:80 naimkabir/semantic-mediawiki:3.2.3. By default, the port MediaWiki talks on is port 80, and we map a host port to it.
  3. Configure MediaWiki by either going through the MediaWiki installer process, or by docker cping in a LocalSettings.php that you already have available. You can also docker exec into a running container to run a manual install.
  4. Enable semantics! You must add a line to LocalSettings.php that looks like: wfLoadExtension('SemanticMediaWiki'); enableSemantics('{YOUR_WIKI_SERVER}');. Note: pre-SMW 4.0.0 you should only add enableSemantics('{YOUR_WIKI_SERVER}').
  5. Run maintenance. As with all MediaWiki upgrades, you must run maintenance with php maintenance/update.php in the root directory of the MediaWiki project.
  6. Verify the install. You should be good to go, but you can follow these steps to verify a correct install.

Updating Versions

The primary purpose of this repo is to release containers with stable installations of Semantic Media Wiki for each release. We also want to use the latest acceptable versions of all dependencies.

This is currently done via a janky-but-functional method of software version-tracking and rebuilding Docker containers. If you see that one of these dependencies is out-of-date, you can follow these steps to release a new container to DockerHub:

  1. Clone this repo: git clone https://github.com/NaimKabir/semantic-mediawiki.git.
  2. Checkout a new branch.
  3. In your branch, update versions in versions.jinja in the directory root.
  4. In your branch, run ./update_versions.py in the directory root. When you git diff you should see relevant changes. This step will require you to install python dependencies, e.g with pip install -r requirements.txt.
  5. Push your branch with this repo as the upstream source, and open a Pull Request (PR). This will trigger tests. If they pass and the PR is approved, it will be merged to master. Upon merge, a new container will be built and released.

Tests

To ensure a correct install I run phpunit tests that come packaged with the Semantic MediaWiki install.

The test suites I run are:

  1. semantic-mediawiki-unit
  2. semantic-mediawiki-integration
  3. semantic-mediawiki-check
  4. semantic-mediawiki-structure

I exclude some tests that are failing on Semantic MediaWiki master, but my testing should at the very least help protect against regressions. For details on what tests are run (and which are hackily excluded), you can check out the container/tests directory.

You can run them with: bazel test //.... This will require Bazel, which I like installing with Bazelisk.

In addition I also do some basic checks for loaded extensions and proper dependency versions.