Extension:DataDump/ru
DataDump Статус релиза: стабильно |
|
---|---|
Реализация | База данных , Служебная страница |
Описание | Provides the Special page to generate/delete/download dumps |
Автор(ы) | Paladox, Universal Omega |
Поддерживающий(ие) | Miraheze system administrators |
Последняя версия | continuous updates |
MediaWiki | >= 1.36.0 |
PHP | 7.4+ |
Изменения в БД | Да |
Composer | miraheze/data-dump |
Таблицы | data_dump |
Лицензия | GNU General Public License 3.0 или позднее |
Скачать | GitHub: Note: |
|
|
|
|
DataDump allows users to request and generate database dumps. Other types of dumps, such as image dumps, can be configured in the extension. This allows for easy dumping without the need for system administrator intervention.
For reporting an issue or a bug, please use Miraheze Phabricator. See here for the workboard.
Установка
- Download и распакуйте файл(ы) в папку с названием
DataDump
в вашей папкеextensions/
. - Добавьте следующий код в конце вашего файла LocalSettings.php :
wfLoadExtension( 'DataDump' );
- Выполните скрипт обновления, который автоматически создаст необходимые таблицы, используемые расширением.
- Configure as required.
- Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.
Конфигурация
параметр | по умолчанию | комментарий |
---|---|---|
$wgDataDump
|
[]
|
This config defines how dumps are generated and which types of dumps there are. |
$wgDataDumpDirectory
|
false
|
This config defines the directory where to store the dumps. |
$wgDataDumpDisableGenerate
|
false
|
This config determines whether DataDump should be disabled or not. |
$wgDataDumpFileBackend
|
false
|
This config defines backend to use ($wgFileBackends) |
$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. |
Permissions
DataDump provides three permissions. These allow you some granularity when it comes to configuring DataDump.
You are not restricted to only using these permissions to restrict who can download, view, or delete dumps. You can also use other permissions available on the wiki.
parameter | comment |
---|---|
generate-dump
|
Allows users to generate database dumps |
view-dump
|
Allows users to view dumps |
delete-dump
|
Allows users to delete dumps |
Пример
This is an example of how to set up the configuration. You can tailor it to your specific needs:
$wgDataDumpDirectory = "/var/backups/${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',
],
],
'zip' => [
'file_ending' => '.zip',
'generate' => [
'type' => 'script',
'script' => '/usr/bin/zip',
'options' => [
'-r',
"${wgDataDumpDirectory}" . '${filename}',
"$IP/images/"
],
],
'limit' => 1,
'permissions' => [
'view' => 'view-dump',
'generate' => 'generate-dump',
'delete' => '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.
Troubleshooting
If you're experiencing issues with failed data dumps, you can look at your Job Queue 's log file.
You can search for DataDumpGenerateJob
to find an area where the Job Queue is running your dump.
PHP binary location
If your log file contains something similar: [exec] Possibly missing executable file: '/usr/bin/php'
, then you might need to set $wgPhpCli to a correct value for your environment.
You can use whereis php
to double check.
Zip Tooling
If your log file contains something similar to: [exec] Possibly missing executable file: '/usr/bin/zip'
then you need to ensure the appropriate zip tooling for your job is installed on your Host machine.
См. также
Это расширение включено в следующие вики-фермы/хостинги и/или пакеты: Это не исчерпывающий список. Некоторые вики-фермы/хостинги и/или пакеты могут содержать это расширение, даже если они не перечислены здесь. Всегда сверяйтесь со своими вики-фермами/хостингами или комплектами/бандлами для подтверждения. |
Это расширение сделано для Miraheze. Возможно, у него есть проблемы, которых вы не видите в Miraheze. Чтобы сообщить об ошибке или запросить изменение конфигурации, пожалуйста, сделайте это в Miraheze Phabricator вместо Викимедии. |
- Stable extensions/ru
- Database extensions/ru
- Special page extensions/ru
- Extensions supporting Composer/ru
- GPL licensed extensions/ru
- Extensions in GitHub version control/ru
- LoadExtensionSchemaUpdates extensions/ru
- All extensions/ru
- Extensions included in Miraheze/ru
- Extensions included in WikiForge/ru
- Extensions by Miraheze/ru