summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorMalfurious <m@lfurio.us>2023-03-30 02:46:43 -0400
committerdusoleil <howcansocksbereal@gmail.com>2023-03-31 22:23:34 -0400
commitde95a406075f87704ac3a884f3750d3656058891 (patch)
tree6c47c96e7a5ff33152726c3febaf7c492e0793a4 /README.txt
parent5b0e6af99723b362052c9f5bbba1743170848f8d (diff)
downloadsploit-de95a406075f87704ac3a884f3750d3656058891.tar.gz
sploit-de95a406075f87704ac3a884f3750d3656058891.zip
Add sploit Docker image
Signed-off-by: Malfurious <m@lfurio.us> Signed-off-by: dusoleil <howcansocksbereal@gmail.com>
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.txt b/README.txt
index 1199c36..7684815 100644
--- a/README.txt
+++ b/README.txt
@@ -55,3 +55,28 @@ You can also directly run sploit scripts with the following shebang
```
#!/usr/bin/env sploit
```
+
+Docker Image
+--------------
+In addition to a local pip install, sploit is also deployable via Docker. Build
+the image using the supplied Dockerfile with:
+```
+$ docker build -t sploit .
+```
+
+The container runs in the style of an application, and therefore expects to be
+interactive. Also note that it is useful to mount your working directory in the
+container, so that the running sploit instance can actually access your target
+files or expose its pipes to you (the default working dir of the container is
+/home). Therefore a basic command to run a containerized sploit would be:
+```
+$ docker run --rm -it -v $PWD:/home sploit exploit.py ./target target_args
+```
+
+The use of Scuba (pip install scuba) is recommended to make using ephemeral,
+interactive containers more convenient. In this case it has the added benefit
+of automatically creating and executing within an unprivileged user inside the
+container:
+```
+$ scuba --image sploit exploit.py ./target target_args
+```