Canary
Canary acts as a digital alarm system for your Bitcoin savings.
Platform availability
Available on 2 of 10 platforms
- Unraid (not listed)
- TrueNAS (not listed)
- Umbrel
- ZimaOS (not listed)
- Proxmox (not listed)
- Helm (not listed)
- Mac (not listed)
- Windows (not listed)
- Linux (not listed)
- Any server
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
59/100 Fair
- Maintained
- 88last commit 4 days ago
- Popular
- 703,122 GitHub stars
- Easy to install
- 251 install platform, install notes
- Light to run
- No data
- Security check
- 201 serious finding, 4 minor, CI, tests, OpenSSF Scorecard 6.3/10
Based on 4 of 5 factors.
Security check: 1 serious finding
- Uses certifi 2026.1.4, which has a known critical vulnerability (PyPI)
Automated checks on commit fb12e4f, 21 Oct 2026. Not an audit.
Availability: platform listings confirmed today
- GitHub stars
- 3,122
- Open issues
- 17
- Last commit
- 2026-11-17
- Latest release
- v0.9.10
- License
- BSD-3-Clause
- Activity
- steady
Checked 2 days ago - source: GitHub (thinkst/opencanary)
Resources & Compatibility
Requirements not published yet.
First-install notes
- Make and edit your OpenCanary config Run `opencanaryd --copyconfig`, then edit `~/.opencanary.conf` to set a unique `device.node_id` (a name for this decoy), choose the fake services and ports you want (ports are numbered doorways on the computer), and point logging to a file such as `/var/tmp/opencanary.log`. This is your main setup sheet; if it is missing, broken, or has no unique name, the app may start with bad settings or logs m source
- Check the config before starting Run `jq . ~/.opencanary.conf` to check that the settings file is valid JSON, a settings format that uses colons and commas. A small slip, like a missing comma, can stop OpenCanary from reading the file, so fixing it early avoids mysterious startup problems. source
- Start the daemon and verify logging Run `opencanaryd --start`, then look in `/var/tmp/opencanary.log` after a test connection or scan. The daemon is the background program that actually watches the ports, and the log stores the evidence of attempts, so confirm both are working before relying on it. source
Fetched 53 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
Common questions
How do I create and validate the initial OpenCanary config?
Run opencanaryd --copyconfig, then edit ~/.opencanary.conf to set a unique device.node_id, choose fake services and ports, and point logging to a file such as /var/tmp/opencanary.log. You can check the settings file with jq before starting the daemon.
What log message appears in a reported OpenCanary Docker setup where alerts fail?
One self-hoster got OpenCanary running in Docker, but alerts did not work while the logs showed events with a 'can't send empty msg' output.
How can OpenCanary reduce repeated brute-force login alerts?
Send alerts to the opencanary-correlator, which coalesces related events such as individual brute-force login attempts into a single email or SMS alert.
How do I upgrade OpenCanary without losing my existing config?
Activate the virtualenv and run pip install opencanary --upgrade, which does not wipe your existing config file. If you want a new config with the new settings, regenerate it using opencanaryd --copyconfig.
What extra component is required for the OpenCanary Samba module?
The Samba module needs a working installation of Samba.
Answers sourced from opencanary.org, github.com, opencanary.readthedocs.io, www.reddit.com
Community
- Automated honeypots : r/selfhosted - Reddit (reddit)
- Xenia canary vs Xenia master? : r/xenia - Reddit (reddit)
Collected 48 days ago - public community threads