Installation

How to install

To have a working installation, you need the binary file and the configuration file. Also, if you use systemd, a service file is provided. The default paths for these files are:

• /usr/local/bin/goshawk - the binary file is meant to be run as root, as some verification scripts will need those permissions.
• /etc/goshawk.yml - the configuration file is owned by root and has permissions 0600, so other users should not read API keys.
• /etc/systemd/system/goshawk.service - the service file is configured by default without the verification hash. Ensure you set the hash once the configuration is adapted to the server.

Installation methods

Currently, only amd64 and arm64 builds are provided through GitHub workflows.

RedHat based distros

You can add the gonimals repository and install the goshawk package directly in a RedHat based server with these commands:

sudo curl -L -o /etc/yum.repos.d/gonimals.repo gonimals.github.io/gonimals.repo
sudo dnf install goshawk

This will add a gpgchecked repository and will let you ensure that, if you have automatic updates configured, your installation will be up to date.

Custom installer

For other linux distributions, you can run the installer:

curl -L https://github.com/gonimals/goshawk/raw/refs/heads/main/deploy/install.sh | sudo bash

Go install

You can compile and install the binary file by running the following command:

go install github.com/gonimals/goshawk

This method is similar to clone the repository and compile it or to download the binary file from the GitHub releases section. Ensure you have a configuration file template and a systemd service file.