Run config.yaml reference

When running relay client as a background process, yaml configuration is used to configure forwarding

When running relay client as a background service, you will need to pre-create tunnels and forwarding configuration. The client in this mode is not creating them automatically.

To get your access key & secret, visit token page and generate one.

Minimal configuration example:

version: "v1"
key: your-secret-key # will be encrypted on startup
secret: your-secret  # will be encrypted on startup
tunnels:
  - my-spacex-tunnel
buckets:
  - tesla-gigafactory-one

Additional options

Additional configuration can be provided:

version: "v1"
key: your-secret-key # will be encrypted on startup
secret: your-secret  # will be encrypted on startup
forwardingTransport: websocket # default is GRPC, however you can switch to WebSocket
serverAddress: https://my.webhookrelay.com:443
logs_output: /var/log/relay.log # where to write logs
log_level: error # debug/info/warning/error
tunnels:
  - my-spacex-tunnel
buckets:
  - tesla-gigafactory-one
destination: output-name # Or ID or destination URL