MediaWiki REL1_31
README
Go to the documentation of this file.
1== MediaWiki Maintenance ==
2
3The .sql scripts in this directory are not intended to be run standalone,
4although this is appropriate in some cases, e.g. manual creation of blank tables
5prior to an import.
6
7Most of the PHP scripts need to be run from the command line. Prior to doing so,
8ensure that the LocalSettings.php file in the directory above points to the
9proper installation.
10
11Certain scripts will require elevated access to the database. In order to
12provide this, first create a MySQL user with "all" permissions on the wiki
13database, and then set $wgDBadminuser and $wgDBadminpassword in your
14LocalSettings.php
15
16=== Brief explanation of files ===
17
18A lot of the files in this directory are PHP scripts used to perform various
19maintenance tasks on the wiki database, e.g. rebuilding link tables, updating
20the search indices, etc. The files in the "archives" directory are used to
21upgrade the database schema when updating the software. Some schema definitions
22for alternative (as yet unsupported) database management systems are stored
23here too.
24
25The "storage" directory contains scripts and resources useful for working with
26external storage clusters, and are not likely to be particularly useful to the
27vast majority of installations. This directory does contain the compressOld
28scripts, however, which can be useful for compacting old data.
29
30=== Maintenance scripts ===
31
32As noted above, these should be run from the command line. Not all scripts are
33listed, as some are Wikimedia-specific, and some are not applicable to most
34installations.
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 edit.php
52 Edit a page to change its content
53
54 findHooks.php
55 Find hooks that aren't documented in docs/hooks.txt
56
57 importDump.php
58 XML dump importer
59
60 importImages.php
61 Import images into the wiki
62
63 moveBatch.php
64 Move a batch of pages
65
66 namespaceDupes.php
67 Check articles name to see if they conflict with new/existing namespaces
68
69 nukePage.php
70 Wipe a page and all revisions from the database
71
72 reassignEdits.php
73 Reassign edits from one user to another
74
75 rebuildImages.php
76 Update image metadata records
77
78 rebuildmessages.php
79 Update the MediaWiki namespace after changing site language
80
81 rebuildtextindex.php
82 Rebuild the fulltext search indices
83
84 refreshLinks.php
85 Rebuild the link tables
86
87 removeUnusedAccounts.php
88 Remove user accounts which have made no edits
89
90 runJobs.php
91 Immediately complete all jobs in the job queue
92
93 undelete.php
94 Undelete all revisions of a page
95
96 update.php
97 Check and upgrade the database schema to the current version
98
99 updateRestrictions.php
100 Update pages restriction to the new schema
101
102 userOptions.php
103 Change user options