wikibase/quickstatements repository overview

⁠Wikibase Suite (WBS) QuickStatements Docker Image

QuickStatements⁠ is a tool to batch-edit Wikibase⁠.

This image contains QuickStatements and the required Magnustools library. It is ready to be connected to MediaWiki OAuth on a Wikibase Docker Image.

⁠Setup

⁠1) Provision the supporting services and configuration

• MediaWiki/Wikibase instance Enable the OAuth extension⁠. We recommend the Wikibase Docker Image⁠, which is the image used in our tests. Other MediaWiki installations with the Wikibase and OAuth extensions should work but require manual setup.

• OAuth consumer Configure QuickStatements as an OAuth consumer on your Wikibase instance. For a manual setup, create the 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
  

  Copy

  Pass the resulting consumer key and secret to this container using OAUTH_CONSUMER_KEY and OAUTH_CONSUMER_SECRET.

• Reverse proxy If QuickStatements and Wikibase run on the same IP address, use a reverse proxy to route requests to the correct service based on the URL. The docker-compose.yml file in the full Wikibase Suite (WBS) configuration⁠ includes a reverse proxy setup using Traefik⁠.

• DNS resolution Make QuickStatements and Wikibase accessible through DNS domain names from both the Docker network and the user's browser so OAuth authorization works. The simplest approach is to connect both services to the internet and use public DNS domain names.

⁠2) Set the environment variables

Variables in bold are required.

⁠Troubleshooting

⁠Known limitations

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

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

⁠OAuth errors

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

The following paths can be used to extend this image. See the Dockerfile⁠ for its source.

⁠Releases

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

See the image changelog⁠ for release notes. Documentation at previous releases is preserved in the repository under the corresponding quickstatements@… tag⁠.

This image uses the shared tag format for WBS Docker Images. See WBS Versions⁠.

⁠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.