Extension:DataDump/ko
출시 상태: 안정 |
|
|---|---|
| 구현 | 데이터베이스, 특수 문서 |
| 설명 | Provides the Special page to generate/delete/download dumps |
| 만든 이 | Paladox, Universal Omega |
| 유지 보수자 | Miraheze system administrators |
| 최신 버전 | continuous updates |
| MediaWiki | >= 1.43.0 |
| PHP | 7.4+ |
| 데이터베이스 변경 | 예 |
| Composer | miraheze/data-dump |
|
|
|
|
| Licence | GNU General Public License 3.0 or later |
| 다운로드 | GitHub:
Note: |
The DataDump extension 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 Phorge. See here for the workboard.
설치
- 파일을 Download하고
DataDump폴더를extensions/디렉토리에 넣어 주세요. - 아래의 코드를 LocalSettings.php 코드의 마지막에 추가합니다.
wfLoadExtension( 'DataDump' );
- 갱신 스크립트를 실행합니다. 이 스크립트는 이 확장기능을 필요로 하는 데이터 베이스 테이블을 자동적으로 작성합니다.
- Configure as required.
완료 – 위키의 ‘Special:Version’에 이동해서, 확장기능이 올바르게 설치된 것을 확인합니다.
Configuration
| parameter | default | comment |
|---|---|---|
$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.
| permission | comment |
|---|---|
generate-dump
|
Allows users to generate database dumps |
view-dump
|
Allows users to view dumps |
delete-dump
|
Allows users to delete dumps |
Example
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.
See also
| This extension is included in the following wiki farms/hosts and/or packages: |
| This extension is maintained by Miraheze. Some Miraheze extensions are very Miraheze-specific and you may encounter issues you don't see on Miraheze. To report a bug or request a configuration change, please do so on the Miraheze Issue Tracker and not on Wikimedia Phabricator. |
