.
This commit is contained in:
24
README.md
24
README.md
@@ -1,5 +1,4 @@
|
||||
# Watchman
|
||||
#### (work-in-progress)
|
||||
## Detect and Act on unauthorized access of any kind from any source
|
||||
|
||||
### Detect and Act on;
|
||||
@@ -12,14 +11,22 @@
|
||||
|
||||
### Install
|
||||
```shell
|
||||
## install binary
|
||||
# Install the binary from crates.io
|
||||
cargo install watchman
|
||||
## configure service with discord webhook
|
||||
watchman install-service webhook=https://discordapp.com/api/webhooks/121946119953658680...
|
||||
|
||||
# Configure as a system service (optional; requires root)
|
||||
# Linux (systemd) / macOS (launchd)
|
||||
watchman --service install --webhook-url https://discord.com/api/webhooks/XXXXXXXX/XXXXXXXX
|
||||
```
|
||||
|
||||
# Setup
|
||||
### create config/Settings.toml
|
||||
### Configuration
|
||||
The first run will create a default settings file if missing. Default locations:
|
||||
- Linux: ~/.config/watchman/config/settings.toml
|
||||
- macOS: /Users/<user>/Library/Application Support/com.helloimalemur.watchman/config/settings.toml
|
||||
- Windows: %APPDATA%\Watchman\config\settings.toml
|
||||
|
||||
Or create it manually:
|
||||
```shell
|
||||
## General settings
|
||||
tick_delay_seconds = "5"
|
||||
@@ -74,4 +81,9 @@ This project embraces the theme of vigilant watchfulness.
|
||||
- 1 Peter 5:8 — "Be sober-minded; be watchful. Your adversary the devil prowls around like a roaring lion."
|
||||
- Proverbs 4:23 — "Keep your heart with all vigilance, for from it flow the springs of life."
|
||||
|
||||
These verses inspire the intent of Watchman: to observe faithfully, detect wisely, and act prudently.
|
||||
These verses inspire the intent of Watchman: to observe faithfully, detect wisely, and act prudently.
|
||||
## Safety Notes
|
||||
- This tool can perform disruptive actions (rebooting, unmounting encrypted volumes). All such actions are disabled by default and must be explicitly enabled in settings.toml.
|
||||
- Service installation writes to system locations (/etc/systemd/system on Linux, /Library/LaunchDaemons on macOS) and requires root. Review the generated unit file before enabling.
|
||||
- Network scanning features (client discovery and nmap scans) should be used responsibly and only on networks you are authorized to test.
|
||||
- Discord webhooks leak to a third-party service; do not include sensitive data in messages.
|
||||
|
||||
Reference in New Issue
Block a user