diff --git a/README.md b/README.md index 74dd022..4721f7b 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,31 @@ Everything is done in a heavily throttled manner for stealth to avoid detection. ## Opt-out The IRC networks we scanned are PUBLIC networks...any person can freely connect & parse the same information. Send your hate mail to [scan@internetrelaychat.org](mailto://scan@internetrelaychat.org) +## Config +###### Settings +| Setting | Default Value | Description | +| ---------- | ------------------------------ | --------------------------------------------------------------- | +| `errors` | `False` | Show errors in console | +| `nickname` | `"IRCP"` | IRC nickname *(`None` = random)* | +| `username` | `"ircp"` | IRC username *(`None` = random)* | +| `realname` | `"internetrelaychat.org"` | IRC realname *(`None` = random)* | +| `ns_mail` | `"scan@internetrelaychat.org"` | NickServ email address *(`None` = random@random.[com|net|org])* | +| `ns_pass` | `"changeme"` | NickServ password *(None = random)* | +| `vhost` | `None` | Bind to a specific IP address | + +###### Throttle +| Setting | Default Value | Description | +| ---------- | ------------- | -------------------------------------------------------------- | +| `channels` | `3` | Maximum number of channels to scan at once +| `delay` | `120` | Delay before registering nick (if enabled) & sending /LIST +| `join` | `10` | Delay between channel JOINs +| `nick` | `300` | Delay between every random NICK change +| `part` | `3` | Delay before PARTing a channel +| `threads` | `100` | Maximum number of threads running +| `timeout` | `15` | Timeout for all sockets +| `whois` | `3` | Delay between WHOIS requests +| `ztimeout` | `200` | Timeout for zero data from server + ## Collected Information All of the raw data from a server is logged & stored. The categories below are stored seperately & hilight the key information we are after: