Access and data

How people reach a Recon Essentials installation, how they sign in, and where the data physically lives.

Two questions come up on every self-hosted install: who can reach this, and where does the data sit? Both answers are decided by your own deployment rather than by us, so this page states what the product does and what it leaves to you.

The address people open

The installation serves the web interface on the port in WEB_PORT — 8080, or the next free port when the install command found 8080 in use — and APP_URL in your .env is the address it builds links with. Those links appear in password reset links and invitations, so an APP_URL that does not match what people actually type produces links that do not work.

A LAN address or an internal hostname is fine: http://192.168.1.20:8080 is a valid value.

WEB_BIND in .env decides who can reach that port. 127.0.0.1 means this computer only; the install command sets it when you answer that only this computer will use Recon Essentials. 0.0.0.0 means other computers on the network too. On Linux this setting matters more than the host firewall: Docker publishes the port past ufw, so ufw rules do not limit it.

Transport

The image serves plain HTTP. There is no TLS inside the container and no certificate management in the product — putting it behind TLS is your deployment's job, and it is the right way round: a reverse proxy you already run (nginx, Caddy, Traefik, a cloud load balancer) handles certificates better than a scanner image could.

If you terminate TLS in front of it, set APP_URL to the https:// address so the links match.

Nothing in the product requires the installation to be reachable from the internet. A scanner needs outbound access to your assets (see Network activity); the interface itself can stay on an internal network.

Signing in

Sign-in is email and password, with two-factor authentication and trusted devices available per account. There is no single sign-on, no SAML and no social sign-in in this edition.

Because the installation sends no email, two flows that normally arrive in an inbox are links instead:

  • Invitations — Settings → Users → Add member produces a link you copy and send. It works once and expires after 48 hours. If you close the window, Pending invitations shows the link again. Send it only to the person you invited: there is no email check, so anyone who opens it can join as that address.
  • Password reset — an administrator issues a one-time link from Settings → Users. If the only administrator is locked out, docker compose exec web cli user reset-password <email> prints one.

Where the data lives

All of it is on your machine, in three Docker volumes:

VolumeHolds
pgdatathe PostgreSQL database — every asset, finding, note and account
mediafavicons and website screenshots the engine captured
webdatasecrets generated on first boot, and uploaded profile images

Two more volumes hold the logs: weblogs for the web and enginelogs for the engine (one debug and one error file per service and day). Old files are deleted automatically: after 14 days, except the web's access log, which is kept for 30. They survive an upgrade; set ESSENTIALS_LOG_DIR and ESSENTIALS_ENGINE_LOG_DIR in .env to host folders to read them as plain files. If the engine crashes, its trace stays in enginelogs as crash-pipeline.log, crash-analyzer.log or crash-bootstrap.log, outside the 14-day sweep; send that file with a support request (docker compose cp pipeline:/var/log/recon/crash-pipeline.log . copies it out even while the service is down).

./recon-essentials.sh uninstall removes the containers and keeps the volumes; PURGE=1 ./recon-essentials.sh uninstall removes both. On Windows the same is .\recon-essentials.cmd uninstall, and -Purge at the end removes the volumes too.

Direct access, from the installation folder:

docker compose exec db psql -U recon -d recon

Exporting

Every inventory list exports to CSV from its own toolbar — domains, IP addresses, websites, technologies, ports and certificates each export what the list currently shows, filters included. That is the export path; there is no separate bulk-export screen, and the public API that the hosted product offers is not part of this edition.

For anything beyond CSV, the database is yours: pg_dump from the command above gives you everything in one file.