Extension:DataDump
![]() Release status: stable |
|
---|---|
Implementation | Database , Special page |
Description | Provides the Special page to generate/delete/download dumps |
Maintainer(s) | Miraheze system administrators |
Latest version | continuous updates |
MediaWiki | 1.36.0+ |
PHP | 7.2+ |
Database changes | Yes |
Composer | miraheze/datadump |
Tables | data_dump |
License | GNU General Public License 3.0 or later |
Download | GitHub: Note: |
|
|
|
|
Public wikis using | 163 (Ranked 433rd) |
The DataDump extension provides means for users to generate, delete or download their dump without the involvement of sysadmins.
For reporting an issue or a bug, please use Miraheze Phabricator. See here for the workboard.
InstallationEdit
- Download and place the file(s) in a directory called
DataDump
in yourextensions/
folder. - Add the following code at the bottom of your
LocalSettings.php
:wfLoadExtension( 'DataDump' );
- Run the update script which will automatically create the necessary database tables that this extension needs.
- Configure as required.
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
ConfigurationEdit
parameter | default | comment |
---|---|---|
$wgDataDump
|
[]
|
This config defines how dumps are generated and which types of dumps there are. |
$wgDataDumpInfo
|
""
|
This config defines the information displayed atop Special:DataDump. |
$wgDataDumpLimits
|
["memory": 0, "filesize": 0, "time": 0, "walltime": 0]
|
This config defines resources allocated to running scripts. |
$wgDataDumpDirectory
|
false
|
This config defines the directory where to store the dumps. |
$wgDataDumpFileBackend
|
false
|
This config defines backend to use ($wgFileBackends) |
ExampleEdit
This is an example on how to setup the configuration. You can tailor it to your specific needs:
$wgDataDumpDirectory = "<path>${wgDBname}/";
$wgDataDump = [
'xml' => [
'file_ending' => '.xml.gz',
'generate' => [
'type' => 'mwscript',
'script' => "$IP/maintenance/dumpBackup.php",
'options' => [
'--full',
'--output',
"gzip:${wgDataDumpDirectory}" . '${filename}',
],
],
'limit' => 1,
'permissions' => [
'view' => 'view-dump',
'generate' => 'generate-dump',
'delete' => 'delete-dump',
],
],
'image' => [
'file_ending' => '.zip',
'generate' => [
'type' => 'script',
'script' => '/usr/bin/zip',
'options' => [
'-r',
'<path>${filename}',
"<path>${wgDBname}/"
],
],
'limit' => 1,
'permissions' => [
'view' => 'view-dump',
'generate' => 'view-image-dump',
'delete' => 'delete-dump',
],
],
];
$wgAvailableRights[] = 'view-dump';
$wgAvailableRights[] = 'view-image-dump';
$wgAvailableRights[] = 'generate-dump';
$wgAvailableRights[] = 'delete-dump';
Note that ${filename}
is replaced internally in the extension so make sure that it is always in a single string not in a double string.
The limit parameter specifies how many dumps can be generated for that wiki.
See alsoEdit
This extension is made by Miraheze. It may have issues you don't see in Miraheze. To report a bug or request a configuration change, please do so in the Miraheze Phabricator instead of the Wikimedia one. |