maintenance/README

   1 == MediaWiki Maintenance ==
   2
   3 The .sql scripts in this directory are not intended to be run standalone,
   4 although this is appropriate in some cases, e.g. manual creation of blank tables
   5 prior to an import.
   6
   7 Most of the PHP scripts need to be run from the command line. Prior to doing so,
   8 ensure that the LocalSettings.php file in the directory above points to the
   9 proper installation.
  10
  11 Certain scripts will require elevated access to the database. In order to
  12 provide this, first create a MySQL user with "all" permissions on the wiki
  13 database, and then place their username and password in an AdminSettings.php
  14 file in the directory above. See AdminSettings.sample for specifics on this.
  15
  16 === Brief explanation of files ===
  17
  18 A lot of the files in this directory are PHP scripts used to perform various
  19 maintenance tasks on the wiki database, e.g. rebuilding link tables, updating
  20 the search indices, etc. The files in the "archives" directory are used to
  21 upgrade the database schema when updating the software. Some schema definitions
  22 for alternative (as yet unsupported) database management systems are stored
  23 here too.
  24
  25 The "storage" directory contains scripts and resources useful for working with
  26 external storage clusters, and are not likely to be particularly useful to the
  27 vast majority of installations. This directory does contain the compressOld
  28 scripts, however, which can be useful for compacting old data.
  29
  30 === Maintenance scripts ===
  31
  32 As noted above, these should be run from the command line. Not all scripts are
  33 listed, as some are Wikimedia-specific, and some are not applicable to most
  34 installations.
  35
  36         changePassword.php
  37         Reset the password of a specified user
  38
  39         cleanupSpam.php
  40         Mass-revert insertion of linkspam
  41
  42         createAndPromote.php
  43         Create a user with administrator (and optionally, bureaucrat) permissions
  44
  45         deleteOldRevisions.php
  46         Erase old revisions of pages from the database
  47
  48         dumpBackup.php
  49         Backup dump script
  50
  51         dumpHTML.php
  52         Produce an HTML dump of a wiki
  53
  54         importDump.php
  55         XML dump importer
  56
  57         importImages.php
  58         Import images into the wiki
  59
  60         importTextFile.php
  61         Import the contents of a text file into a wiki page
  62
  63         nukePage.php
  64         Wipe a page and all revisions from the database
  65
  66         reassignEdits.php
  67         Reassign edits from one user to another
  68
  69         rebuildImages.php
  70         Update image metadata records
  71
  72         rebuildMessages.php
  73         Update the MediaWiki namespace after changing site language
  74
  75         rebuildtextindex.php
  76         Rebuild the fulltext search indices
  77
  78         refreshLinks.php
  79         Rebuild the link tables
  80
  81         removeUnusedAccounts.php
  82         Remove user accounts which have made no edits
  83
  84         runJobs.php
  85         Immediately complete all jobs in the job queue
  86
  87         update.php
  88         Check and upgrade the database schema to the current version