Skip to content

Latest commit

 

History

History
154 lines (90 loc) · 5.56 KB

README.md

File metadata and controls

154 lines (90 loc) · 5.56 KB
Raw

JobeInABox

Docker Stars Docker Pulls Docker Automated Docker Build

The Moodle CodeRunner question type plugin requires a Jobe server on which to run student-submitted jobs. JobeInABox is a Docker image that provides a basic Jobe server that runs all the standard languages. For full information on Jobe servers, see the full Jobe documentation

NOTE: for security and performance reasons it is strongly recommended to run Jobe on a dedicated standalone server, even when running it in a container.

Building and running your own image locally (strongly recommended)

There are several ways to build and run a JobeInABox container, for example:

For production use you should build your own image using the local timezone. In this example we use Docker as follows:

Pull this repo from Github, cd into the jobeinabox directory and type a command of the form

sudo docker build . -t my/jobeinabox --build-arg TZ="Europe/Amsterdam"

You can then run your newly-built image with the command

sudo docker run -d -p 4000:80 --name jobe my/jobeinabox

This will give you a jobe server running on port 4000, which can then be tested locally and used by Moodle as explained in the section "Using jobeinabox" below.

Using the pre-built jobeinabox image on docker hub

To run the pre-built Docker Hub image, just enter the command:

sudo docker run -d -p 4000:80 --name jobe trampgeek/jobeinabox:latest

This will give you a jobe server running on port 4000, which can then be tested locally and used by Moodle as explained in the section "Using jobeinabox" below.

Setting the number of jobe users

By default, Jobe will run up to 8 jobs simultaneously. This is usually a suitable value for 8-core systems but if you have more cores available you will probably want to raise this number. To do so, exec a shell in the container with a command of the form

docker exec -it jobe bash

and then:

nano  /var/www/html/jobe/app/Config/Jobe.php

Find the line

public int $jobe_max_users = 8;

and change the value from 8 to the number of cores on your machine, or to a higher value if you expect to run mainly I/O-bound jobs.

Then re-install Jobe (within the container) with the commands:

cd /var/www/html/jobe
./install --purge

Checking performance

You can check the performance of the container with the command

docker exec -it jobe /var/www/html/jobe/testsubmit.py --perf

Using API Keys

You can provide API keys during the image build via the --secret option.

The keys can be stored in a separate file, following the format:

'c1425880-2289-4b76-ae29-bcea34997256' => 0,
'de7970e6-0466-4ce2-a6a4-c1a51363bd03' => 90

You can find more information on API keys in the Jobe documentation.

With the following command the keys stored in a file called api_keys in the jobeinabox directory are automatically added to /var/www/html/jobe/app/Config/Jobe.php and the option $require_api_keys is set to true.

podman build . -t my/jobeinabox --secret id=api_keys,src=api_keys

If no API keys are provided the configuration remains untouched.

Warnings:

  1. The image is over 1 GB, so may take a long time to start the first time, depending on your download bandwidth.

Using jobeinabox

Having started a jobeinabox container by either of the above methods, you can check it's running OK by browsing to

 http://[host_running_docker]:4000/jobe/index.php/restapi/languages

and you should get a JSON-encoded list of the supported languages, namely

[["c","7.3.0"],["cpp","7.3.0"],["java","10.0.2"],["nodejs","8.10.0"],["octave","4.2.2"],["pascal","3.0.4"],["php","7.2.7"],["python3","3.6.5"]]

If you wish to run the test suite within the container, use the command

sudo docker exec -t jobe /usr/bin/python3 /var/www/html/jobe/testsubmit.py

To set your Moodle/CodeRunner plugin to use this dockerised Jobe server, set the Jobe server field in the CodeRunner admin settings (Site Administration > Plugins > Question types > CodeRunner) to

[host_running_docker]:4000

Do not put http:// at the start.

To stop the running server, enter the command:

sudo docker stop jobe

To remove the running server, enter the command:

sudo docker rm jobe

To check if there is anything left, enter the command

sudo docker ps -a

Notes on security:

  1. Note that while the container in which this Jobe runs should be secure, the container's network is currently just bridged across to the host's network. This means that Jobe can be accessed from anywhere that can access the host and can access any URI that the host can access. Firewalling of the host is essential for production use.

  2. Rebuild the container regularly to ensures that it is running with the latest jobe version and security updates.

Change history (recent changes only)

18/10/24:

  • API key configuration can now be specified during build using Docker's "--secret" functionality (thanks @theLogicJB).

  • Fix broken documentation on changing the number of Jobe servers.