Wikibase/Docker

This page is a translated version of the page Wikibase/Docker and the translation is 100% complete.
Ce document décrit l'installation basée sur Docker de la suite Wikibase. Pour les instructions concernant l'installation manuelle de la suite Wikibase, voir Wikibase/Suite . Pour installer uniquement l'extension Wikibase, voir Wikibase/Installation .

Vue d'ensemble

 
Wikibase Cloud Vertical 2x RGB

Ceci est un guide pas à pas pour installer la suite Wikibase sur votre propre ordinateur en utilisant Docker.

Nos images Docker contiennent une installation complète de MediaWiki et de Wikibase, et le processus d'installation est paramétrable en fonction de vos besoins.

Préparer votre environnement

Terminez toutes ces étapes avant de commencer l'installation de Wikibase.

Installer Docker

Sur l'ordinateur où vous souhaitez exécuter Wikibase, installez d'abord Docker.

Si vous avez besoin de plus d'aide sur les instructions propres à Docker, vous pouvez consulter les tutoriels tiers pour Linux, Mac et Windows.

Vérifier les fichiers

Copiez le dépôt pipeline de Wikibase à partir de GitHub pour obtenir les fichiers d'exemples de configuration. La dernière version est wmde.16, donc exécutez les commandes suivantes :

git clone https://github.com/wmde/wikibase-release-pipeline
cd wikibase-release-pipeline
git checkout tags/wmde.16

Préparer vos fichiers

Créez un nouveau répertoire de démarrage à partir duquel vous allez exécuter Docker. Gardez à l'esprit que ce répertoire figurera dans le nom de vos conteneurs Docker. Pour cet exemple, nous allons créer le répertoire « wbdocker ».

mkdir $HOME/wbdocker
cp -r example/* $HOME/wbdocker
cd $HOME/wbdocker
mv template.env .env

Personnaliser votre environnement

Le fichier .env contient les variables d'environnement qui gèrent l'installation de Wikibase. Vous devrez modifier ce fichier et changer l'information sur les lignes spécifiques comme ci-après.

Configuration de MediaWiki

  • MW_ADMIN_NAME
  • MW_ADMIN_PASS
  • MW_ADMIN_EMAIL

Ces valeurs définissent le nom d'utilisateur, le mot de passe et l'adresse courriel de l'utilisateur administrateur de votre nouvelle installation MediaWiki. Vous utiliserez ce nom d'utilisateur et le mot de passe, pour vous connecter dans l'interface web de votre nouvelle instance pour la première fois; l'adresse courriel que vous donnez vous permettra de remettre à jour votre mot de passe si nécessaire. The password must be at least 10 characters and must not appear in the list of CommonPasswords .

Cette clé secrète doit être unique; MediaWiki l'utilise à différentes fins (comme la gestion des sessions, la source du repli de l'entropie cryptographique). Suivre le lien pour les informations complémentaires. Pour générer une chaîne aléatoire à utiliser dans ce fichier :

echo -n "MW_SECRET_KEY="
tr -dc 'A-Za-z0-9@#%^+_-' </dev/urandom | head -c 64 ; echo ''

Configuration de la base de données

  • DB_NAME
  • DB_USER
  • DB_PASS

Ces valeurs contrôlent le nom de la base de données que MediaWiki utilisera, ainsi que le nom d'utilisateur et le mot de passe de la base de données. Au minimum, modifiez simplement DB_PASS :

echo -n "DB_PASS="
tr -dc 'A-Za-z0-9@#%^+_-' </dev/urandom | head -c 32 ; echo ''

Configuration de Wikibase

Par défaut la fonctionnalité du pingback sur Wikibase est désactivée. Veuillez activer cette fonctionnalité (qui n'envoie que des données anonymes) en remplaçant false par true.

En activant cette fonctionnalité vous augmentez la vision de Wikimedia Deutschland sur la manière dont Wikibase est utilisé, ce qui nous renseigne sur les décisions à prendre concernant le planning du développement. Pour d'autres informations, veuillez lire notre sujet documentant le pingback.

Paramètres HOST

  • WIKIBASE_HOST=wikibase.svc
  • WIKIBASE_PORT=80
  • WDQS_FRONTEND_HOST=wdqs-frontend.svc
  • WDQS_FRONTEND_PORT=8834
  • QUICKSTATEMENTS_HOST=quickstatements.svc
  • QUICKSTATEMENTS_PORT=8840
  • MW_ELASTIC_HOST=elasticsearch.svc
  • MW_ELASTIC_PORT=9200

Ces lignes définissent le nom de l'hôte et le port de votre Wikibase (ce que vous devez mettre dans la barre d'adresse de votre navigateur) et, de manière facultative, ceux des services externes pour une installation étendue.

Les utilisateurs du bac à sable (c'est à dire ceux qui ne veulent qu'une configuration accessible localement sur un seul ordinateur) peuvent et doivent laisser cette section inchangée.

Néanmoins si vous envisagez d'utiliser un des services externes à l'extérieur d'une configuration Docker auto incluse, vous devez initialiser WIKIBASE_HOST, WDQS_FRONTEND_HOST, QUICKSTATEMENTS_HOST et / ou MW_ELASTIC_HOST avec des noms d'hôtes accessibles publiquement — c'est à dire pouvant être résolus dans un DNS — , ou des adresses IP. Ce dernier choix peut être le meilleur si vous utilisez un réseau local.

N'utilisez jamais localhost dans les paramètres où plusieurs services séparés doivent dialoguer ensemble.

MAX_JOBS

Vous pouvez indiquer que le lanceur de tâches doit exécuter davantage de tâches entre les redémarrages en initialisant MAX_JOBS à une valeur plus grande que sa valeur par défaut (qui est 1). Voir ci-dessous les informations complémentaires sur le lanceur de travaux.

Installer et exécuter Wikibase

Maintenant que vous avez installé le logiciel nécessaire et personnalisé votre fichier d'environnement, il vous reste une chose à faire : soit réaliser une installation minimale (juste MediaWiki, une sauvegarde de la base de données MySQL et Wikibase), soit une installation étendue (MediaWiki, base de données, Wikibase, WDQS, Elasticsearch et QuickStatements).

Installation minimale

Pour une installation minimale, dans le répertoire de démarrage où vous avez copié et modifié vos fichiers, exécutez simplement :

docker-compose up -d

Installation étendue

Pour une installation étendue, dans le répertoire de démarrage où vous avez copié et modifié vos fichiers, exécutez cette commande étendue :

docker-compose -f docker-compose.yml -f docker-compose.extra.yml up -d

On some systems you will get an error message Unknown shorthand flag: 'f' in -f. In this case you need to install the docker-compose package through your package manager and run the command again.

Options

Si vous devez exécuter plusieurs lanceurs de tâches, vous pouvez ajouter l'option suivante (avec X représentant le nombre de lanceurs à exécuter) à votre commande docker compose comme dans l'exemple suivant :

docker-compose up -d --scale wikibase_jobrunner=X

Démarrage et utilisation

Vous aurez maintenant au moins deux conteneurs Docker en cours d'exécution. Pour voir les conteneurs s'exécutant, lancer docker compose ps. La sortie de l'exemple suivant correspond à l'installation étendue :

$ docker ps
NAME                         COMMAND                   SERVICE              STATUS              PORTS
wbdocker-elasticsearch-1        "/usr/local/bin/dock…"    elasticsearch        running             9300/tcp
wbdocker-mysql-1                "docker-entrypoint.s…"    mysql                running             3306/tcp
wbdocker-quickstatements-1      "/bin/bash /entrypoi…"    quickstatements      running             0.0.0.0:8840->80/tcp, :::8840->80/tcp
wbdocker-wdqs-1                 "/entrypoint.sh /run…"    wdqs                 running             9999/tcp
wbdocker-wdqs-frontend-1        "/entrypoint.sh ngin…"    wdqs-frontend        running             0.0.0.0:8834->80/tcp, :::8834->80/tcp
wbdocker-wdqs-proxy-1           "/bin/sh -c \"/entryp…"   wdqs-proxy           running             80/tcp
wbdocker-wdqs-updater-1         "/entrypoint.sh /run…"    wdqs-updater         running             
wbdocker-wikibase-1             "/bin/bash /entrypoi…"    wikibase             running             0.0.0.0:80->80/tcp, :::80->80/tcp
wbdocker-wikibase_jobrunner-1   "/bin/bash /jobrunne…"    wikibase_jobrunner   running             80/tcp
 
Interface MediaWiki pour la préconnexion de la suite Wikibase

Pour les commandes Docker orientées Wikibase un peu plus utiles, consultez la section des outils Docker de notre documentation de maintenance .

Connectez-vous à votre nouveau Wikibase en allant sur le serveur web local de votre machine.


Gestionnaire des tâches

L'exemple docker-compose.yml configure un lanceur de tâches dédié qui se redémarre lui-même après chaque tâche pour assurer que les modifications de la configuration sont pris en compte aussi rapidement que possible.

Si vous exécutez des lots importants de modifications, ce lanceur de travaux pourra éventuellement échouer dans les mises à jour. Vous pouvez accélérer les traitements en augmentant la variable MAX_JOBS de votre fichier .env (voir ci-dessus), afin de pouvoir exécuter plus de tâches entre les redémarrages. Cette modification ne prendra effet dans le lanceur de travaux qu'au prochain redémarrage de votre projet docker compose.

Si vous le souhaitez, vous pouvez aussi exécuter en parallèle plusieurs lanceurs de tâches en ajoutant l'option --scale wikibase_jobrunner=8 à la commande docker compose up. Voir la section d'Installation ci-dessus.

Liens de sites

Pour créer des liens entre MediaWiki et Wikibase, exécutez le script pour ajouter un site. Plus d'informations sur l'ajout des liens de site, sont disponibles sur la page d'aide des liens de site Wikidata et la page de configuration avancée de Wikibase.

Utiliser votre nouvelle instance

Une fois tous les services démarrés, vous pouvez commencer à remplir, étendre et personnaliser votre instance vide de Wikibase. Voir notre page d'initialisation des ressources pour commencer.

Lectures complémentaires