aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Johannes Christ <[email protected]>2025-03-17 19:35:08 +0100
committerGravatar Johannes Christ <[email protected]>2025-03-17 19:50:53 +0100
commit0bcc6a02b5cbf00c56473c89e6a6d6f49c42ebd4 (patch)
tree35e76110f7cd4ffdfc4175bd41a2037660a13f93
parentAdd unshare support (diff)
Add development instructions
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index 0fc69a1..099821d 100644
--- a/README.md
+++ b/README.md
@@ -16,10 +16,10 @@ With `poetry-restrict-plugin`, that looks as follows:
```sh
$ poetry run cat ~/.ssh/config
-poetry-restrict-plugin: Landlock engaged.
+poetry-restrict-plugin: Landlocked & unshared.
cat: /home/jc/.ssh/config: Permission denied
$ poetry run ls ~/.ssh
-poetry-restrict-plugin: Landlock engaged.
+poetry-restrict-plugin: Landlocked & unshared.
ls: cannot open directory '/home/jc/.ssh': Permission denied
```
@@ -27,7 +27,8 @@ ls: cannot open directory '/home/jc/.ssh': Permission denied
## Installation
`poetry-restrict-plugin` is currently only supported on Linux with [the Landlock
-LSM](https://docs.kernel.org/userspace-api/landlock.html) enabled.
+LSM](https://docs.kernel.org/userspace-api/landlock.html) enabled. It also
+requires user namespacing to be enabled.
Installation depends on how you installed Poetry. With
[`pipx`](https://pipx.pypa.io/stable/docs/):
@@ -56,6 +57,11 @@ error with it and need an escape hatch, you can re-run your command with the
environment variable `POETRY_NO_RESTRICT=1` set.
+## Development
+
+Please send patches to me by e-mail.
+
+
## Disclaimer
`poetry-restrict-plugin` is not a perfect sandbox, and probably never will be.