From 99a01d07fac410b6127daff1ccb88a35c4f6f705 Mon Sep 17 00:00:00 2001 From: "Christoph J. Scherr" Date: Mon, 9 Sep 2024 12:15:18 +0200 Subject: [PATCH] docs: readme make it officially a ctf-hosting platform --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4f96b50..0960c27 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Wooly-Vault -A few small challenges for ⚒️ Rust Hackers 🦀 +Managing Platform for Hacking challenges, written in Rust 🦀. + +Wooly-Vault is a small platform for hosting CTF-like hacking challenges. It is +currently in the early stages of development. ## Configuration @@ -42,7 +45,7 @@ you should probably use some kind of VM, or at least a container to host this. ### Docker -Wooly-Vault has a [Dockerfile](./Dockerfile) and a +Wooly-Vault has a [Dockerfile](./Dockerfile) and a [docker compose specification](./docker-compose.yml), so you can run it easily in a docker container: @@ -50,7 +53,7 @@ easily in a docker container: WOOLY_SECRET=my_flag docker compose up ``` -To configure what challenge is served and on what networking adress, tweak +To configure what challenge is served and on what networking adress, tweak [docker-compose.yml](./docker-compose.yml). ### The regular way