Skip to content

README.md

Latest commit

 

History

History
112 lines (72 loc) · 7.47 KB

README.md

File metadata and controls

112 lines (72 loc) · 7.47 KB
Raw

Wikibase Suite QuickStatements Image

QuickStatements is a tool to batch-edit Wikibase.

This image contains QuickStatements and the required Magnustools library. It is ready to be hooked up to MediaWiki OAuth on a Wikibase Suite Wikibase image.

💡 This image is part of Wikibase Suite (WBS) which provides everything you need to run a Wikibase instance on your own server.

Requirements

  • MediaWiki/Wikibase instance with OAuth enabled
  • QuickStatements set up as an OAuth consumer on MediaWiki
  • Reverse proxy (if Wikibase and QuickStatements are running on the same host)
  • DNS domain name resolution for QuickStatements and Wikibase
  • Configuration via environment variables

MediaWiki/Wikibase instance

We suggest to use the WBS Wikibase image because this is the image we run all our tests against. Follow the setup instructions over there to get it up and running.

Any MediaWiki with Wikibase and OAuth extensions should work, but the setup needs to be done manually.

OAuth consumer

QuickStatements needs to be set up as an OAuth consumer on your Wikibase instance. If you are setting up QuickStatements manually, create the OAuth consumer on Wikibase:

php /var/www/html/extensions/OAuth/maintenance/createOAuthConsumer.php \
        --approve \
        --callbackUrl  "$QUICKSTATEMENTS_PUBLIC_URL/api.php" \
        --callbackIsPrefix true --user "$MW_ADMIN_NAME" --name QuickStatements --description QuickStatements --version 1.0.1 \
        --grants createeditmovepage --grants editpage --grants highvolume --jsonOnSuccess

You can pass the consumer and secret token you got from your Wikibase instance to this container using the environment variables OAUTH_CONSUMER_KEY and OAUTH_CONSUMER_SECRET.

Reverse proxy

If QuickStatements and Wikibase are running on the same IP address, a reverse proxy is required to route HTTP requests to Wikibase or QuickStatements depending on the URL used to access them. See the example below for a reverse proxy setup using Traefik.

DNS resolution

In order to authorize QuickStatements against Wikibase via OAuth, both services need to be accessible via DNS domain names, both from within the Docker network as well as from the user's browser. The easiest way to achieve this is by connecting both Wikibase and QuickStatements to the internet and letting them use public DNS domain names.

Environment variables

Variables in bold are required.

Variable Default Description
WIKIBASE_PUBLIC_URL undefined Host and port of Wikibase as seen by the user's browser (required)
QUICKSTATEMENTS_PUBLIC_URL undefined Host and port of QuickStatements as seen by the user's browser (required)
OAUTH_CONSUMER_KEY undefined OAuth consumer key (from MediaWiki), required on initial setup, stored in /quickstatements/data.
OAUTH_CONSUMER_SECRET undefined OAuth consumer secret (from MediaWiki), required on initial setup, stored in /quickstatements/data.
WB_ITEM_NAMESPACE 120 Wikibase Item namespace
WB_PROPERTY_NAMESPACE 122 Wikibase Property namespace
WB_ITEM_PREFIX "Item:" Wikibase Item prefix
WB_PROPERTY_PREFIX "Property:" Wikibase Property prefix
PHP_TIMEZONE "UTC" setting of php.ini date.timezone
LANGUAGE_CODE "en" Site language
SITENAME "wikibase" Site name

Example

For an integrated Docker Compose example showing how this image is used in the full Wikibase Suite configuration, see deploy/docker-compose.yml.

Releases

Official releases of this image can be found on Docker Hub wikibase/quickstatements.

Versioning

This image uses the shared WBS image tag format. See Wikibase Suite image versioning.

Known issues

QuickStatements' "Run in background" option is not supported by this image.

QuickStatements' "Batches" require a database and are not supported by this image.

Troubleshooting

If you see an error such as mw-oauth exception when trying to log in, check that you have passed the correct consumer token and secret token to QuickStatements.

If you have changed the value of $wgSecretKey or $wgOAuthSecretKey since you made the consumer, you'll need to make another new consumer or reissue the secret token for the old one.

Internal filesystem layout

Hooking into the internal filesystem can extend the functionality of this image.

Directory Description
/var/www/html/quickstatements Base QuickStatements directory
/var/www/html/quickstatements/public_html The Apache root folder
/var/www/html/magnustools Base magnustools directory
File Description
/templates/config.json Template for QuickStatements' config.json (substituted to /var/www/html/quickstatements/public_html/config.json in entrypoint.sh)
/templates/oauth.ini Template for QuickStatements' oauth.ini (substituted to /quickstatements/data/oauth.ini in entrypoint.sh)
/templates/php.ini PHP config (default provided sets date.timezone to prevent php complaining substituted to /usr/local/etc/php/conf.d/php.ini in entrypoint.sh )

Source

This image is built from this Dockerfile.

Authors & contact

This image is maintained by the Wikibase Suite Team at Wikimedia Germany (WMDE).

If you have questions not listed above or need help, use this bug report form to start a conversation with the engineering team.