Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 1.79 KB

README.md

File metadata and controls

59 lines (34 loc) · 1.79 KB
Raw

transferbot

A Docker image providing a command that transfers entities from a source to a target wiki.

Usage

docker run --rm ghcr.io/wbstack/transferbot \
	-e CALLBACK_ON_SUCCESS="echo 'this worked'" -e CALLBACK_ON_FAILURE="echo 'this failed'" \
	https://source.wikibase.cloud https://target.wikibase.cloud Q1 P1 Q2

Positional arguments to be passed are:

  1. The origin of the source wiki
  2. The origin of the target wiki
  3. (variadic) A whitespace separated list of entities to be transferred

Specifying entity ids

An entity ID can be given in the format Q1, which looks up the latest revision. If you append a revision ID using @ like Q1@123, the given revision ID will be used for this entity.

Providing credentials

OAuth 1.0 credentials for the target wiki are provided using the following environment variables:

TARGET_WIKI_OAUTH_CONSUMER_TOKEN (required)

The OAuth consumer token used for authenticating against the target wiki.

TARGET_WIKI_OAUTH_CONSUMER_SECRET (required)

The OAuth consumer secret used for authenticating against the target wiki.

TARGET_WIKI_OAUTH_ACCESS_TOKEN (required)

The OAuth access token used for authenticating against the target wiki.

TARGET_WIKI_OAUTH_ACCESS_SECRET (required)

The OAuth access secret used for authenticating against the target wiki.

Running commands after the script has finished

It's possible to provide commands that should be run when the script has finished.

CALLBACK_ON_SUCCESS (optional)

If a value is set for this key, its content will be executed in case the script exits 0.

CALLBACK_ON_FAILURE (optional)

If a value is set for this key, its content will be executed in case the script exits non-zero.

This work is distributed under the BSD 3-Clause license.