Install the manager¶
The manager runs the console (web UI and sensor API) and, optionally, up to three local decoys.
Get the installer¶
git clone https://github.com/RedSideSecurity/ReD-Pot.git
cd ReD-Pot
sudo ./install.sh # choose [1] Manager + decoys
sudo ./install.sh manager starts the manager install directly.
The installer downloads the prebuilt image ghcr.io/redsidesecurity/red-pot:<version> and uses it only if it was
built from exactly the code you cloned (SHA-256 of the source in the image label). If the check fails, you changed the
code, or there is no internet, it builds the image rpot:<version> locally instead, which takes a few minutes. Use
--build to force a local build.
The published image (linux/amd64 and linux/arm64) is built only by the release workflow from the tagged commit, with provenance and an SBOM. To check where an image came from:
The wizard¶
The wizard has five steps and a review screen. Type back at any question to return to the previous step (your answers
are kept). Ctrl+C quits without changes.
| Step | What it asks | Notes |
|---|---|---|
| 1 Network | management interface | Pre-selected: the interface of your SSH session. Interfaces that are down, have no IPv4 address or have an unusual name are listed as Not usable with the reason. |
| 2 Your company | AD/DNS domain (for example corp.example.com) and industry: bank, hotel, government, IT or generic |
Company name, NetBIOS name and mail domain are derived from the domain and shown at once. There is no default domain. |
| 3 Decoy servers | which roles: for example 1, 1,3 or none |
At most 3, and at most one per usable interface. none = a manager that only collects remote sensors. |
| 4 Decoy interfaces and names | per decoy: interface, host name, and for the web decoy its front page (webmail, helpdesk or intranet) | An interface used by an earlier decoy is not offered. Other services listening on that address are listed and can be stopped. |
| 5 Access | static public IP (or no), GeoIP download, and who may reach the web UI, the sensor API and host SSH |
Three allow-lists, 0.0.0.0/0 = anyone. Your current SSH client is always allowed. See Access allow-lists. |
Bait documents and the web UI allow-list
The bait Word documents report to the manager's web UI port. They only report from addresses that are allowed to reach the console: with a restricted web UI allow-list, a bait document opened on any other host is not reported. The installer warns about this when you restrict the list. Bait files, credentials and keys used against the decoys are not affected.
The review screen¶
The review shows the derived company, NetBIOS name and mail domain, how many of the 3 decoy slots the install uses, each
decoy's interface and IP, the firewall plan and what happens to host SSH. Type 1 to 5 to change a part, q to quit,
or press Enter to install.
When a decoy shares the management interface, pressing Enter first lists the host services that listen on that interface (other than host SSH) and will become unreachable there, for example a VPN server, and asks you to confirm (default: no).
Busy ports¶
If a port a decoy needs is already in use (for example nginx on 80 for a web decoy, or Samba on 445), the installer names the service and offers two ways out:
- Stop and disable that service. The decoy takes the port. This is shown on the review screen first, and
install.sh uninstallturns the service back on. Unattended installs need--stop-conflicting. - Choose something else: another interface for that decoy, or other roles.
Ports held by something that is not a system service (a Docker container, a program started by hand) are shown with the container hint or process id, so you can stop it yourself.
What the installer does¶
- Installs Docker if needed and gets the image (download or local build).
- Generates the persona, the baits and honeytokens, and a new TLS certificate for the manager that looks like the
company's internal PKI (
CN=<host>.<domain>, issuer "<Company> Issuing CA"). - Starts the manager and the decoys and installs the
redpotsystemd service (starts on boot). - If a decoy shares the management interface, moves host SSH to a random port. SSH listens on the new port first, and your current session stays open. If decoys sit only on other interfaces, SSH stays on 22 and listens only on the management IP.
- Runs a self-test of every decoy (container running, every port listening, a TCP connect to its address) and prints a table. It also lists host services that listen on all addresses. "ReD-Pot is ready" appears only when every decoy passed.
- Prints the summary and saves it to
/opt/redpot/manager/INSTALL-INFO.txt(root only). The ports are also shown in the SSH login banner.
-- ReD-Pot is ready ------------------------------
Web UI https://10.10.0.5:59952
Admin token XxthU0kfP1jK...
Wall (read-only) https://10.10.0.5:59952/wall?k=...
Sensor API port 62667
Manager fingerprint 53C6EB7AB0630485...
Decoys RS-FS-01 10.10.50.10 (eth1)
Host SSH port 22, only on 10.10.0.5
Service systemctl status redpot (starts on boot)
Only one installer runs at a time; a second one (for example in another SSH session) is refused.
Next: First login.