pantry/projects/github.com/thinkst/opencanary/README.md
Jacob Torrey e3ea4ee44e
+(opencanaryd) (#3898)
* +(opencanaryd)

Signed-off-by: Jacob Torrey <jacob@thinkst.com>

* Improve packaging and documentation for opencanary

Signed-off-by: Jacob Torrey <jacob@thinkst.com>

* Move to a more idiomatic, version-agnostic packaging

Signed-off-by: Jacob Torrey <jacob@thinkst.com>

* Trying to diagnose aarch64 build issue

Signed-off-by: Jacob Torrey <jacob@thinkst.com>

* Add libffi to the build deps

Signed-off-by: Jacob Torrey <jacob@thinkst.com>

* Bump to python 3.8

Signed-off-by: Jacob Torrey <jacob@thinkst.com>

* Bump to python 3.9

Signed-off-by: Jacob Torrey <jacob@thinkst.com>

* Reverting to the previously building version

Signed-off-by: Jacob Torrey <jacob@thinkst.com>

---------

Signed-off-by: Jacob Torrey <jacob@thinkst.com>
2023-10-31 19:13:31 -04:00

28 lines
998 B
Markdown

# Running OpenCanary via pkgx
## Configuring OpenCanary
When OpenCanary starts it looks for config files in the following locations and will stop when the first configuration is found:
1. `./opencanary.conf` (i.e. the directory where OpenCanary is installed)
2. `~/.opencanary.conf` (i.e. the home directory of the user, usually this will be `root` so `/root/.opencanary.conf`)
3. `/etc/opencanaryd/opencanary.conf`
To create an initial configuration, run as `root` (you may be prompted for a `sudo` password):
```
$ pkgx opencanaryd --copyconfig
[*] A sample config file is ready /etc/opencanaryd/opencanary.conf
[*] Edit your configuration, then launch with "pkgx opencanaryd --start"
```
This creates the path and file `/etc/opencanaryd/opencanary.conf`. You must now edit the config file to determine which services and logging options you want to enable.
# Launching OpenCanary
Start OpenCanary by running the following as root (or with `sudo -E`):
```
$ pkgx opencanaryd --start
```