This page is generated from the program and its code when the documentation is built. It is not edited by hand.

Relay command line

This page is generated from the easysync-relay program: its command definitions and the text of its --help for every command. It cannot differ from the program that was built from the same commit (f401b20140c8).

Options of every command #

These options are accepted by every command. Those about the engine have an effect only on a command that starts an engine of its own (the daemon, or the one-off engine of a command that finds no daemon).

Option	Default	Meaning
`--config <CONFIG>`	`/etc/easysync-relay/relay.toml`	Configuration file

easysync-relay #

easysync relay (content-blind WSS relay)

Usage: easysync-relay [OPTIONS] [COMMAND]

Command	What it does
`easysync-relay healthcheck`	Requests GET /healthz on the health listener and exits 0 only on 200

The full text of --help:

easysync relay (content-blind WSS relay)

Usage: easysync-relay [OPTIONS] [COMMAND]

Commands:
  healthcheck  Requests GET /healthz on the health listener and exits 0 only on 200
  help         Print this message or the help of the given subcommand(s)

Options:
      --config <CONFIG>  Configuration file [default: /etc/easysync-relay/relay.toml]
  -h, --help             Print help
  -V, --version          Print version

easysync-relay healthcheck #

Requests GET /healthz on the health listener and exits 0 only on 200

Usage: easysync-relay healthcheck [OPTIONS]

The full text of --help:

Requests GET /healthz on the health listener and exits 0 only on 200

Usage: easysync-relay healthcheck [OPTIONS]

Options:
      --config <CONFIG>  Configuration file [default: /etc/easysync-relay/relay.toml]
  -h, --help             Print help

A relay forwards encrypted data. It does see IP addresses, timing and volume of the connections that use it: what the relay sees.