Jump to content

Extension:Bucket

From mediawiki.org
MediaWiki extensions manual
Bucket
Release status: beta
Description Implements a lightweight interface for storing and accessing structured data
Author(s)
Latest version 2.1.1
MediaWiki 1.43+
Database changes Yes
  • $wgBucketDBuser
  • $wgBucketDBpassword
  • $wgBucketWriteEnabledNamespaces
  • $wgBucketMaxQueryExecutionTime
  • $wgBucketMaxPageExecutionTime
  • $wgBucketDBhostname
  • $wgBucketMaxDataPerPage
editbucket
Licence GNU General Public License 2.0 or later
Download

The Bucket extension implements a lightweight Lua interface for storing and accessing structured data on wiki pages.

Requirements

[edit]

Bucket is developed, tested, and deployed on wikis running MySQL as the database. It may work on MariaDB, but compatibility is not guaranteed.

Bucket requires Extension:Scribunto.

Installation

[edit]
  • Download and place the file(s) in a directory called Bucket in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'Bucket' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Follow the custom installation steps on Bucket's GitHub README:
    • Create a new database user for Bucket.
    • Configure as required.
    • Run php maintenance/run.php Bucket:SetupDBPermission to set up required database permissions.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage

[edit]

Please see the documentation page on Weird Gloop for usage instructions. The documentation is expected to be ported here at a later date.

If you're using Bucket and want to talk to the developers, check out the ⁠#bucket-discussion channel on Weird Gloop's Discord.

See also

[edit]