Skip to content

armgit / ARES

Public Imported from GitHub
0

ARES - authorized red-team engagement automation with dashboard, campaign scope, module orchestration, OPSEC controls, encrypted vault, and reporting.

docs: polish README and quickstart consistency

Mafifrizi5474fab10600
diff --git a/QUICKSTART.md b/QUICKSTART.md
index 96d3f89..837a50b 100644
--- a/QUICKSTART.md
+++ b/QUICKSTART.md
@@ -285,7 +285,7 @@ Dashboard API keys authenticate scripts and integrations to ARES itself.
Use them as:
```bash
-curl http://localhost:8080/campaigns \
+curl http://127.0.0.1:8080/campaigns \
-H "X-API-Key: ares_YOUR_KEY"
```
diff --git a/README.md b/README.md
index 2f5dd97..6d5bda6 100644
--- a/README.md
+++ b/README.md
@@ -275,7 +275,7 @@ Create additional users through the API while logged in as `team_lead`:
```powershell
$token = (Invoke-RestMethod `
-Method Post `
- -Uri http://localhost:8080/auth/token `
+ -Uri http://127.0.0.1:8080/auth/token `
-ContentType "application/x-www-form-urlencoded" `
-Body "username=admin&password=YOUR_CURRENT_ADMIN_PASSWORD").access_token
@@ -283,7 +283,7 @@ $headers = @{ Authorization = "Bearer $token" }
Invoke-RestMethod `
-Method Post `
- -Uri http://localhost:8080/auth/register `
+ -Uri http://127.0.0.1:8080/auth/register `
-Headers $headers `
-ContentType "application/json" `
-Body (@{
@@ -352,7 +352,7 @@ $bytes = [byte[]]::new(32)
[System.Security.Cryptography.RandomNumberGenerator]::Fill($bytes)
$env:ARES_SECRET_KEY = -join ($bytes | ForEach-Object { $_.ToString("x2") })
-$env:ARES_ENCRYPTION_KEY = .\.venv\Scripts\python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
+$env:ARES_ENCRYPTION_KEY = .\.venv\Scripts\python.exe -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
$env:ARES_DEFAULT_ADMIN_PASSWORD = "replace-with-your-own-strong-admin-password"
```
@@ -460,7 +460,7 @@ http://127.0.0.1:5173/dashboard/
### 3. Check Health
```powershell
-Invoke-RestMethod http://localhost:8080/health
+Invoke-RestMethod http://127.0.0.1:8080/health
```
Expected:
@@ -494,6 +494,12 @@ configuration, settings loading, and database connectivity.
ares doctor
```
+Windows virtualenv example:
+
+```powershell
+.\.venv\Scripts\ares.exe doctor
+```
+
A green check means the dependency is available. A yellow warning usually means
an optional module family or external OS tool is not installed. It does not
block the base dashboard, API, validation lab, or unit suite. A red failure