https://github.com/professionalwiki/simplebatchupload
Allows for basic, no-frills uploading of multiple files
https://github.com/professionalwiki/simplebatchupload
batchupload file-upload mediawiki mediawiki-extension upload
Last synced: 19 days ago
JSON representation
Allows for basic, no-frills uploading of multiple files
- Host: GitHub
- URL: https://github.com/professionalwiki/simplebatchupload
- Owner: ProfessionalWiki
- License: other
- Created: 2016-06-05T20:28:07.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-02-24T12:10:54.000Z (about 2 months ago)
- Last Synced: 2025-03-29T22:09:24.643Z (26 days ago)
- Topics: batchupload, file-upload, mediawiki, mediawiki-extension, upload
- Language: PHP
- Homepage: https://www.mediawiki.org/wiki/Extension:SimpleBatchUpload
- Size: 211 KB
- Stars: 22
- Watchers: 6
- Forks: 17
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: COPYING.txt
Awesome Lists containing this project
README
# SimpleBatchUpload
[](https://github.com/ProfessionalWiki/SimpleBatchUpload/actions?query=workflow%3ACI)
[](https://packagist.org/packages/mediawiki/simple-batch-upload)
[](https://packagist.org/packages/mediawiki/simple-batch-upload)
The [SimpleBatchUpload][mw-simple-batch-upload] extension provides basic,
no-frills uploading of multiple files to MediaWiki.
It is maintained by [Professional.Wiki](https://professional.wiki/).
[Contact us](https://professional.wiki/en/contact) for commercial support or development work.
## Requirements
- PHP 8.0 or later
- MediaWiki 1.35 or later
## Installation
### Composer
```sh
COMPOSER=composer.local.json composer require --no-update mediawiki/simple-batch-upload:^2.0
```
```sh
composer update mediawiki/simple-batch-upload --no-dev -o
```
### Manual installation
[Download](https://github.com/ProfessionalWiki/SimpleBatchUpload/releases) and place the files in a directory called `SimpleBatchUpload` in your `extensions/` folder.
Enable the extension by adding the following to your LocalSettings.php:
```php
wfLoadExtension( 'SimpleBatchUpload' );
```
**Note:** To use the extension the user needs the [`writeapi`][writeapi] right. This is the
default MediaWiki setting for registered users, but it may have been changed
during the configuration of the wiki.
## Usage
There are four ways to upload files using this extension:
* Go to _Special:BatchUpload_ to get a plain upload page
* Go to _Special:BatchUpload/Foo_ to get an upload page that sets `{{Foo}}` as
the wikitext of the uploaded file's page
* Add `{{#batchupload:}}` to any wikipage to get a simple upload button
* Add `{{#batchupload:Foo|Bar|Baz}}` to any wikipage to get an upload button
that sets `{{Foo|Bar|Baz}}` as the wikitext of the uploaded file's page
## Customization
It is possible to specify dedicated parameter sets for the upload of specific
file types by editing the _MediaWiki:Simplebatchupload-parameters_ page. Each
line of that page is considered as one set of parameters.
Available parameters are:
* Name of template to be stored as text on initial upload
* Upload comment
* Title line of the Special:BatchUpload page
Parameters should be separated by pipes (|).
The line to be used is selected by appending the name of the template as the
subpage to the URL of the Special:BatchUpload page.
__Example:__
Consider the parameter line
```
Pics | These pics were uploaded using [[mw:Extension:SimpleBatchUpload{{!}}SimpleBatchUpload]] | Upload some pics!
```
* This can be selected by going to _Special:BatchUpload/Pics_.
* The title of this page will be _Upload some pics!_.
* The comment for the upload will be _These pics were uploaded using [[mw:Extension:SimpleBatchUpload{{!}}SimpleBatchUpload]]_.
* If a file with that name is uploaded for the first time it will have `{{Pics}}` as wikitext.
## Configuration
Available configuration options:
* `$wgSimpleBatchUploadMaxFilesPerBatch` - Array defining the maximum number of
files that can be uploaded each time depending on the user group.
Default:
``` php
$wgSimpleBatchUploadMaxFilesPerBatch = [
'*' => 1000,
];
```
**Note:** Be aware that this is not the right setting to completely block file
uploads! Users can still use the normal file upload or the MediaWiki API. See
the paragraph on user permissions on
[Configuring file uploads](https://www.mediawiki.org/wiki/Manual:Configuring_file_uploads#Upload_permissions)
on mediawiki.org.
## License
[GNU General Public License 2.0][license] or later
[license]: https://www.gnu.org/copyleft/gpl.html
[mw-simple-batch-upload]: https://www.mediawiki.org/wiki/Extension:SimpleBatchUpload
[composer]: https://getcomposer.org/
[writeapi]: https://www.mediawiki.org/wiki/Manual:User_rights#List_of_permissions