https://github.com/sdslabs/katana

An advanced yet simple attack/defence CTF infrastructure in Go
https://github.com/sdslabs/katana

Last synced: about 1 year ago
JSON representation

An advanced yet simple attack/defence CTF infrastructure in Go

• Host: GitHub
• URL: https://github.com/sdslabs/katana
• Owner: sdslabs
• License: mit
• Created: 2020-05-14T20:57:13.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2024-06-10T18:47:24.000Z (about 2 years ago)
• Last Synced: 2024-06-10T21:44:16.457Z (about 2 years ago)
• Language: Go
• Size: 56 MB
• Stars: 12
• Watchers: 9
• Forks: 0
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# katana

An advanced yet simple attack/defence CTF infrastructure in Go build upon k8s.

## Setup

- Clone the repo with the submodules

  - `git clone --recurse-submodules `

- To start, you must have the following installed:

  - Go 1.18+

  - Minikube & kubectl

- Copy config file and make your changes

  - `cp config.sample.toml config.toml`

  - update the kubeconfig path

- Copy challenges-sample as challenges

  - `cp -r challenges-sample challenges`

- Run `make set-env` to setup the environment locally.

- Run `make set-env-prod` to setup the environment for production.

- 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.