|
1 | 1 | Codejail plugin for `Tutor`_ |
2 | 2 | ============================ |
3 | 3 |
|
4 | | -Tutor plugin that configures and runs a `Codejail Service`_ using a REST API. `Codejail`_ allows for the |
5 | | -secure execution of untrusted code within sandboxes, providing a safe environment for running potentially dangerous code. |
| 4 | +Tutor plugin that configures and runs a `Codejail Service`_ using a REST API. |
| 5 | +`Codejail`_ allows for the secure execution of untrusted code within sandboxes, |
| 6 | +providing a safe environment for running potentially dangerous code. |
| 7 | + |
| 8 | +Starting from the Ulmo release, the codejail plugin is transitioning to an |
| 9 | +alternative implementation of the safe-exec API ( `_Codejail Service V2`_). |
| 10 | +You can opt-in to use this new implementation on Ulmo before it finally becomes |
| 11 | +the default on the Verawood release. |
6 | 12 |
|
7 | 13 | .. _Tutor: https://docs.tutor.overhang.io |
8 | 14 | .. _Codejail Service: https://github.com/eduNEXT/codejailservice |
@@ -69,7 +75,13 @@ To customize the configuration, update the following settings in Tutor: |
69 | 75 | - ``SERVICE_V2_VERSION``: (default: ``{{ OPENEDX_COMMON_VERSION }}``) |
70 | 76 | - ``USE_SERVICE_V2``: (default: ``False``) |
71 | 77 |
|
72 | | -The ``CODEJAIL_V2_*`` settings are meant to be used only during the Ulmo release a |
| 78 | +The ``CODEJAIL_V2_*`` settings are meant to be used only during the Ulmo |
| 79 | +release and will be phased-out during the Verawood release. |
| 80 | + |
| 81 | +To opt-in to the new implementation of the code-exec API set ``USE_SERVICE_V2`` |
| 82 | +to ``True`` and re-deploy your environment. If you are using a a custom image |
| 83 | +for the codejail service you will need to rebuild it with ``USE_SERVICE_V2`` |
| 84 | +set to ``True`. |
73 | 85 |
|
74 | 86 | Custom Image |
75 | 87 | ~~~~~~~~~~~~ |
|
0 commit comments