# Canary

Canary is a self-hosted monitoring & logging app. Canary acts as a digital alarm system for your Bitcoin savings. It is open source and self-hosted, installable on Umbrel.

Canonical page: https://ourlocalhost.com/app/6185/canary

## Description

Canary acts as a digital alarm system for your Bitcoin savings. It alerts you the moment someone tries to access your offline funds, allowing you to move your money to safety before it can be stolen. It provides peace of mind by monitoring your wealth around the clock.

## Platform availability

Available on 2 of 10 platforms: Umbrel, Any server.

## Health score

59/100 (Fair), based on 4 of 5 factors.
- Maintained: 88 (last commit 4 days ago)
- Popular: 70 (3,122 GitHub stars)
- Easy to install: 25 (1 install platform, install notes)
- Security check: 20 (1 serious finding, 4 minor, CI, tests, OpenSSF Scorecard 6.3/10)

## Security check

1 serious finding: Uses certifi 2026.1.4, which has a known critical vulnerability.
Automated checks on commit fb12e4f, 21 Oct 2026. Not an audit.

## Links

- Umbrel: https://apps.umbrel.com/app/canary
- Official website: http://opencanary.org
- GitHub: https://github.com/thinkst/opencanary

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/6185/canary), the self-hosted and open-source app directory.
