diff --git a/README.md b/README.md new file mode 100644 index 0000000..b5f3cad --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Podterminal + +This project is a small go reverse proxy that spins up a container for each session, allowing multiple simultaneous +Users to use Webtop in their own, separate session. A good illustration is this: +![Webtop Inception](doc/podterminal_inception.png) + +## Building +To build the project, you can just use "make" + +## Running +To run the built binary, just execute it as root. You will have to have Podman installed and its socket enabled. +Currently you have to set the Image, port etc. directly in the Source Code, however that should be eventually moved into +a config file. diff --git a/doc/podterminal_inception.png b/doc/podterminal_inception.png new file mode 100644 index 0000000..2c33341 Binary files /dev/null and b/doc/podterminal_inception.png differ