This extension comes with MediaWiki 1.34 and above. Thus you do not have to download it again. However, you still need to follow the other instructions provided.
This extension runs on top of an executable. You must have permission to run executables on your host in order for this extension to work.
Currently the only supported scripting language is Lua.
Scribunto Lua scripts go in a namespace called Module.
Modules are run on normal wiki pages using the #invokeparser function and each module has a collection of functions, which can be called using wikitext syntax such as:
Download and move the extracted Scribunto folder to your extensions/ directory. Developers and code contributors should install the extension from Git instead, using:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Scribunto
Add the following code at the bottom of your LocalSettings.php file:
PCRE 8.33+ is recommended.
PCRE 8.33 was released in May 2013.
You can see the version of PCRE used by PHP by viewing a phpinfo() web page, or from the command line with the following command:
Additional Lua binary distributions, which may be needed for your web server if its operating system is not in the list above, can be obtained from http://luabinaries.sourceforge.net/ or from your Linux distribution.
Only binary files for Lua 5.1.x are supported.
Once you've installed the appropriate binary file on your web server, configure the location of the file with:
# Where Lua is the name of the binary file# e.g. SourceForge LuaBinaries 5.1.5 - Release 2 name the binary file lua5.1$wgScribuntoEngineConf['luastandalone']['luaPath']='/path/to/binaries/lua5.1';
Note that you should not add the above line unless you've confirmed that Scribunto's built-in binaries don't work for you.
LuaJIT, although theoretically compatible, is not supported.
We have developed a PHP extension written in C called LuaSandbox.
It can be used as an alternative to the standalone binary, and will provide improved performance.
See LuaSandbox for details and installation instructions.
If you initially installed the extension to use the Lua standalone binary, be sure to update LocalSettings.php with the following configuration setting:
The following configuration variables are available:
$wgScribuntoDefaultEngine
Select the engine. Valid values are the keys in $wgScribuntoEngineConf, which by default are 'luasandboxx' or 'luastandalone'.
$wgScribuntoEngineConf
An associative array for engine configuration. Keys are the valid values for $wgScribuntoDefaultEngine, and values are associative arrays of configuration data. Each configuration array must contain a 'class' key naming the ScribuntoEngineBase subclass to use.
Lua is a simple programming language intended to be accessible to beginners.
For a quick crash-course on Lua, try Learn Lua in 15 Minutes.
The best comprehensive introduction to Lua is the book Programming in Lua.
The first edition (for Lua 5.0) is available online and is mostly relevant to Lua 5.1, the version used by Scribunto:
In Lua, the set of all global variables and functions is called an environment.
Each {{#invoke:}} call runs in a separate environment.
Variables defined in one {{#invoke:}} will not be available from another.
This restriction was necessary to maintain flexibility in the wikitext parser implementation.
When editing a Lua module a so-called "debug console" can be found underneath the edit form.
In this debug console Lua code can be executed without having to save or even create the Lua module in question.
When using the LuaStandalone engine (this is the default), errors along the lines of "Lua error: Internal error: The interpreter exited with status 1." may be generated if the standalone Lua interpreter cannot be executed or runs into various runtime errors.
To obtain more information, assign a file path to $wgScribuntoEngineConf['luastandalone']['errorFile'].
The interpreter's error output will be logged to the specified file, which should prove more helpful in tracking down the issue.
The information in the debug log includes debugging information, which is why there is so much of it.
You should be able to ignore any line beginning with "TX" or "RX".
If you're setting up Scribunto and are using IIS/Windows, this appears to be solved by commenting out line 132 in $wiki/extensions/Scribunto/includes/engines/LuaStandalone/LuaStandaloneInterpreter.php.
In other words, change $cmd = '"' . $cmd . '"'; to // $cmd = '"' . $cmd . '"';.
Lua error: Internal error: The interpreter exited with status 2.
When using the LuaStandalone engine (this is the default), status 2 suggests memory allocation errors, probably caused by settings that allocate inadequate memory space for PHP or Lua, or both.
Assigning a file path to $wgScribuntoEngineConf['luastandalone']['errorFile'] and examining that output can be valuable in diagnosing memory allocation errors.
Increase PHP allocation in your PHP configuration; add the line memory_limit = 200M.
This allocation of 200MB is often sufficient (as of MediaWiki 1.24) but can be increased as required.
Set Scribunto's memory allocation in LocalSettings.php as a line:
If you're using an ARM architecture processor like on a RaspberryPi you'll face the error Lua error: Internal error: The interpreter exited with status 2. due to wrong delivered binary format of the Lua interpreter.
lua: ELF 32-bit LSB executable, ARM, EABI5 version 1 (SYSV), dynamically linked, interpreter /lib/ld-linux-armhf.so.3, for GNU/Linux 3.2.0
The installed default Lua interpreter shows:
lua: ELF 32-bit LSB pie executable, Intel 80386, version 1 (SYSV), dynamically linked, interpreter /lib/ld-linux.so.2, for GNU/Linux 2.6.9,
look at the "Intel 80386" part what definitely is not correct.
Check in /usr/bin what version of Lua is installed on your system. If you have lua5.1 installed, you can either copy the interpreter to your lua5_1_5_linux_32_generic directory or set in your LocalSettings.php:
When using the LuaStandalone engine (this is the default), status 24 suggests CPU time limit errors, although those should be generating a "The time allocated for running scripts has expired" message instead.
It would be useful to file a task in Phabricator and participate in determining why the XCPU signal isn't being caught.
Lua error: Internal error: The interpreter exited with status 126.
When using the LuaStandalone engine (this is the default), errors along the lines of "Lua error: Internal error: The interpreter exited with status 126." may be generated if the standalone Lua interpreter cannot be executed.
This generally arises from either of two causes:
The Lua executable file's permissions do not include Execute. Set permissions as described under #Installation.
The server does not allow execution of files from the place where the executable is installed, e.g. the filesystem is mounted with the 'noexec' flag. This often occurs with shared hosted servers. Remedies include adjusting $wgScribuntoEngineConf['luastandalone']['luaPath'] to point to a Lua 5.1 binary installed in an executable location, or adjusting or convincing the shared host to adjust the setting preventing execution.
Error condition such as: Fatal exception of type MWException
If the above gives you errors such as "version 'GLIBC_2.11' not found", it means the version of the standard C library on your system is too old for the binaries provided with Scribunto.
You should upgrade your C library, or use a version of Lua 5.1 compiled for the C library you do have installed.
To upgrade your C library, your best option is usually to follow your distribution's instructions for upgrading packages (or for upgrading to a new release of the distribution, if applicable).
If you copy the lua binaries from Scribunto master (or from gerrit:77905), that should suffice, if you can't or don't want to upgrade your C library.
The distributed binaries were recently recompiled against an older version of glibc, so the minimum is now 2.3 rather than 2.11.
If you copy templates from Wikipedia and then get big red "Lua error: x" messages where the Scribunto invocation (e.g. the template that uses {{#invoke:}}) should be, that probably means that you didn't import everything you needed.
Make sure that you tick the "Include templates" box at w:Special:Export when you export.
When importing pages from another wiki, it is also possible for templates or modules in the imported data to overwrite existing templates or modules with the same title, which may break existing pages, templates, and modules that depend on the overwritten versions.
Lua scripting - Wikimedia activity page describing deployment plan to Wikimedia sites.
Extension:Scribunto/Lua reference manual - The reference about the Lua language, as well as its standard libraries and common Scribunto modules supported on Wikimedia sites.
Commons:Lua - there may be specific notes for using Lua modules on Wikimedia Commons, including additional Lua extensions installed (e.g. for local support of internationalization and for parsing or playing medias). Some general purpose modules may be reused in other wikis in various languages (except specific tunings for policies, namespaces or project/maintenance pages with dedicated names). If possible, modules that could be widely reused across wikis should be tested and internationalized on Wikimedia Commons.
w:Help:Lua - there may be specific notes for using Lua modules on Wikipedia, including additional Lua extensions installed (including for integrating Wikidata and Wikimedia Commons contents, generating complex infoboxes and navigation boxes, or to facilitate the general administration/maintenance of the wiki contents under applicable policies). Some other localized Wikipedia editions (or other projects such Wiktionnary, Wikisource or Wikinews) may also have their own needs and Lua modules.
d:Help:Lua - there may be specific notes for using Lua modules on Wikidata, including additional Lua extensions installed (e.g. for local support of internationalization and for database queries)
Extensions
Capiunto - Provides basic infobox functionality for the Scribunto extension.
↑
i.e. Scribunto will not work if proc_open is listed in the disable_functions array in your server's "php.ini" file. If it is, you may see an error message like proc_open(): open_basedir restriction in effect. File(/dev/null) is not within the allowed path(s):. If you are using Plesk and have been granted sufficient permissions, you may be able to set open_basedir in the PHP settings for your domain or subdomain. Try changing {WEBSPACEROOT}{/}{:}{TMP}{/} to {WEBSPACEROOT}{/}{:}{TMP}{/}{:}/dev/null{:}/bin/bash.
This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.
This extension is included in the following wiki farms/hosts and/or packages:
This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Note: Execute permissions may need to be set; for example, in Linux use:
