From 4603f8d938ccadeac4188eef8c2f056bb60c6c8e Mon Sep 17 00:00:00 2001 From: Abhinav Sinha Date: Mon, 15 Jun 2026 08:03:23 +0530 Subject: [PATCH] chore: add security warning in `README.md` for privileged mode Signed-off-by: Abhinav Sinha --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b1d217e..e1cf677 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ Open **http://localhost:7554** — wait ~30 seconds for the *Cluster Ready* indi > `--privileged` is required — K3s needs access to kernel namespaces and cgroups. +> **Security Warning:** Do **not** expose this container publicly. Use it only on your local machine as it is meant for educational purposes only. + ### Persist Progress ```bash @@ -115,8 +117,8 @@ Everything runs inside a **single Docker image** managed by `scripts/entrypoint. ``` scenarios/ -├── data/ # One JSON file per scenario → .json -├── bundles/ # One JSON file per bundle → .json +├── data/ # One JSON file per scenario -> .json +├── bundles/ # One JSON file per bundle -> .json └── SCHEMA.md # Full schema reference backend/ @@ -126,7 +128,7 @@ frontend/ └── src/ # React + Vite SPA scripts/ -├── entrypoint.sh # Container startup (k3s → API → nginx) +├── entrypoint.sh # Container startup (k3s -> API -> nginx) └── nginx.conf # Reverse-proxy config ```