From 939513d5784a73ded3c590f92714028bed6268cc Mon Sep 17 00:00:00 2001
From: Sebastian Hugentobler <shu@vanwa.ch>
Date: Tue, 3 Jun 2025 08:21:41 +0200
Subject: [PATCH] add readme

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f4b8df4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Jenkins SSH Agent with Podman
+
+Based on [jenkins/ssh-agent](https://hub.docker.com/r/jenkins/ssh-agent) with
+the addition of rootless podman.
+
+In order for running this container within podman, the following options should
+be set:
+
+- --security-opt=label=disable
+- --security-opt=unmask=ALL
+- --security-opt=seccomp=unconfined
+- --device=/dev/net/tun
+
+## Environment Variables
+
+- `JENKINS_AGENT_SSH_PUBKEY`: SSH public key accepted by the agent.
+
+## Volumes
+
+- `/home/jenkins`: state
+
+## Ports
+
+- `22`: ssh server