Difference between revisions of "Reference:Scribunto"

m (Text replacement - "|edition=BlueSpice pro |active=Yes" to "|edition=BlueSpice pro, BlueSpice Farm, BlueSpice Cloud |active=Yes")
 
The Scribunto (Latin: "they shall write/let them write (in the future)") extension allows

Extension: Scribunto


Overview
Description: provides a framework for embedding scripting languages
in MediaWiki. Currently the only supported scripting language is Lua.

License[edit | edit source]

This extension contains code licensed GNU General Public License v2.0 or later (GPL-2.0+) as well as code licensed MIT License (MIT).

Requirements[edit | edit source]

PCRE version compatibility[edit | edit source]

PCRE 8.33 or later is recommended. You can see the version of PCRE used by PHP by viewing a phpinfo() web page, or from the command line with the command php -i | grep 'PCRE'.

CentOS 6 and RHEL 6 are stuck on PCRE 7 and need to be upgraded.

Updating to 8.33 on a server with an older version may be relatively complicated. See Updating to PCRE 8.33 or Higher for details.

PHP pcntl[edit | edit source]

Since Scribunto for MediaWiki 1.25, your PHP server also needs to have pcntl enabled (only works with Unix/Linux platforms) if you want to use "LuaStandAlone" (i.e. running in a separate child process). Under Windows, Scribunto will run Lua only as "LuaSandbox" (within the same PHP thread as the thread used by MediaWiki to run this Scribunto extension, but within the sandboxing PHP environment configured by Scribunto).

PHP mbstring extension[edit | edit source]

PHP needs to have the mbstring extension enabled.

To see if it installed on your server, you can check if it is enabled by running the command php -m on the server. If the string mbstring is present in the output, the extension is enabled.

Lua binary[edit | edit source]

Bundled binaries[edit | edit source]

Scribunto comes bundled with Lua binary distributions for Linux (x86 and x86-64), Mac OS X Lion, and Windows (32- and 64-bit).

Scribunto should work for you out of the box if:

  1. Your web server is run on one of the above platforms.
  2. PHP's proc_open function is not restricted[1]
  3. Your web server is configured to allow the execution of binary files in the MediaWiki tree.
Template:Note Execute permissions may need to be set; for example, in Linux use chmod a+x /path/to/extensions/Scribunto/engines/LuaStandalone/binaries/lua5_1_5_linux_64_generic/lua If you are using SELinux in "Enforcing" mode on your server, you might need to set a proper context for the binaries. Example for RHEL/CentOS 7:chcon -t httpd_sys_script_exec_t /path/to/extensions/Scribunto/engines/LuaStandalone/binaries/lua5_1_5_linux_64_generic/lua

Additional binaries[edit | edit source]

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.

Source: mediawiki
  1. i.e. proc_open is not within the array of disable_functions in your server's "php.ini" file.
into articles.
State: stable Dependency: MediaWiki
Developer: Victor Vasiliev, Tim Starling License: GPL v2+ and MIT
Type: MediaWiki Category: Infrastructure
Edition: BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
For more info, visit Mediawiki.

Features[edit source]

Scribunto provides a framework for embedding scripting languages into MediaWiki pages.


For more information visit MediaWiki.


Attachments

Discussions