Skip to content

Commit 4f5bb4b

Browse files
committed
docs: Update the readme for those setting up codejail themselves.
1 parent d8003a2 commit 4f5bb4b

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.rst

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ using the same API, but will not guard against malicious code. This allows the
1919
same code to be used on safe-configured or non-safe-configured developer's
2020
machines.
2121

22-
A CodeJail sandbox consists of several pieces:
22+
A CodeJail sandbox consists of several pieces:
2323

2424
#) Sandbox environment. For a Python setup, this would be Python and
2525
associated core packages. This is denoted throughout this document
26-
as **<SANDENV>**. This is read-only.
26+
as **<SANDENV>**. This is read-only.
2727

2828
#) Sandbox packages. These are additional packages needed for a given
2929
run. For example, this might be a grader written by an instructor
@@ -34,7 +34,7 @@ A CodeJail sandbox consists of several pieces:
3434
#) Untrusted packages. This is typically the code submitted by the
3535
student to be tested on the server, as well as any data the code
3636
may need to modify. This is denoted throughout this document as
37-
**<UNTRUSTED_PACK>**. This is currently read-only, but may need to
37+
**<UNTRUSTED_PACK>**. This is currently read-only, but may need to
3838
be read-write for some applications.
3939

4040
#) OS packages. These are standard system libraries needed to run
@@ -48,6 +48,20 @@ sandboxes. This will be referred to as **<SANDBOX_CALLER>**. The
4848
second account is the account under which the sandbox runs. This is
4949
typically the account 'sandbox.'
5050

51+
Supported Versions
52+
------------------
53+
54+
This library currently is tested to work with the following versions
55+
56+
Python:
57+
58+
* 3.11
59+
60+
Ubuntu:
61+
62+
* 20.04
63+
* 22.04
64+
5165
Installation
5266
------------
5367

@@ -129,6 +143,10 @@ Other details here that depend on your configuration:
129143

130144
7. Reactivate your project's main virtualenv again.
131145

146+
8. Disable using PAM to set rlimits::
147+
148+
sed -i '/pam_limits.so/d' /etc/pam.d/sudo
149+
132150
Using CodeJail
133151
--------------
134152

@@ -142,7 +160,7 @@ commands at your Python terminal::
142160
codejail.safe_exec.safe_exec("output=open('/etc/passwd').read()", jailed_globals)
143161
print(jailed_globals) # should be unreachable if codejail is working properly
144162

145-
This should fail with an exception.
163+
This should fail with an exception.
146164

147165
If you need to change the packages installed into your sandbox's virtualenv,
148166
you'll need to disable AppArmor, because your sandboxed Python doesn't have

0 commit comments

Comments
 (0)