wiki.techinc.nl/maintenance
Alexandre Emsenhuber a28e00cb4b Improve documentation of maintenance scripts.
Change-Id: I2433d23544e808e16f28805f93183b1af2409c94
2012-07-08 22:50:22 +02:00
..
archives At least use /*$wgDBTableOptions*/; if passed through MW 2012-05-17 23:31:35 +01:00
benchmarks Big oops - merged to wrong branch. 2012-06-05 22:58:54 +00:00
cssjanus
dev Security paranoia, reject requests to router.php that aren't from the cli-server sapi. 2012-03-20 22:58:34 +00:00
hiphop Shut up build script about not having LocalSettings. You dont actually need it for this 2011-09-01 14:09:50 +00:00
ibm_db2 (bug 5445) remove autoblocks when user is unblocked 2012-05-03 12:07:30 +02:00
language (bug 31777) Upload unknown error ``fileexists-forbidden'' 2012-07-01 19:35:31 +02:00
locking Added missing GPLv2 headers in some places. 2012-06-14 14:26:37 +02:00
mssql (bug 5445) remove autoblocks when user is unblocked 2012-05-03 12:07:30 +02:00
oracle (bug 5445) remove autoblocks when user is unblocked 2012-05-03 12:07:30 +02:00
postgres (bug 5445) remove autoblocks when user is unblocked 2012-05-03 12:07:30 +02:00
sqlite/archives Can someone standardi[sz]e SQL already!? 2012-03-06 00:26:48 +00:00
storage Bug 24985 use $wgTmpDirectory when available 2012-06-13 21:30:22 +02:00
term Added missing GPLv2 headers in some places. 2012-06-14 14:26:37 +02:00
.htaccess
7zip.inc
attachLatest.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
backup.inc Fix php4 constructor 2012-04-07 21:41:31 +01:00
backupPrefetch.inc Remove some unused getting of non existent arguments 2011-10-18 17:31:54 +00:00
backupTextPass.inc Merge "Make backupTestPass.inc require_once by itself its dependence on backup.inc Change path-less requires to full path ones." 2012-05-08 20:24:27 +00:00
cdb.php Add cdb.php for inspecting cdb cache files. Format is stolen from mcc.php 2011-04-29 22:08:58 +00:00
changePassword.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
checkAutoLoader.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
checkBadRedirects.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
checkImages.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
checkSyntax.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
checkUsernames.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
cleanupAncientTables.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
cleanupCaps.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
cleanupImages.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
cleanupPreferences.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
cleanupRemovedModules.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
cleanupSpam.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
cleanupTable.inc Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
cleanupTitles.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
cleanupUploadStash.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
cleanupWatchlist.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
clear_interwiki_cache.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
clear_stats.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
commandLine.inc Fix typo in SpecialVersion 2012-01-12 22:14:56 +00:00
compareParsers.php Improve documentation of maintenance scripts. 2012-06-25 21:54:41 +02:00
convertLinks.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
convertUserOptions.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
copyFileBackend.php Merge "[FileBackend] Changed copy script to use batches for concurrency." 2012-06-26 05:45:33 +00:00
createAndPromote.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
deleteArchivedFiles.inc Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
deleteArchivedFiles.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
deleteArchivedRevisions.inc Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
deleteArchivedRevisions.php Improve documentation of maintenance scripts. 2012-06-16 22:59:39 +02:00
deleteBatch.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
deleteDefaultMessages.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
deleteImageMemcached.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
deleteOldRevisions.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
deleteOrphanedRevisions.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
deleteRevision.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
deleteSelfExternals.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
doMaintenance.php Disable the db LCStore if the maintenance script doesn't need a db. 2012-06-26 18:58:37 +02:00
Doxyfile Disable callgraphs for the time being 2012-03-18 20:10:47 +00:00
dumpBackup.php Make backupTestPass.inc require_once by itself its dependence on backup.inc 2012-05-06 22:31:03 +02:00
dumpIterator.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
dumpLinks.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
dumpSisterSites.php Improve documentation of maintenance scripts. 2012-07-08 22:50:22 +02:00
dumpTextPass.php Make backupTestPass.inc require_once by itself its dependence on backup.inc 2012-05-06 22:31:03 +02:00
dumpUploads.php No current need for an alias to getPath() 2011-05-04 18:34:50 +00:00
edit.php Use WikiPage instead of Article to call doEdit() 2011-12-29 18:51:23 +00:00
eval.php Revert r108777 (making eval subclass maintenance). eval's supposed to be in the global context. See r54839 2012-01-14 22:21:30 +00:00
fetchText.php Add, update, tweak documentation 2011-10-26 03:45:13 +00:00
fileOpPerfTest.php [FileBackend] Added support for concurrent file write operations. 2012-05-09 05:37:41 -07:00
findHooks.php Added missing directories to findHooks.php and missing quote in hooks.txt that made LoginAuthenticateAudit show up as undocumented when running findHooks.php 2012-02-12 19:18:36 +00:00
fixDoubleRedirects.php Use consistent notation for "@todo FIXME". Should update http://svn.wikimedia.org/doc/todo.html nicely. 2011-05-17 22:03:20 +00:00
fixExtLinksProtocolRelative.php Add a newline, the below isn't too readable 2011-12-13 16:51:24 +00:00
fixSlaveDesync.php Pass __METHOD__ to DatabaseBase::commit() and DatabaseBase::rollback() 2012-02-28 18:41:36 +00:00
fixTimestamps.php
fixUserRegistration.php
formatInstallDoc.php Added missing GPLv2 headers in some places. 2012-06-14 14:26:37 +02:00
fuzz-tester.php Fixing up undefined types in maintenance documentation 2012-02-09 21:08:06 +00:00
generateSitemap.php generateSitemap can now optionally skip redirects 2012-04-06 13:04:03 -07:00
getLagTimes.php
getSlaveServer.php Improve documentation 2012-02-02 20:19:20 +00:00
getText.php
importDump.php Fixed reporting in importDump.txt 2012-01-11 10:38:25 +00:00
importImages.inc Fixing up undefined types in maintenance documentation 2012-02-09 21:08:06 +00:00
importImages.php The if should check $commentText, not $f, which is always set in this branch. 2012-01-27 21:06:00 +00:00
importSiteScripts.php Added missing GPLv2 headers in some places. 2012-06-14 14:26:37 +02:00
importTextFile.php * Use WikiPage instead of Article to call doEdit() 2012-01-15 12:30:14 +00:00
initEditCount.php Merge r86398 into the old wfWaitForSlaves. Update core calls. 2011-04-20 00:12:06 +00:00
initStats.php Fix missing parameter to cacheUpdate 2011-03-30 18:34:38 +00:00
install.php Bug 26911 - cli install doesn't ask for a password 2012-06-22 19:51:20 -04:00
interwiki.list Alphabetically sort the interwikis. 2012-04-02 19:56:26 +02:00
interwiki.sql Alphabetically sort the interwikis. 2012-04-02 19:56:26 +02:00
jsparse.php Remove some unused getting of non existent arguments 2011-10-18 17:31:54 +00:00
lag.php
Maintenance.php Merge "Various updates needed to bump min php version to 5.3.2" 2012-05-04 12:44:57 +00:00
Makefile man page help pages generation 2011-11-03 14:01:00 +00:00
mcc.php
mctest.php In mctest.php, use the configured timeout instead of the default 2012-04-27 14:51:52 +10:00
mergeMessageFileList.php Fix https://gerrit.wikimedia.org/r/4830 , I botched the conflict 2012-04-12 17:48:03 -07:00
migrateUserGroup.php More __METHOD__ in our madness 2012-02-24 18:45:24 +00:00
minify.php Fixup a couple more undefined variables 2011-03-30 19:44:39 +00:00
moveBatch.php More __METHOD__ into db related methods 2012-02-24 17:00:52 +00:00
mwdocgen.php Big oops - merged to wrong branch. 2012-06-05 22:58:54 +00:00
namespaceDupes.php Normalise casing of getArticleID used in core 2012-03-11 18:54:55 +00:00
nextJobDB.php Big oops - merged to wrong branch. 2012-06-05 22:58:54 +00:00
nukeNS.php More __METHOD__ in our madness 2012-02-24 18:45:24 +00:00
nukePage.php Pass __METHOD__ to DatabaseBase::commit() and DatabaseBase::rollback() 2012-02-28 18:41:36 +00:00
orphans.php * Use WikiPage instead of Article to call updateRevisionOn() 2012-01-16 21:54:24 +00:00
parse.php parse.php Windows uses CTRL+Z as a EOF sequence 2012-07-06 20:23:24 +02:00
patchSql.php
populateCategory.php Rm old options from commandLine.inc days 2011-09-08 03:13:31 +00:00
populateImageSha1.php When file sha1 populator fixes wrong values, make it fix the other metadata. 2012-05-23 12:04:29 -07:00
populateLogSearch.php Tweaks to LoggedUpdateMaintenance: 2011-09-08 15:52:00 +00:00
populateLogUsertext.php More __METHOD__ in our madness 2012-02-24 18:45:24 +00:00
populateParentId.php The script can be re-run (in some cases at least!) to fix up incomplete migrations (see bug 34981 for enwiki) 2012-04-24 16:44:00 +01:00
populateRevisionLength.php Set batch size in PopulateRevisionLength 2011-10-27 18:32:52 +00:00
populateRevisionSha1.php Big oops - merged to wrong branch. 2012-06-05 22:58:54 +00:00
preprocessDump.php Unbreak multiple maintenance scripts 2011-06-26 15:40:14 +00:00
preprocessorFuzzTest.php Change usages of $wgUser->getSkin() in special pages to use $this->getSkin() 2011-07-01 02:25:19 +00:00
protect.php Cleanup a few unused globals 2012-02-16 02:35:48 +00:00
proxy_check.php Added missing GPLv2 headers in some places. 2012-06-14 14:26:37 +02:00
pruneFileCache.php Comments, braces, explicit member variables 2011-11-16 13:22:03 +00:00
purgeDeletedFiles.php Ported changes from r110601 2012-02-02 19:33:36 +00:00
purgeList.php enable purge of HTTPS URLs 2012-02-14 20:20:56 +00:00
purgeOldText.inc More __METHOD__ in our madness 2012-02-24 18:45:24 +00:00
purgeOldText.php
purgeParserCache.php Added missing GPLv2 headers in some places. 2012-06-14 14:26:37 +02:00
purgeStaleMemcachedText.php Added missing GPLv2 headers in some places. 2012-06-14 14:26:37 +02:00
README
reassignEdits.php More __METHOD__ in our madness 2012-02-24 18:45:24 +00:00
rebuildall.php
rebuildFileCache.php More __METHOD__ in our madness 2012-02-24 18:45:24 +00:00
rebuildImages.php Fix doc for maintenance/ 2012-02-08 16:55:54 +00:00
rebuildLocalisationCache.php Update core usage of getLanguageName[s]. 2012-03-08 20:56:26 +00:00
rebuildmessages.php
rebuildrecentchanges.php re Bug 31007 - rebuildrecentchanges.php fails for Postgresql with strings for integers 2012-01-03 23:42:15 +00:00
rebuildtextindex.php Pass in some more , __METHOD__ 2011-11-10 20:44:37 +00:00
refreshImageCount.php
refreshImageMetadata.php Fix doc for maintenance/ 2012-02-08 16:55:54 +00:00
refreshLinks.php Add a bit more slave waiting... 2012-06-09 03:37:38 +01:00
removeUnusedAccounts.php More __METHOD__ in our madness 2012-02-24 18:45:24 +00:00
renameDbPrefix.php
renderDump.php
resetUserTokens.php Followup r81928, make proper use of $this->output instead of echo. 2011-03-28 03:38:43 +00:00
rollbackEdits.php * Use WikiPage instead of Article to call commitRollback() 2012-01-14 14:11:08 +00:00
runBatchedQuery.php Remove some unused getting of non existent arguments 2011-10-18 17:32:20 +00:00
runJobs.php debug start of jobs 2012-06-27 19:01:11 +02:00
showJobs.php using real identity for hashar 2011-10-24 09:08:13 +00:00
showStats.php Remove last two vestiges of ss_admins. It still exists in some schema files, but those are harmless 2012-01-26 22:04:55 +00:00
sql.php Fixed reading from file from r108774 2012-01-17 13:29:42 +00:00
sqlite.inc
sqlite.php Remove some unused getting of non existent arguments 2011-10-18 17:32:20 +00:00
stats.php Cleanup to statistics: 2012-01-23 16:27:13 +00:00
syncFileBackend.php [FileBackend] Syncing from journal support. 2012-05-06 17:04:53 -07:00
tables.sql (bug 5445) remove autoblocks when user is unblocked 2012-05-03 12:07:30 +02:00
undelete.php (bug 26854) Invalid user names go unchecked. Applied most of the patch submitted by Søren Løvborg, checking for null return values from User::newFromName() 2011-11-20 10:55:58 +00:00
update.php Various updates needed to bump min php version to 5.3.2 2012-04-16 15:38:22 +01:00
updateArticleCount.php * Made SiteStatsInit::articles() give a correct result when $wgUseCommaCount is false (btw, do we really need to keep that variable?) 2011-04-20 11:58:00 +00:00
updateCollation.php Use estimateRowPage if wiki is using wgMiserMode 2012-07-06 17:57:40 +01:00
updateDoubleWidthSearch.php
updateRestrictions.php Swap else if for elseif 2011-06-17 16:05:35 +00:00
updateSearchIndex.php Bunch of error suppression operator fixes (bug 2011-07-06 21:57:44 +00:00
updateSpecialPages.php Pass __METHOD__ to DatabaseBase::commit() and DatabaseBase::rollback() 2012-02-28 18:41:36 +00:00
upgrade1_5.php Fixing up undefined types in maintenance documentation 2012-02-09 21:08:06 +00:00
userDupes.inc Some HipHop fixes: 2011-05-27 06:25:21 +00:00
userOptions.inc Fixing up undefined types in maintenance documentation 2012-02-09 21:08:06 +00:00
userOptions.php using real identity for hashar 2011-10-24 09:08:13 +00:00
waitForSlave.php

== MediaWiki Maintenance ==

The .sql scripts in this directory are not intended to be run standalone,
although this is appropriate in some cases, e.g. manual creation of blank tables
prior to an import.

Most of the PHP scripts need to be run from the command line. Prior to doing so,
ensure that the LocalSettings.php file in the directory above points to the
proper installation.

Certain scripts will require elevated access to the database. In order to
provide this, first create a MySQL user with "all" permissions on the wiki
database, and then set $wgDBadminuser and $wgDBadminpassword in your
LocalSettings.php

=== Brief explanation of files ===

A lot of the files in this directory are PHP scripts used to perform various
maintenance tasks on the wiki database, e.g. rebuilding link tables, updating
the search indices, etc. The files in the "archives" directory are used to
upgrade the database schema when updating the software. Some schema definitions
for alternative (as yet unsupported) database management systems are stored
here too.

The "storage" directory contains scripts and resources useful for working with
external storage clusters, and are not likely to be particularly useful to the
vast majority of installations. This directory does contain the compressOld
scripts, however, which can be useful for compacting old data.

=== Maintenance scripts ===

As noted above, these should be run from the command line. Not all scripts are
listed, as some are Wikimedia-specific, and some are not applicable to most
installations.

	changePassword.php
	Reset the password of a specified user

	cleanupSpam.php
	Mass-revert insertion of linkspam

	createAndPromote.php
	Create a user with administrator (and optionally, bureaucrat) permissions

	deleteOldRevisions.php
	Erase old revisions of pages from the database

	dumpBackup.php
	Backup dump script

	edit.php
	Edit a page to change its content

	findhooks.php
	Find hooks that aren't documented in docs/hooks.txt

	importDump.php
	XML dump importer
	
	importImages.php
	Import images into the wiki
	
	importTextFile.php
	Import the contents of a text file into a wiki page

	moveBatch.php
	Move a batch of pages 

	namespaceDupes.php
	Check articles name to see if they conflict with new/existing namespaces

	nukePage.php
	Wipe a page and all revisions from the database

	reassignEdits.php
	Reassign edits from one user to another

	rebuildImages.php
	Update image metadata records

	rebuildmessages.php
	Update the MediaWiki namespace after changing site language

	rebuildtextindex.php
	Rebuild the fulltext search indices

	refreshLinks.php
	Rebuild the link tables

	removeUnusedAccounts.php
	Remove user accounts which have made no edits

	runJobs.php
	Immediately complete all jobs in the job queue

	stats.php
	Show all statistics stored in the cache

	undelete.php
	Undelete all revisions of a page

	update.php
	Check and upgrade the database schema to the current version

	updateRestrictions.php
	Update pages restriction to the new schema

	userOptions.php
	Change user options