Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
niqdev committed Oct 17, 2023
1 parent cffc5ef commit f05fdae
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ hckctl box alpine

# deploys a detached box to a kubernetes cluster
hckctl box start arch --provider kube
# tunnel ports only
# tunnels tty port only
hckctl box open box-arch-<RANDOM> --no-exec

# creates a pwnbox box connected to your hack the box account
Expand All @@ -70,7 +70,7 @@ hckctl box start vulnerable/owasp-juice-shop
> TODO video
Access your target from a managed [`lab`](https://github.com/hckops/megalopolis/tree/main/lab)
* tunnel multiple vpn connections through a high-available proxy
* tunnel multiple vpn connections through a high-available ssh proxy
* expose public endpoints
* pre-mount saved `dumps` (git, s3)
* load secrets from a vault
Expand Down Expand Up @@ -178,7 +178,7 @@ hckctl task trivy --revision v0.1.0

### Config

Edit the default configurations
Override the default configurations
```bash
# prints path and current configs
hckctl config
Expand All @@ -189,10 +189,10 @@ hckctl config --reset

How to configure vpn networks
```bash
# (unix path)
# edits config file
vim ${HOME}/.config/hck/config.yml

# update with your openvpn config path
# example
network:
vpn:
- name: htb
Expand Down Expand Up @@ -297,7 +297,8 @@ Create your custom template and test it locally
hckctl box --local ../megalopolis/box/preview/powershell.yml
```

Please, feel free to contribute to the companion [repository](https://github.com/hckops/megalopolis) and add more community templates to the catalog. Don't forget to :star: the project!
Please, feel free to contribute to the companion [repository](https://github.com/hckops/megalopolis) and add more community templates to the catalog.
Credits should go to all the authors and maintainers for their amazing open source tools, without them this project wouldn't exist!

<!--
Expand Down

0 comments on commit f05fdae

Please sign in to comment.