Skip to content

Commit

Permalink
README.md update (#324)
Browse files Browse the repository at this point in the history
* Update prereqs for ARM64 python version

Signed-off-by: Jacob <jacob@torrey.io>

* Added pkgx usage info

Signed-off-by: Jacob <jacob@torrey.io>

---------

Signed-off-by: Jacob <jacob@torrey.io>
  • Loading branch information
ranok authored Nov 1, 2023
1 parent ca2b04f commit ca9c1b0
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ OpenCanary is the Open Source version of our commercial [Thinkst Canary](https:/

## Prerequisites

* Python 3.7 (Recommended Python 3.7+)
* AMD64: Python 3.7 (Recommended Python 3.7+)
* ARM64: Python 3.9+
* _Optional_ SNMP requires the Python library Scapy
* _Optional_ Samba module needs a working installation of Samba
* _Optional_ Portscan uses iptables (not nftables) and is only supported on Linux-based operating systems
Expand Down Expand Up @@ -123,6 +124,15 @@ $ cd dist
$ pip install opencanary-<version>.tar.gz
```

### Use via pkgx

OpenCanary is packaged via [pkgx](https://pkgx.sh/), so no installation is needed if pkgx is installed, simply preface the `opencanaryd` command with
`pkgx`. Due to environment variable protections in modern `sudo` implementations, the entire command must be run as root, or via `sudo -E`.

```
$ pkgx opencanaryd --version
```

### Installation for Docker

OpenCanary Docker images are hosted on Docker Hub. These are only useful on Linux Docker hosts, as the `host` network engine is required for accurate network information.
Expand Down Expand Up @@ -180,6 +190,14 @@ $ . env/bin/activate
$ opencanaryd --start
```

### With pkgx

Start OpenCanary by running:

```
$ sudo -E pkgx opencanaryd --start
```

### With docker-compose

The route requires [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) to be installed.
Expand Down

0 comments on commit ca9c1b0

Please sign in to comment.