From 0bcc6a02b5cbf00c56473c89e6a6d6f49c42ebd4 Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Mon, 17 Mar 2025 19:35:08 +0100 Subject: Add development instructions --- README.md | 12 +++++++++--- 1 file 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. -- cgit v1.2.3