Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GobiasSomeCoffeeCo authored Oct 12, 2024
1 parent 7a5ceb8 commit dea1277
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,14 @@ Create a config.toml file in the same directory as the executable:
```toml

[required]
target_mac = ["12:34:56:AA:CC:EE", "33:34:56:BB:BB:EE", "45:34:56:CC:CC:EE"]
interface = "wlp0s20f0u1u3"
target_mac = ["12:34:56:AA:CC:EE","22:34:56:bb:cc:ee","554456BBCCEE","ab3423febc3d"]
interface = ["wlp0s20f0u2u3", "wlp0s20f0u2u4"]

[optional]
target_ssid = ["TPLink", "UrWifi", "MyWifi", "NotUrWifi"]
kismet_endpoint = "127.0.0.1:2501"

# Kismet Credentials
[credentials]
user = "test"
password = "test"
Expand All @@ -89,22 +94,34 @@ You can specify a different configuration file using the -c flag:
```bash

sudo ./rizzyscope -c /path/to/your/config.toml
```
#### Example 4: Implement --skip-kismet flag to use existing Kismet instance

You can specify a different configuration file using the -c flag:

```bash
sudo ./rizzyscope --skip-kismet
sudo ./rizzyscope -k

```
Configuration

The program can be configured via a TOML file. The default configuration file is config.toml in the current directory.
Configuration File Structure

```toml
# All fields must be filled out.

[required]
target_mac = ["12:34:56:AA:CC:EE", "33:34:56:BB:BB:EE", "45:34:56:CC:CC:EE"] # MAC address to monitor
interface = "wlp0s20f0u1u3" # Network interface to use
target_mac = ["12:34:56:AA:CC:EE","22:34:56:bb:cc:ee","554456BBCCEE","ab3423febc3d"] # Target MACs
interface = ["wlp0s20f0u2u3", "wlp0s20f0u2u4"] # Supports multiple interfaces

[optional]
target_ssid = ["TPLink", "UrWifi", "MyWifi", "NotUrWifi"] # Target by SSID
kismet_endpoint = "127.0.0.1:2501" # Where you want to point the kismet enpoint

# Kismet Credentials
[credentials]
user = "test" # Kismet username
password = "test" # Kismet password
user = "test" # Your kismet username
password = "test" # Your kismet password

```
## How It Works
Expand Down

0 comments on commit dea1277

Please sign in to comment.