Installer reference
All host-side operations go through install.sh in the cloned repository. It needs python3 and runs as root
(sudo). Run it without a command for an interactive menu.
sudo ./install.sh [COMMAND] [TARGET] [OPTIONS]
./install.sh --help
Use --dry-run with the install, add-decoy, remove-decoy, set-access, update and uninstall commands to see what would
happen without changing anything. Only one installer runs at a time.
Commands
| Command |
What it does |
| (none) |
interactive menu: manager or sensor install |
manager |
install the manager and its local decoys on this server. See Install the manager |
sensor |
install a remote sensor that reports to a manager. See Remote sensors |
add-decoy |
add one local decoy on a free interface, keeping persona, baits and running decoys. See Decoys |
remove-decoy NAME |
remove a local decoy and free its slot |
set-access |
change the web UI, sensor API and host SSH allow-lists of a manager. See Access allow-lists |
update |
in-place update of this manager or sensor, with backup and rollback. See Update |
uninstall |
remove ReD-Pot and restore the host. See Uninstall |
reset-token |
issue a new admin token; optionally a new wall link. See SOC wall screen |
geoip |
download the GeoIP database later (world attack map) and restart the console |
export |
JSON export of incidents and alert records for a date range. See Alerts, SIEM and export |
Options
General
| Option |
Used by |
Meaning |
--yes |
all |
accept defaults (unattended). A default is used only if it is valid; otherwise the run stops and names the flag. See Unattended install |
--dry-run |
install and change commands |
show what would happen, change nothing |
--dir DIR |
all |
install directory (default /opt/redpot/manager for a manager) |
--force |
manager, sensor |
redo an existing install (new persona, baits and token) |
--force |
export |
replace an existing output file (your own regular file only) |
--build |
manager, sensor |
build the Docker image locally instead of downloading it |
Network and decoys
| Option |
Meaning |
--mgmt-if IFACE |
management interface (SSH, web UI, sensor API); on a sensor: the interface that reaches the manager |
--decoy-if IFACE |
interface of the decoy; it answers on that interface's own address (sensor: its one decoy; add-decoy: a free interface) |
--role-ifaces role=IFACE,... |
interface per decoy, one decoy per interface (manager install) |
--roles ROLES |
comma-separated role ids, or none. At most 3 and one per interface (add-decoy: exactly one role) |
--names role=HOSTNAME,... |
host name per role (1 to 15 characters) |
--web-theme webmail\|helpdesk\|intranet |
front page of the web decoy |
--stop-conflicting |
unattended: stop and disable host services that hold decoy ports (uninstall re-enables them) |
--close-other-services |
unattended: accept that host services listening on the management interface become unreachable there when a decoy shares it |
Role ids: windows-file-server, windows-domain-controller, linux-web-hosting, ftp-backup-server,
linux-dns-server.
Persona
| Option |
Meaning |
--domain DOMAIN |
Active Directory / DNS domain, for example corp.example.com. Required with --yes. Company, NetBIOS name and mail domain are derived from it |
--profile bank\|hotel\|government\|it\|generic |
industry |
Access and ports
| Option |
Meaning |
--allow-ui NETS |
networks allowed to open the web UI (comma-separated; 0.0.0.0/0 = anyone) |
--allow-sensor NETS |
networks allowed to reach the sensor API (remote sensors) |
--allow-ssh NETS |
networks allowed to use host SSH (your current client is always added) |
--accept-exposure |
set-access / add-decoy, unattended: apply an allow-list that is open to anyone, or contains a decoy's own LAN, on an address a decoy shares |
--ui-port PORT |
web UI port (default: random) |
--sensor-port PORT |
sensor API port (default: random) |
--ssh-port PORT |
move host SSH to this port instead of a random one |
--no-ssh-move |
never touch the host SSH daemon (not possible with a decoy on the management interface) |
--public-ip IP\|no |
static public IP of the manager |
--geoip yes\|no |
download the GeoIP database during the install |
Sensor
| Option |
Meaning |
--join - |
read the join string from standard input |
--join-file FILE |
read the join string from a root-owned file, mode 600, not a symlink |
--join STRING |
join string on the command line. Works, but local users can read it in the process list; avoid it |
reset-token
| Option |
Meaning |
--wall |
also issue a new read-only wall link (logs out every wall screen) |
--wall-allow LIST |
wall screens allowed only from these IPs or networks (comma-separated; none = any) |
--token TOKEN |
use this admin token instead of a random one (at least 16 characters) |
update
| Option |
Meaning |
--resume-rollback |
roll back an interrupted update without asking (--yes alone does not) |
uninstall
| Option |
Meaning |
--keep-data |
keep database, logs, configuration and update backups |
--purge-image |
also delete the Docker image |
export
| Option |
Meaning |
--from YYYY-MM-DD |
first UTC day |
--to YYYY-MM-DD |
last UTC day (inclusive); at most 366 days |
-o FILE, --output FILE |
output file (default ./redpot-export-FROM_TO.json, mode 0600) |