# OpenCanary

OpenCanary is a multi-protocol network honeypot. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1521/opencanary

## Description

OpenCanary is a multi-protocol network honeypot. Its primary use-case is to catch hackers after they've breached non-public networks. It has extremely low resource requirements and can be tweaked, modified, and extended. The following services are enabled by default: telnet ssh http https

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

70/100 (Good), based on 3 of 4 factors.
- Maintained: 88 (last commit 24 days ago)
- Popular: 70 (3,092 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/imthai/opencanary
- GitHub: https://github.com/thinkst/opencanary
- Unraid: https://ca.unraid.net/apps/opencanary-0jvbfm81v88ftw?q=OpenCanary
- Official website: http://opencanary.org

## Common questions

### How can I verify OpenCanary is running and logging decoy attempts?

Create or edit the config with opencanaryd --copyconfig, start it with opencanaryd --start, then test a decoy login such as ftp localhost. Confirm the attempt appears in /var/tmp/opencanary.log, because a missing or invalid config can cause it to miss scans silently.

### How do I choose which fake services OpenCanary exposes?

Enable only the decoy services you want in ~/.opencanary.conf and set the port for each one, such as SSH on 22 or MySQL on 3306. A disabled service or blocked port will not be reached by scanners and will not generate alerts.

### Why might Dockerized OpenCanary report the wrong attacker IP?

Dockerized OpenCanary must run on a Linux-based OS, not Windows or macOS, to report the correct attacker IP. The Docker setup also needs the host parameter specified.

### How interactive is OpenCanary's SSH decoy compared with Cowrie?

A user reports that OpenCanary's SSH service may only provide a login interface. This is noted as unlike Cowrie.

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