-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
7 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,15 @@ | ||
# katana | ||
An advanced yet simple attack/defence CTF infrastructure in Go | ||
An advanced yet simple attack/defence CTF infrastructure in Go build upon k8s. | ||
|
||
## Setup | ||
- To start, you must have the following installed: | ||
- Go 1.18+ | ||
- Minikube & kubectl | ||
- Run `make set-env` to setup the environment | ||
- To start katana, run `./bin/katana run` | ||
|
||
## Docs | ||
- To get the most stable docs : | ||
- Setup docs locally by running `make setup-docs` followed by `hugo serve` from the `docs` directory. | ||
- The docs are also available at [https://blog.sdslabs.co/katana](https://blog.sdslabs.co/katana/Katana/getting-started/). | ||
- To visit the most updated docs, it's advised to setup the docs locally from the docs branch. |