Heralding
github.com
- Free plan
- Linux
- Self-hosted
What Heralding is
Heralding is a free, self-hosted network honeypot that collects credentials. It supports FTP, Telnet, SSH, HTTP, HTTPS, POP3, POP3S, IMAP, IMAPS, SMTP, VNC, PostgreSQL, and SOCKS5. When a protocol makes them available, its authentication log records usernames and plaintext passwords. Heralding also stores authentication attempts, session summaries, and complete session data in CSV and JSON Lines files. Session records can include timestamps, duration, source and destination addresses and ports, protocol, authentication attempts, and protocol-specific details. Session entries are written after a connection ends, while authentication entries appear when a password has been transmitted. The README describes pip installation on Debian-based systems and Docker deployment with port mapping. Python 3.7.0 or higher is required. For separate packet captures per session, the README points to Curisoum and says to enable it in Heralding.yml. GitHub identifies the project as GPL-3.0 licensed.
Who it suits
Heralding suits Linux operators who want to collect credential attempts across its supported network protocols. It is intended for users seeking a self-hosted honeypot.
Good to know, and what to watch
- Supports a broad set of network protocols.
- Records credentials when protocols expose them.
- Writes session data to CSV and JSON Lines.
- Can be deployed with pip or Docker.
- Requires Python 3.7.0 or higher.
- Session logs are written after sessions end.
- Separate per-session packet capture uses Curisoum.
Plans
Every plan and priceHeralding
Free plan
Getting started
- Open the Heralding GitHub repository
- Install Heralding with pip as described in the README
- Use a Debian-based Linux system with Python 3.7.0 or newer
- Alternatively build the Docker image and run it with a port mapping
- Enable Curisoum in Heralding.yml if you want a separate PCAP for each session
Limits to check
Heralding is a free GPL-3.0 project with a free plan. Authentication and session details depend on what each protocol makes available, and session entries are written only after sessions end.
The verdict
Heralding combines credential capture with session records across many protocols. Keep in mind that password logging depends on protocol availability, and session logs arrive after a session ends.
Questions people ask
What does Heralding collect?
It records authentication attempts and can capture usernames and plaintext passwords when the protocol provides them. It also stores session summaries and complete session data.
Which protocols does it support?
Supported protocols are FTP, Telnet, SSH, HTTP, HTTPS, POP3, POP3S, IMAP, IMAPS, SMTP, VNC, PostgreSQL and SOCKS5.
Where are logs stored?
Authentication attempts, session summaries and full session data are written to CSV and JSON Lines files.
Is Heralding free?
Yes. The listed Heralding plan costs nothing and is GPL-3.0 licensed open-source software.
Can it create packet captures?
The README points to Curisoum for a separate PCAP for each session. Curisoum must be enabled in Heralding.yml.
How can it be deployed?
The README describes pip installation on Debian-based systems and Docker deployment with port mapping. Heralding is self-hosted on Linux.
What the maker publishes
- Authentication capture
- The auth log records usernames and plaintext passwords when the protocol makes them available. source
- Container deployment
- The project README describes building a Docker image and running it with a port mapping. source
- Installation
- The README gives pip installation instructions and describes running Heralding on a Debian-based system. source
- Intended users
- The project describes itself as a honeypot for users who want to collect credentials. source
- License
- GitHub identifies the project as GPL-3.0 licensed. source
- Log timing
- Session log entries are written after a session ends, while auth log entries appear when a password has been transmitted. source
- Packet capture
- The README points to Curisoum for creating a separate PCAP for each Heralding session and says to enable it in Heralding.yml. source
- Protocols
- It supports FTP, Telnet, SSH, HTTP, HTTPS, POP3, POP3S, IMAP, IMAPS, SMTP, VNC, PostgreSQL and SOCKS5. source
- Purpose
- Heralding is a simple honeypot that collects credentials. source
- Requirements
- The README states that Python 3.7.0 or higher is required. source
- Session details
- Session data can include timestamps, duration, source and destination IP and port, protocol, authentication attempts and protocol-specific auxiliary data. source
- Session logs
- It writes authentication attempts, session summaries and complete session data to CSV and JSON Lines files. source
Checked against the maker's pages on 3 Oct 2026.