Wikipédia:WPCleaner/Installation
WPCleaner
Informations générales sur WPCleaner. |
Discussion (en)
Discussion sur WPCleaner et questions sur son fonctionnement. |
Typos
Suggestions d'orthographe et de typographie gérées par WPCleaner. |
Aide à l'utilisation de WPCleaner. |
Installation
Installation de WPCleaner. |
WPCleaner est un outil de maintenance corrective, développé en Java 8+, qui s'installe avec getdown. Le programme d'installation est hébergé sur WMFLabs depuis la version 2.0 de WPCleaner[a].
Prérequis
[modifier le code]WPCleaner nécessécite Java, au minimum en version 8 (Java 17 ou plus est fortement recommandé) : téléchargement.
Installation de WPCleaner avec le programme d'installation
[modifier le code]La méthode la plus simple pour installer WPCleaner est d'utiliser le programme d'installation dédié (Note: n'hésitez pas à m'indiquer le résultat de votre installation sur la page de discussion de WPCleaner).
Effectuer les actions suivantes pour l'installation :
- Télécharger le programme d'installation depuis WMFLabs (ne pas s'inquiéter en cas de warning, les fichiers
.jar
sont souvent considérés comme des fichiers exécutables, ce qu'ils sont) - Démarrer le programme d'installation (si Java est correctement installé et configuré, ouvrir le fichier jar téléchargé devrait démarrer le programme d'installation)
- Fournir les informations demandées pour la configuration :
- Répertoire d'installation : choisir le répertoire dans lequel sera installé WPCleaner. Note: Eviter de choisir un répertoire dans un répertoire protégé par des droits particuliers (comme
C:\Program Files
ouC:\Program Files (x86)
sous Windows). - Wiki : le wiki auquel vous voulez vous connecter par défaut.
- Langue : la langue dans laquelle vous souhaitez utiliser WPCleaner.
- Nom d'utilisateur : votre nom d'utilisateur (optionnel).
- Mot de passe : votre mot de passe (optionnel).
- Choisir si vous voulez que le programme d'installation crée un raccourci pour WPCleaner. Si le nom d'utilisateur et le mot de passe ont été saisis, ce raccourci lancera WPCleaner avec ces informations. Note: La création de raccourcis ne marche que pour certains systèmes d'exploitation.
- Choisir si vous voulez installer la version de test de WPCleaner (ne choisir cette option que si vous souhaitez tester une fonction en cours de développement)
- Répertoire d'installation : choisir le répertoire dans lequel sera installé WPCleaner. Note: Eviter de choisir un répertoire dans un répertoire protégé par des droits particuliers (comme
- Cliquer sur le bouton d'installation et attendre la fin de cette dernière.
Note: Cette procédure utilise, en interne, la procédure d'installation avec getdown, ce qui permettra de bénéficier des mises à jour automatiques par la suite.
Installation de WPCleaner avec getdown
[modifier le code]Une autre manière d'installer WPCleaner utilise getdown, un outil indépendant, dédié à l'installation et à la mise à jour automatique de programmes Java. Cette installation permettra ensuite de mettre à jour automatiquement WPCleaner à chaque démarrage.
Effectuer les actions suivantes pour l'installation :
- Créer un répertoire dédié pour WPCleaner (noté
[Répertoire]
dans la suite des explications). Note : Eviter de créer ce répertoire dans un répertoire protégé par des droits particuliers (commeC:\Program Files
ouC:\Program Files (x86)
sous Windows). - Télécharger dans ce répertoire les fichiers suivants :
- getdown.txt (si votre navigateur affiche le contenu du fichier plutôt que vous proposer de le télécharger, vous pouvez par exemple faire un clic droit sur le lien et utiliser une option telle que "Sauver le lien sous…")
- getdown.jar (ne pas s'inquiéter en cas de warning, les fichiers
.jar
sont souvent considérés comme des fichiers exécutables, ce qu'ils sont)
- Pour finaliser l'installation[b] :
- Sous Windows :
- Ouvrir une invite de commande (cmd[1] ou PowerShell)
- Se placer dans le répertoire créé (commande
cd [Répertoire]
, par exemplecd C:\Users\Toto\WPCleaner
) - Exécuter la commande
java -version
pour s'assurer que Java est bien installé et que la version utilisée est au moins égale à 1.8 - Exécuter la commande
java -jar [Répertoire]\getdown.jar [Répertoire]
(par exemple,java -jar C:\Users\Toto\WPCleaner\getdown.jar C:\Users\Toto\WPCleaner
- Sous Linux :
- Ouvrir une invite de commande (Terminal, Shell)
- Se placer dans le répertoire créé (commande
cd [Répertoire]
, par exemplecd /home/toto/WPCleaner
) - Exécuter la commande
java -version
pour s'assurer que Java est bien installé et que la version utilisée est au moins égale à 1.8 - Exécuter la commande
java -jar [Répertoire]/getdown.jar [Répertoire]
(par exemple,java -jar /home/toto/WPCleaner/getdown.jar /home/toto/WPCleaner
)
- Sous Mac OS :
- Installer le JDK 10[c].
- Ouvrir une invide de commande (Applications → Utilitaires → Terminal)[2].
- Se placer dans le répertoire créé (commande
cd [Répertoire]
, par exemplecd ~/Applications/WPCleaner
) - Exécuter la commande
java -version
pour s'assurer que Java est bien installé et la version utilisée au moins égale à 1.8 - Exécuter la commande
java -jar [Répertoire]/getdown.jar [Répertoire]
(par exemple,java -jar ~/Applications/WPCleaner/getdown.jar ~/Applications/WPCleaner
)
- Sous un autre système d'exploitation, c'est probablement très similaire à l'installation sous Linux
- Sous Windows :
- Getdown récupère alors tous les fichiers nécessaires à l'utilisation de WPCleaner, et le démarre.
Vous avez la possibilité de personnaliser l'installation de WPCleaner pour en simplifier l'usage ultérieur :
- Créer des raccourcis pour démarrer WPCleaner[d]
- Créer un fichier contenant vos informations de connexion (
credentials.txt
: remplacer les informations entre crochets par les bonnes valeurs) :
Syntaxe générale | Exemple |
---|---|
user=[Nom d'utilisateur]
password=[Mot de passe]
|
user=NicoV
password=MonMotDePasse
|
- Créer des scripts personnalisés
- Créer un fichier
extra.txt
dont chaque ligne correspond à une option ajoutée à la JVM utilisée par WPCleaner (par exemple, pour augmenter la mémoire maximale à 8G, créer ce fichier avec la ligne-Xmx8192M
) - Note : les fichiers téléchargés par getdown ne doivent pas être modifiés, car toute modification serait écrasée au prochain démarrage de WPCleaner.
Usage
[modifier le code]Pour démarrer l'interface graphique de WPCleaner (je vous conseille de créer un raccourci[d]), vous pouvez :
- Sous Windows :
- Double cliquer sur
WPCleaner.bat
- Exécuter la commande
WPCleaner.bat -credentials credentials.txt fr
pour que WPCleaner se connecte automatiquement à Wikipédia en français (fichiercredentials.txt
à créer au préalable) - Exécuter la commande
WPCleaner.bat fr [NumUtilisateur] [MotDePasse]
pour que WPCleaner se connecte automatiquement à Wikipédia en français
- Double cliquer sur
- Sous Linux :
- Dans un gestionnaire de fichiers, double-cliquer sur
WPCleaner.sh
[e] ou, dans un terminal, taperWPCleaner.sh
(puis <Enter>) après vous être positionné dans le répertoire de WPCleaner (commandecd [Répertoire]
, par exemplecd /home/toto/WPCleaner
) - Exécuter la commande
WPCleaner.sh -credentials credentials.txt fr
[e] pour que WPCleaner se connecte automatiquement à Wikipédia en français (fichiercredentials.txt
à créer au préalable) - Exécuter la commande
WPCleaner.sh fr [NumUtilisateur] [MotDePasse]
[e] pour que WPCleaner se connecte automatiquement à Wikipédia en français
- Dans un gestionnaire de fichiers, double-cliquer sur
- Sous tous les environnements (Windows, Linux ou autre) :
- Exécuter la commande
java -jar getdown.jar .
depuis le répertoire d'installation (Noter le «.
» à la fin de la commande qui est obligatoire) - Exécuter la commande
java -jar getdown.jar . client -credentials credentials.txt fr
depuis le répertoire d'installation pour que WPCleaner se connecte automatiquement à Wikipédia en français (fichiercredentials.txt
à créer au préalable) - Exécuter la commande
java -jar getdown.jar . client fr [NomUtilisateur] [MotDePasse]
depuis le répertoire d'installation pour que WPCleaner se connecte automatiquement à Wikipédia en français
- Exécuter la commande
Pour démarrer WPCleaner en mode bot sans interface graphique (traitement de tâches spécifiques), se reporter au fichier Bot.bat
ou Bot.sh
pour des explications sur les paramètres à utiliser.
Diagnostic des problèmes
[modifier le code]Ce chapitre essaie de donner des réponses pour quelques problèmes pouvant se produire durant l'installation.
Version de Java
[modifier le code]Même en ayant installé un Java 8 (ou une version plus récente) sur votre ordinateur, il est possible que la version utilisée par l'invite de commande soit plus ancienne. Vous pouvez voir ce problème à plusieurs étapes du processus d'installation :
- Quand vous exécutez la commande
java -version
, la version indiquée est inférieure à 1.8 - Quand vous exécutez la commande d'installation avec getdown, vous obtenez une exception "UnsupportedClassVersionError" indiquant "Unsupported major.minor version 51.0" (version 51.0 est pour Java 7, 52 pour Java 8)
Dans tous les cas, ceci signifie que l'invite de commande utilise une ancienne version de Java. Vous pouvez soit désinstaller l'ancienne version de Java, soit vous assurer que l'invite de commande utilise bien la nouvelle version.
Pour l'installation sous Mac, il semble que ce soit un problème connu (voir cette discussion), mais installer un JDK 10 devrait régler le problème.
Sécurité
[modifier le code]WPCleaner a besoin de votre identifiant Wikipédia et de votre mot de passe pour lire et modifier les articles sur lesquels vous voulez travailler. Pour tester WPCleaner (mais sans possibilité d'enregistrer vos modifications), vous pouvez utiliser le mode Démo sans fournir de mot de passe.
Pour un mot de passe avancé avec double authentification, consulter le guide BotPasswords[f].
Configuration réseau avancée
[modifier le code]Si votre ordinateur dispose d’une configuration réseau particulière (proxy, ...), il peut être nécessaire de configurer les accès réseau pour WPCleaner[3].
Boîte utilisateur
[modifier le code]Si vous voulez afficher sur votre page utilisateur que vous utilisez WPCleaner, vous pouvez utiliser la BU {{Utilisateur WPCleaner}} :
Ou l'icône de titre {{Icône WPCleaner}}.
Changer d'ordinateur
[modifier le code]Sous Windows, WPCleaner enregistre la plupart de ses paramètres dans la base de registre. Si vous changez d'ordinateur et souhaitez conserver vos paramètres, vous pouvez simplement copier la partie concernée de la base de registre de votre ancien ordinateur vers le nouveau.
Pour copier vos paramètres d'un PC Windows vers un autre PC Windows, vous pouvez utiliser Regedit :
- Démarrez Regedit
- Sélectionnez le dossier HKEY_CURRENT_USER\Software\JavaSoft\Prefs\org\wikipediacleaner
- Cliquez sur Fichier > Exporter…
- Saisissez un nom de fichier et cliquez sur Enregistrer
- Copiez le fichier .reg de l'ancien PC vers le nouveau
- Sur le nouveau PC, cliquez droit sur le fichier .reg et choisissez Fusionner
- À la question "Etes-vous sûr de vouloir continuer ?", répondez Oui
- Une fois que la fusion est terminée, cliquez sur OK
Sous Mac et Linux, les paramètres sont enregistrés dans un fichier, qui pourra facilement être copié sur un autre PC Mac ou Linux.
Voir aussi
[modifier le code]- Aide de WPCleaner
- Compatibilité des expressions régulières d'AutoWikiBrowser dans WPC
- Dans la base de registre de Windows, RegEdit, la clé
Computer\HKEY_CURRENT_USER\Software\JavaSoft\Prefs\org\wikipediacleaner
contient les options de WPCleaner - Bots : WikiCleanerBot (d · c · b) dressé par NicoV (d · c · b)
Notes et références
[modifier le code]Notes
[modifier le code]- Les versions antérieures à la 2.0 devront être désinstallées car elles ne sont plus mises à jour.
- Selon la configuration de votre ordinateur, il est possible que vous ayez besoin de configurer votre parefeu pour autoriser
javaw.exe
à communiquer avec l'extérieur afin qu'il puisse récupérer WPCleaner. - Sous Mac OS, des problèmes existent avec les versions de Java antérieures.
- Des icônes sont fournis dans le répertoire d'installation,
WPCleaner.ico
pour Windows etWPCleaner.png
pour Linux et autres systèmes. - Pour fonctionner, il faut que le script ait les droits en exécution, ce qui n'est pas possible automatiquement avec getdown. Après la première installation (et après chaque éventuelle mise à jour qui concerne ce fichier), il est nécessaire de donner les droits en exécution à ce fichier avec la commande
chmod a+x WPCleaner.sh
). - FAQ : Authentification à 2 facteurs.