From aa3f5d04ee439898ed9d131ac4c80397aa317420 Mon Sep 17 00:00:00 2001 From: Stuart Winchester Date: Fri, 9 Oct 2020 16:57:10 +0100 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ca1a11f..5bde0e2 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,16 @@ which was forked from psdoom. ![DOOM](assets/doom.jpg) -## Usage +## Running Locally -Run `storaxdev/kubedoom:0.4.0` locally: +In order to run locally you will need to + +1. Run the kubedoom container +2. Attach a VNC client to the appropriate port (5901) + +### With Docker + +Run `storaxdev/kubedoom:0.4.0` with docker locally: ```console $ docker run -p5901:5900 \ @@ -23,6 +30,19 @@ $ docker run -p5901:5900 \ storaxdev/kubedoom:0.4.0 ``` +### With Podman + +Run `storaxdev/kubedoom:0.4.0` with podman locally: + +```console +$ podman run -it -p5901:5900/tcp \ + -v ~/.kube:/tmp/.kube --security-opt label=disable \ + --env "KUBECONFIG=/tmp/.kube/config" --name kubedoom + storaxdev/kubedoom:0.4.0 +``` + +### Attaching a VNC Client + Now start a VNC viewer and connect to `localhost:5901`. The password is `1234`: ```console $ vncviewer viewer localhost:5901