mw dev shellbox php-rpc

Shellbox is a library for command execution, and also a server and client for remote command execution. Shellbox is usable starting with MediaWiki 1.36.

For “automatic” configuration we follow a pattern similar to the Wikimedia production config. If you run a service, you will find a service URL defined in $dockerServices.

$dockerServices['shellbox-php-rpc'] = '<internal-url>';

Known ShellboxUrls are then also configured. Currently that is the following Urls.

$wgShellboxUrls['constraint-regex-checker'] = $dockerServices['shellbox-php-rpc'];

You can add more to your LocalSettings.php file if needed.

Note: This service will NOT be automatically loaded if MW_PHPUNIT_TEST is defined. (This happens when you are running unit tests)

Documentation

• Shellbox

Commands

• mw dev shellbox php-rpc create — Create the containers
• mw dev shellbox php-rpc destroy — Destroy the containers
• mw dev shellbox php-rpc exec — Execute a command in the main container
• mw dev shellbox php-rpc image — Interact with the image used for the service
• mw dev shellbox php-rpc rebuild — Build images and recreate the containers
• mw dev shellbox php-rpc start — Start the containers
• mw dev shellbox php-rpc stop — Stop the containers

Global options

-c, --context <string>

Development context to use (overrides CONTEXT) Default: default.

--help

Help for this command

--no-interaction

Do not ask any interactive questions

-v, --verbose <count>

Increase output verbosity. Example: --verbose=2 or -vv

See also

• mw dev shellbox