Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
niqdev committed Oct 12, 2023
1 parent 073bddf commit fb87708
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,18 @@ Leverage the cloud platform or request a dedicated managed cluster to:

Spin-up a [`box`](https://github.com/hckops/megalopolis/tree/main/box) and access all port-forwarded ports locally
```bash
# spawns a temporary docker (default) box locally
# spawns a temporary docker (default provider) box locally
hckctl box alpine

# deploys an ephemeral box to your kubernetes cluster
hckctl box arch --provider kube
# deploys a detached box to your kubernetes cluster
hckctl box start arch --provider kube
# tunnel tty port
hckctl box open box-arch-<RANDOM> --no-exec

# creates a managed box (preview)
# creates a managed box (cloud provider preview)
hckctl box parrot --provider cloud
# connects to vnc
vncviewer localhost:5900
```

#### HTB demo
Expand Down Expand Up @@ -82,7 +86,7 @@ hckctl box preview/parrot-sec --network-vpn htb

Access your target from a managed [`lab`](https://github.com/hckops/megalopolis/tree/main/lab)
```bash
# connects to a vpn, exposes public ports, mount dumps (git, s3), store secrets, etc.
# connects to a vpn, exposes public ports, mounts dumps (git, s3), loads secrets, etc.
hckctl lab ctf-linux
```

Expand Down Expand Up @@ -173,7 +177,7 @@ hckctl template list
hckctl template validate "../megalopolis/**/*.{yml,yaml}"
```

Inspired by [GitOps](https://www.gitops.tech), the whole project is centered around git as source of truth, schema validation and versioning. Simply pin a `revision` (branch, tag, or sha) if you need to ensure long term stability
Inspired by [GitOps](https://www.gitops.tech), the whole project is centered around git as source of truth, schema validation and versioning. Pin a `revision` (branch, tag, or sha) if you need to ensure long term stability
```bash
# uses template "megalopolis/task/scanner/trivy" @ commit hash "12e7599"
hckctl task trivy --revision v0.1.0
Expand Down Expand Up @@ -289,14 +293,14 @@ Please, feel free to contribute to the companion [repository](https://github.com

<!--

* task kube tee log file
* task/box kube shareDir vs copy dir
* task kube interrupt
* task/box kube shareDir vs copy dir
* replace task/htb example with thm
* verify/support kube config relative path
* update cloud pkg
* update platform prs
* verify network connectivity between boxes/tasks i.e. kube.svc
* test on mac-m1 and win (docker images)

TODO demo
* auto-exploitation box
Expand Down

0 comments on commit fb87708

Please sign in to comment.