Skip to content

Configuration

Jump to bottom
Nico MT edited this page May 16, 2026 · 3 revisions

Initial configuration

After installation, the default configuration file is placed at /etc/goshawk.yml, owned by root and with permissions 0600 to prevent users from modifying it or reading API keys.

The default network port is 47495/tcp. If you are using firewalld, you can use this command to open it: sudo firewall-cmd --add-port=47495/tcp --permanent && sudo firewall-cmd --reload

After starting the service, you can check the logs of the systemd service with: sudo journalctl -fu goshawk.

To modify the command line of the systemd unit, run the command sudo systemctl edit goshawk. In the editor, type the following configuration:

[Service]
ExecStart=
ExecStart=/usr/bin/goshawk -config /etc/goshawk.yml -v -hash yourconfigfilehash

The file example_config.yaml file contains an explanation about every parameter to be configured.

Notifications

If you configure the notification URL to an empty string, goshawk will log every alert to standard output.

In this section you can find alternatives to get your notifications.

Telegram

This system is free and very simple.

  1. Open a conversation with @botfather in Telegram, select the command /newbot and chose your bot name.
  2. Talk to your new bot and, just after that, navigate to https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates to copy your chat id.
  3. Configure the notification_url in goshawk to https://api.telegram.org/bot<YOUR_BOT_TOKEN>/sendMessage
  4. Configure your template_body to "{ \"chat_id\": 120963222, \"text\": \"{{ .ServiceName }} is {{ if .IsActive }}active{{ else }}inactive{{ end }}\" }"

Monitoring

Webs

Wordpress

You can monitor the /health endpoint after installing this Wordpress plugin: https://wordpress.org/plugins/health-endpoint/

Clone this wiki locally