diff --git a/README.md b/README.md new file mode 100644 index 0000000..d869203 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# ClawdBox + +A persistent sandbox environment for Clawdbot (OpenClaw). + +## Purpose +This container provides a stable, tool-rich environment for the AI agent to: +- Persist state across agent restarts. +- Run long-running processes. +- Perform "messy" work (compiling, scraping, data processing) without polluting the main agent container or host. +- Use tools that aren't available in the minimal agent environment. + +## Tools Included +- **Core:** curl, wget, git, jq, yq, unzip, tar, vim/nano +- **Dev:** python3 (pip/venv), build-essential, nodejs, npm +- **Network:** ping, dnsutils, net-tools +- **Media:** ffmpeg +- **Access:** openssh-server + +## Deployment (OpenShift / K8s) + +1. **Build Image:** + ```bash + docker build -t clawdbox . + ``` + +2. **Run with Persistence:** + Ensure you mount a PVC to `/data` to keep files across restarts. + + ```yaml + apiVersion: v1 + kind: Pod + metadata: + name: clawdbox + spec: + containers: + - name: clawdbox + image: clawdbox:latest + ports: + - containerPort: 22 + volumeMounts: + - mountPath: /data + name: claw-data + volumes: + - name: claw-data + persistentVolumeClaim: + claimName: claw-pvc + ``` + +## Access +Connect via SSH using the `claw` user (passwordless sudo enabled). \ No newline at end of file