Getting Started

Getting Started

For installation instructions, environment setup, build commands, and first launch, see the README.md in the main repository.

---

Platform Notes

RedAmon is fully Dockerized and runs on Linux, macOS, and Windows. A few platform-specific notes before you install:

Linux

The reference platform. Native Docker Engine is supported and recommended. Make sure your user is in the docker group (sudo usermod -aG docker $USER, then log out and back in).

macOS (Intel and Apple Silicon)

1. Install Docker Desktop:

   brew install --cask docker

   Or download it from docker.com.
2. Open Docker Desktop from Applications and wait for the whale icon in the menu bar to stop animating before running any redamon.sh command.
3. Raise the Memory allocation: Docker Desktop → Settings → Resources → Memory. Set it to at least 4 GB (or 8 GB if you plan to install with --gvm). The Docker Desktop default has historically been 2 GB, which is below RedAmon's minimum.
4. Clone the repo under your home directory (~/redamon). Docker Desktop's File Sharing allowlist covers /Users, /Volumes, /private, and /tmp by default. Custom paths must be added under Settings → Resources → File Sharing.
5. Apple Silicon is supported. All in-tree images publish linux/arm64 manifests, and the recon entrypoint automatically falls back to linux/amd64 emulation for the few third-party images that don't.

Known limitation: SYN-based scanners (naabu, masscan) used in spawned recon containers run inside Docker Desktop's LinuxKit VM, not on the Mac's host network. This is fine for internet targets but means the Mac's local LAN is invisible to those scans. If you need LAN scanning, run RedAmon on a Linux host.

If you hit something not listed here, see the Troubleshooting page.

Windows

Use Docker Desktop with the WSL2 backend enabled, and run ./redamon.sh from inside a WSL2 distro (Ubuntu is the most-tested). Clone the repo into the WSL2 filesystem (~/redamon), not under /mnt/c/, or you will see severely degraded bind-mount performance.

---

What's Next?

Once RedAmon is running at http://localhost:3000:

1. Create a user — set up your identity
2. Create a project — configure your target and scan parameters
3. Explore the Red Zone — understand the main interface
4. Run your first reconnaissance — scan a target