Difference between revisions of "Reference:Scribunto"
(→Additional binaries) |
The Scribunto (Latin: "they shall write/let them write (in the future)") extension allows for embedding scripting languages in MediaWiki. Currently the only supported scripting language is Lua.
Contents
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]
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:
- Your web server is run on one of the above platforms.
-
PHP's
proc_openfunction is not restricted[1] - Your web server is configured to allow the execution of binary files in the MediaWiki tree.
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:
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
-
↑ i.e.
proc_openis not within the array ofdisable_functionsin your server's "php.ini" file.
The '''Scribunto''' ([https://en.wikipedia.org/wiki/Latin Latin]: "''[https://en.wiktionary.org/wiki/scribunto they shall write/let them write (in the future)]''") extension allows for embedding scripting languages in MediaWiki. Currently the only supported scripting language is [http://www.lua.org/ Lua].
__TOC__
==License==
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==
===PHP pcntl===
Since Scribunto for MediaWiki 1.25, your PHP server also needs to have [http://php.net/manual/en/pcntl.installation.php 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===
PHP needs to have the [http://php.net/mbstring mbstring] extension enabled.
To see if it installed on your server, you can check if it is enabled by running the command <code>php -m</code> on the server. If the string <tt>mbstring</tt> is present in the output, the extension is enabled.
===Lua binary===
====Bundled binaries====
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:
# Your web server is run on one of the above platforms.
# PHP's <code>proc_open</code> function is not restricted<ref>i.e. <code>proc_open</code> is not within the array of <code>disable_functions</code> in your server's "php.ini" file.</ref>
# Your web server is configured to allow the execution of binary files in the MediaWiki tree.
: Execute permissions may need to be set; for example, in Linux use
:: <syntaxhighlight lang="bash">chmod a+x /path/to/extensions/Scribunto/engines/LuaStandalone/binaries/lua5_1_5_linux_64_generic/lua</syntaxhighlight>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:<syntaxhighlight lang="bash">
chcon -t httpd_sys_script_exec_t /path/to/extensions/Scribunto/engines/LuaStandalone/binaries/lua5_1_5_linux_64_generic/lua
</syntaxhighlight>
====Additional binaries====
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:
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: '''[https://www.mediawiki.org/wiki/Extension:Scribunto mediawiki]| Line 1: | Line 1: | ||
The '''Scribunto''' ([https://en.wikipedia.org/wiki/Latin Latin]: "''[https://en.wiktionary.org/wiki/scribunto they shall write/let them write (in the future)]''") extension allows for embedding scripting languages in MediaWiki. Currently the only supported scripting language is [http://www.lua.org/ Lua]. | The '''Scribunto''' ([https://en.wikipedia.org/wiki/Latin Latin]: "''[https://en.wiktionary.org/wiki/scribunto they shall write/let them write (in the future)]''") extension allows for embedding scripting languages in MediaWiki. Currently the only supported scripting language is [http://www.lua.org/ Lua]. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
'''Source: '''[https://www.mediawiki.org/wiki/Extension:Scribunto mediawiki] | '''Source: '''[https://www.mediawiki.org/wiki/Extension:Scribunto mediawiki] | ||