From cf7d10aa5ccd5d97f3f6bdbcea59c1539b2ac5ea Mon Sep 17 00:00:00 2001
From: David Beniamine <david.beniamine@tetras-libre.fr>
Date: Sun, 27 Nov 2022 23:48:17 +0100
Subject: [PATCH] documentation

---
 Readme.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..cad7454
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,20 @@
+# Chroot demo
+
+This is a small script to create and setup a chroot
+
+To test edit the setup.sh script and change the BINARIES line to add the binaries you want.
+
+Then run `./setup.sh` it will create a `jail` directory next to the script.
+
+Finally run `sudo chroot jail` you should obtain a chrooted shell with only this executables
+
+## Warnings and limitation
+
+This is only a very small script for demonstrating what a chroot is.
+
+The script is not robust :
+
++ It only copies binaries no config files are shared files
++ Special directories are not mounted to the chroot, so no network, no devices etc.
++ lib64 is hardly coded, lib32 is not supported
++ I **do not** plan to maintain this script in any way
-- 
GitLab