WPCleaner – 2.05 (August 26, 2022 ) [±] | ||||
---|---|---|---|---|
WPCleaner
General information about WPCleaner |
Discussion
Discuss the application |
Typos
Suggestions for spelling and typography |
FAQ
Frequently asked questions |
Installation
Install instructions |
Bug report or feature request · History of changes · Configuration ( help, template) · Wikis · Languages · Users · Screenshots |
WPCleaner is a maintenance tool, developed with Java 8+. The installation program is hosted on Toolforge since release 2.0 of WPCleaner. [n 1] The minimum required version is Java 8, and it should run with any later version.
Prerequisites to install and use WPCleaner are:
The easiest way to install WPCleaner is with the dedicated installation program (Note: currently, the installation program has only been tested on a small number of computers running a Windows or Ubuntu operating system, so please report any result with your installation on WPCleaner's talk page).
The following actions are required to install WPCleaner:
.jar
files are supposed to be executable files)C:\Program Files
or C:\Program Files (x86)
on Windows).Note: This procedure is a wrapper for the installation with getdown, so the automatic updating of WPCleaner will be handled by getdown.
Another way to install WPCleaner is with getdown, an independent tool dedicated to installing and automatic updating of Java programs. This installation lets you automatically update WPCleaner at each execution.
The following actions are required to install WPCleaner:
[Path]
in the explanations). Note: Avoid creating this folder in a folder protected by specific rights (like C:\Program Files
or C:\Program Files (x86)
on Windows)..jar
files are often considered as executable files, which they are)cd [Path]
, for example cd C:\Users\Toto\WPCleaner
)java -version
to ensure that Java is properly installed and that its version is at least 1.8java -jar [Path]\getdown.jar [Path]
(for example, java -jar C:\Users\Toto\WPCleaner\getdown.jar C:\Users\Toto\WPCleaner
cd Path
, for example cd /home/toto/WPCleaner
)java -version
to ensure that Java is properly installed and that its version is at least 1.8java -jar Path/getdown.jar Path
(for example, java -jar /home/toto/WPCleaner/getdown.jar /home/toto/WPCleaner
)cd Path
, for example cd ~/Applications/WPCleaner
)java -version
to ensure that Java is properly installed and that its version is at least 1.8java -jar Path/getdown.jar Path
(for example, java -jar /home/toto/WPCleaner/getdown.jar /home/toto/WPCleaner
)
You can customize WPCleaner installation to simplify its daily usage:
credentials.txt
: replace credentials between square brackets by the correct values):General syntax | Example |
---|---|
user=[Username]
password=[Password]
|
user=NicoV
password=MyPassword
|
extra.txt
in which each line is an option added to the JVM used by WPCleaner (for example, to increase the maximum size of the memory used to 8 GB, create this file with the line -Xmx8192M
)To start the graphical interface of WPCleaner, you can using the following methods (It is advised to create a shortcut [n 3] or optionally for the Mac, an Automator script):
WPCleaner.bat
WPCleaner.bat -credentials credentials.txt en
so that WPCleaner connects automatically to the English Wikipedia (the file credentials.txt
needs to be created beforehand)WPCleaner.bat en [Username] [Password]
so that WPCleaner connects automatically to the English WikipediaWPCleaner.sh
[n 4]WPCleaner.sh -credentials credentials.txt en
[n 4] so that WPCleaner connects automatically to the English Wikipedia (the file credentials.txt
needs to be created beforehand)WPCleaner.sh en Username Password
[n 4] so that WPCleaner connects automatically to the English Wikipediajava -jar <installation folder>/getdown.jar <installation folder>
(for example, if you installed the script in /Applications/WPCleaner2, your Automator command would be java -jar /Applications/WPCleaner2/getdown.jar /Applications/WPCleaner2
)java -jar getdown.jar .
from the installation folder (Note the ".
" at the end of the command which is mandatory)java -jar getdown.jar . client -credentials credentials.txt en
from the installation folder so that WPCleaner connects automatically to the English Wikipedia (the file credentials.txt
needs to be created before hand)java -jar getdown.jar . client en Username Password
from the installation folder so that WPCleaner connects automatically to the English WikipediaTo run WPCleaner in
bot mode without any graphical interface (handling specific tasks), check the file Bot.bat
or Bot.sh
for explanations about the parameters to be used.
This section tries to give answers for a few possible problems arising during the installation.
Even if you've installed Java 8 or more recent on your computer, the one that is used in the command line may be an older one. You can see this problem at several steps in the installation process:
java -version
, the reported version can be below 1.8In each case, it means that the command line is using an older version of Java. You can either uninstall the older Java or make sure that the command line uses the newer Java.
For Mac installation, it seems to be a known problem (see this thread), but installing JDK 10 is likely to solve the problem.
WPCleaner needs your Wikipedia login and password to read and edit articles on which you want to work. To test WPCleaner, without the ability to save your modifications, you can use the Demo mode [n 5] without providing a password.
If you have activated two-factor authentication on your Wikipedia account, you need to create a bot password for WPCleaner, cf. this guide. [n 6]
If you have a special network configuration (proxy, ...), some further configuration might be required.
If you want to show on your user page that you're using WPCleaner, you can use {{
Wikipedia:WPCleaner/Userbox}}
which will add the following user box
This user is a dedicated user of WPCleaner. |
On Windows, WPCleaner stores most of its information in the Windows registry. If you change your computer and want to keep your configuration, you just need to copy the WPCleaner part of the registry from the old computer to the new one.
To copy your Windows configuration from one PC to a new PC, you can use Regedit:
For Mac and Linux, there's a preference file for WPCleaner that can be copied over to another computer that uses Linux or Mac.
javaw.exe
access to the Internet so that WPCleaner can be downloaded and run.
WPCleaner.ico
for Windows and WPCleaner.png
for Linux, Mac and other systems.
chmod a+x WPCleaner.sh
).
Unable to install Java. There are errors in the following switches...
, it's that the association of .jar files with Java is broken: the
jarfix tool may help, or you can run the installer with the following command java -jar [PATH_TO_INSTALLER]/WPCleanerInstaller.jar
sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
, it's probably that your Java version is too old and doesn't include the new root certificates for tools.wmflabs.org. Try upgrading your Java version.
WPCleaner – 2.05 (August 26, 2022 ) [±] | ||||
---|---|---|---|---|
WPCleaner
General information about WPCleaner |
Discussion
Discuss the application |
Typos
Suggestions for spelling and typography |
FAQ
Frequently asked questions |
Installation
Install instructions |
Bug report or feature request · History of changes · Configuration ( help, template) · Wikis · Languages · Users · Screenshots |
WPCleaner is a maintenance tool, developed with Java 8+. The installation program is hosted on Toolforge since release 2.0 of WPCleaner. [n 1] The minimum required version is Java 8, and it should run with any later version.
Prerequisites to install and use WPCleaner are:
The easiest way to install WPCleaner is with the dedicated installation program (Note: currently, the installation program has only been tested on a small number of computers running a Windows or Ubuntu operating system, so please report any result with your installation on WPCleaner's talk page).
The following actions are required to install WPCleaner:
.jar
files are supposed to be executable files)C:\Program Files
or C:\Program Files (x86)
on Windows).Note: This procedure is a wrapper for the installation with getdown, so the automatic updating of WPCleaner will be handled by getdown.
Another way to install WPCleaner is with getdown, an independent tool dedicated to installing and automatic updating of Java programs. This installation lets you automatically update WPCleaner at each execution.
The following actions are required to install WPCleaner:
[Path]
in the explanations). Note: Avoid creating this folder in a folder protected by specific rights (like C:\Program Files
or C:\Program Files (x86)
on Windows)..jar
files are often considered as executable files, which they are)cd [Path]
, for example cd C:\Users\Toto\WPCleaner
)java -version
to ensure that Java is properly installed and that its version is at least 1.8java -jar [Path]\getdown.jar [Path]
(for example, java -jar C:\Users\Toto\WPCleaner\getdown.jar C:\Users\Toto\WPCleaner
cd Path
, for example cd /home/toto/WPCleaner
)java -version
to ensure that Java is properly installed and that its version is at least 1.8java -jar Path/getdown.jar Path
(for example, java -jar /home/toto/WPCleaner/getdown.jar /home/toto/WPCleaner
)cd Path
, for example cd ~/Applications/WPCleaner
)java -version
to ensure that Java is properly installed and that its version is at least 1.8java -jar Path/getdown.jar Path
(for example, java -jar /home/toto/WPCleaner/getdown.jar /home/toto/WPCleaner
)
You can customize WPCleaner installation to simplify its daily usage:
credentials.txt
: replace credentials between square brackets by the correct values):General syntax | Example |
---|---|
user=[Username]
password=[Password]
|
user=NicoV
password=MyPassword
|
extra.txt
in which each line is an option added to the JVM used by WPCleaner (for example, to increase the maximum size of the memory used to 8 GB, create this file with the line -Xmx8192M
)To start the graphical interface of WPCleaner, you can using the following methods (It is advised to create a shortcut [n 3] or optionally for the Mac, an Automator script):
WPCleaner.bat
WPCleaner.bat -credentials credentials.txt en
so that WPCleaner connects automatically to the English Wikipedia (the file credentials.txt
needs to be created beforehand)WPCleaner.bat en [Username] [Password]
so that WPCleaner connects automatically to the English WikipediaWPCleaner.sh
[n 4]WPCleaner.sh -credentials credentials.txt en
[n 4] so that WPCleaner connects automatically to the English Wikipedia (the file credentials.txt
needs to be created beforehand)WPCleaner.sh en Username Password
[n 4] so that WPCleaner connects automatically to the English Wikipediajava -jar <installation folder>/getdown.jar <installation folder>
(for example, if you installed the script in /Applications/WPCleaner2, your Automator command would be java -jar /Applications/WPCleaner2/getdown.jar /Applications/WPCleaner2
)java -jar getdown.jar .
from the installation folder (Note the ".
" at the end of the command which is mandatory)java -jar getdown.jar . client -credentials credentials.txt en
from the installation folder so that WPCleaner connects automatically to the English Wikipedia (the file credentials.txt
needs to be created before hand)java -jar getdown.jar . client en Username Password
from the installation folder so that WPCleaner connects automatically to the English WikipediaTo run WPCleaner in
bot mode without any graphical interface (handling specific tasks), check the file Bot.bat
or Bot.sh
for explanations about the parameters to be used.
This section tries to give answers for a few possible problems arising during the installation.
Even if you've installed Java 8 or more recent on your computer, the one that is used in the command line may be an older one. You can see this problem at several steps in the installation process:
java -version
, the reported version can be below 1.8In each case, it means that the command line is using an older version of Java. You can either uninstall the older Java or make sure that the command line uses the newer Java.
For Mac installation, it seems to be a known problem (see this thread), but installing JDK 10 is likely to solve the problem.
WPCleaner needs your Wikipedia login and password to read and edit articles on which you want to work. To test WPCleaner, without the ability to save your modifications, you can use the Demo mode [n 5] without providing a password.
If you have activated two-factor authentication on your Wikipedia account, you need to create a bot password for WPCleaner, cf. this guide. [n 6]
If you have a special network configuration (proxy, ...), some further configuration might be required.
If you want to show on your user page that you're using WPCleaner, you can use {{
Wikipedia:WPCleaner/Userbox}}
which will add the following user box
This user is a dedicated user of WPCleaner. |
On Windows, WPCleaner stores most of its information in the Windows registry. If you change your computer and want to keep your configuration, you just need to copy the WPCleaner part of the registry from the old computer to the new one.
To copy your Windows configuration from one PC to a new PC, you can use Regedit:
For Mac and Linux, there's a preference file for WPCleaner that can be copied over to another computer that uses Linux or Mac.
javaw.exe
access to the Internet so that WPCleaner can be downloaded and run.
WPCleaner.ico
for Windows and WPCleaner.png
for Linux, Mac and other systems.
chmod a+x WPCleaner.sh
).
Unable to install Java. There are errors in the following switches...
, it's that the association of .jar files with Java is broken: the
jarfix tool may help, or you can run the installer with the following command java -jar [PATH_TO_INSTALLER]/WPCleanerInstaller.jar
sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
, it's probably that your Java version is too old and doesn't include the new root certificates for tools.wmflabs.org. Try upgrading your Java version.