Skip to content

Commit 5996151

Browse files
authored
update readme
Added advanced usage section and updated image link in README.
1 parent 646dae1 commit 5996151

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ With **built-in evasion techniques**, **custom alias addresses**, and a **revers
1212
- **Instant Download Cradles** – Generate ready-to-use commands in the admin portal.
1313
- **Simple File Uploads** – Use the web interface to upload files or automate using the Dispatch API
1414

15-
<img height="400" alt="dispatch" src="https://github.com/user-attachments/assets/c6ec329b-933d-4560-a3e8-2eeb74095b22" />
15+
<img height="400" alt="dispatch" src="https://github.com/user-attachments/assets/6fa6336c-629d-40da-8088-1128c193deb0" />
1616

1717
## ⚡ Install
1818
Dispatch is designed for **Windows, Linux, and macOS** with minimal dependencies. Simply, execute the following commands to get started:
@@ -39,6 +39,22 @@ Alternatively, install with Poetry and execute using the `dispatch` run command:
3939
python3 -m poetry run dispatch
4040
```
4141

42+
## 🦄 Advanced usage
43+
Set network interfaces using command-line arguments to easily configure automation and deploy Dispatch in the cloud.
44+
45+
*Note: this will override `config.py` and reset values in the database at runtime*
46+
```
47+
> python3 dispatch-server.py -h
48+
--http Server over HTTP (default: False)
49+
--bind-host BIND_HOST Override bind host config
50+
--bind-port BIND_PORT Override bind port config
51+
--external-host EXTERNAL_HOST Set external IP/Hostname of server
52+
--external-port EXTERNAL_PORT Set different external port from bind
53+
54+
> python3 dispatch-server.py --external-host $(curl ident.me) --bind-host 0.0.0.0 --bind-port 443
55+
```
56+
57+
4258

4359
## ⚠️ Disclaimer
4460
Dispatch is intended for authorized security testing. Never test against systems you don’t own or have explicit permission.

0 commit comments

Comments
 (0)