Command line and signals

Usage

quikcast [--config PATH] [--check]

Option	Meaning
--config PATH	The configuration file to load. If omitted, the QUIKCAST_CONFIG environment variable is used. There is no default location.
--check	Load and fully validate the configuration, then exit without starting. Also accepted as the word check-config.
-h, --help	Show help and exit.
-V, --version	Show the version and exit.

--check does everything startup does except open ports: it parses the file, reads every secret, list, certificate and database it mentions, and prepares all rules. It prints <file>: configuration ok and exits 0, or prints the problem to standard error and exits 1.

quikcast --config /etc/quikcast/quikcast.toml --check

Environment variables

Variable	Meaning
QUIKCAST_CONFIG	Path to the configuration file, used when --config is not given. --config wins if both are set.
QUIKCAST_LOG	A tracing filter such as quikcast=debug. Overrides log_filter from the config.

Signals (Linux and macOS)

Signal	What happens
SIGHUP	Reload the configuration. All or nothing: if anything is invalid the old configuration stays in force and the reason is logged. See what can be reloaded.
SIGTERM, SIGINT (Ctrl+C)	Graceful shutdown. Listeners stop accepting, connections are given shutdown_timeout_ms to finish, and then anything left is closed.

On Windows only Ctrl+C is available, and the configuration cannot be reloaded without restarting.

Exit codes

Code	Meaning
0	Success: a clean shutdown, or --check passed.
1	A configuration, startup or runtime error. The message is printed to standard error.

Standard output

Logs go to standard output. It must be a terminal, a pipe or a socket (such as the systemd journal), not a regular file. See Monitoring.