Auto-start
Configuring relay CLI to auto-start as a background service.
Last updated
Was this helpful?
Configuring relay CLI to auto-start as a background service.
Last updated
Was this helpful?
Webhook Relay agent can run in the background and be managed by the operating system on Linux, Windows and MacOS. To start using the background service, first get the .
When running as a background service, agent needs a configuration file. It’s a simple yaml
format file.
For this file, you will need to:
key and secret.
if you need bidirectional tunnels (optional)
if you are going to use one-way webhook forwarding (optional)
Create a file `/etc/relay/config.yaml`
If no tunnels or no buckets are defined, that part of the relay service will be disabled. If no buckets and tunnels are specified, relay service will not start.
Note that you can subscribe to tunnels and buckets even before you have created them through the API/CLI/UI.
Once the relay service starts, key and secret will be encrypted.
Tu install the service, you will need to use sudo
and provide a full path to relay configuration file:
To specify credentials during install:
To restart the service (if you change the configuration file
To uninstall the service:
To view service logs, use journalctl
:
Make sure you have download relay CLI and created a config.yaml file.
If you are using Powershell:
You can also just keep the config.yaml file in the same directory as relay
exe file. Then, you just need to do:
The agent is now installed and will be run after a system reboot.
To specify credentials during install:
To restart the service (if you change the configuration file):
To uninstall the service:
Execute as the user who will run the agent:
To specify credentials during install:
To restart the service (if you change the configuration file):
To uninstall the service:
Note: The service needs to be installed from the Terminal by running its GUI interface as your current user. Only then will you be able to manage the service.
By default agent connects to EU region. If you are using other region, specify it in the configuration:
Usually logs can be viewed through journalctl
:
If you are using a Windows machine, then it’s useful to specify a log output location during install:
You can also specify logging level and output file in the configuration:
If the executable has write permissions, then to update it you only need to restart the service. Otherwise, follow these steps:
Stop the service and uninstall it.
Install and start the service.
Relay can use HTTP proxy to open the tunnel:
If you host an instance of Webhook Relay yourself (Transponder), add additional values to specify the server APIs:
Download the new binary .