Go to file
jenkins-bot 0def276b12 Merge "Minor cleanup" 2024-05-04 23:31:05 +00:00
.phan build: Switch phan to special library mode 2023-04-17 21:08:48 +00:00
.pipeline blubber: Use lilypond component 2024-04-15 18:27:57 +02:00
build doc: Restore Doxygen welcome page 2021-01-18 05:52:17 +00:00
config Server-side shell command validation 2021-01-28 14:31:44 +11:00
public_html Shellbox initial source files 2020-11-10 14:20:49 +11:00
src build: Update mediawiki/mediawiki-codesniffer to v43.0.0 2024-03-06 09:42:23 -05:00
syntaxhighlight syntaxhighlight: Update Pygments to 2.17.2 2023-12-01 22:57:19 +00:00
tests Minor cleanup 2024-05-04 23:28:28 +00:00
.editorconfig build: Sync with latest cookiecutter boilerplate 2021-08-10 13:57:18 -07:00
.gitattributes build: Sync with latest cookiecutter boilerplate 2021-08-10 13:57:18 -07:00
.gitignore dev: Replace blubberoid with blubber buildkit 2024-02-12 10:48:43 -07:00
.gitreview Library for containerized shell execution (initial commit) 2020-09-16 11:40:24 +10:00
.phpcs.xml build: Updating mediawiki/mediawiki-codesniffer to 38.0.0 2021-10-26 13:29:40 -07:00
CODE_OF_CONDUCT.md build: Sync with latest cookiecutter boilerplate 2021-08-10 13:57:18 -07:00
Doxyfile build: Sync with latest cookiecutter boilerplate 2021-08-10 13:57:18 -07:00
HISTORY.md Release 4.0.2 2024-03-05 12:51:38 -05:00
LICENSE build: Sync with latest cookiecutter boilerplate 2021-08-10 13:57:18 -07:00
Makefile dev: Replace blubberoid with blubber buildkit 2024-02-12 10:48:43 -07:00
README.md Link to [[mw:Shellbox]] in README 2021-08-10 13:57:18 -07:00
composer.json build: Update mediawiki/mediawiki-codesniffer to v43.0.0 2024-03-06 09:42:23 -05:00
composer.lock Update composer.lock 2024-04-28 15:23:17 +01:00
docker-compose.yml dev: Replace blubberoid with blubber buildkit 2024-02-12 10:48:43 -07:00
phpunit.xml.dist build: Sync with latest cookiecutter boilerplate 2021-08-10 13:57:18 -07:00

README.md

Shellbox

Shellbox is a library and server for containerized shell execution.

More information on how to set up and configure Shellbox is available at https://www.mediawiki.org/wiki/Shellbox.

Set up your dev environment

Granted you have docker-compose installed, and that you can issue docker commands as your user, you can have a working development setup by running

$ make run

this will build an appropriate container for your application (if not present) and run the whole httpd/php-fpm combo for you, and listen on port 8080. It will use your local source as a volume, so you will be able to see changes in the code reflected in responses from the daemon instantly.

If you change the dependencies, and thus composer.json or composer.lock, you will have to force a rebuild of the container, by using

$ make rebuild

To run the tests that run in CI locally (also via docker), you need can use make test.