Skip to content

Commit ba3af23

Browse files
authored
docs: Include warn/error flags in codejail apparmor instructions (#127)
Also include a note about how to make the profile persistent.
1 parent 1cd0fd8 commit ba3af23

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/codejail.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@ In order to run the codejail devstack component:
1919

2020
#. Install AppArmor: ``sudo apt install apparmor``
2121
#. Clone the `<https://github.com/edx/public-dockerfiles>`__ repo as a sibling to your devstack checkout.
22-
#. Add the provided codejail AppArmor profile to your OS: ``sudo apparmor_parser --replace -W ../public-dockerfiles/apparmor/openedx_codejail_service.profile``
22+
#. Add the provided codejail AppArmor profile to your OS: ``sudo apparmor_parser --replace -W --warn=all --warn=no-debug-cache --Werror ../public-dockerfiles/apparmor/openedx_codejail_service.profile``.
23+
24+
* You can also copy the file into ``/etc/apparmor.d/`` to make it persistent across reboots.
25+
* During profile development you may need to remove the ``--Werror``, which is there to block loading of profiles that validate with warnings. Be sure to address all warnings before making a PR for any profile changes.
26+
2327
#. Configure LMS and CMS to use the codejail-service by uncommenting ``# ENABLE_CODEJAIL_REST_SERVICE = True`` in ``py_configuration_files/{lms,cms}.py``
2428
#. Run ``make codejail-up``
2529

0 commit comments

Comments
 (0)