Hub Server options#

Cegal Hub Server runs as a standalone executable on Windows or Linux.

To run a simple stand-alone Hub Server without TLS.

cegalhub server --tls=false
../../../_images/hub_server_simple_no_tls.png

In a production setting and depending on your deployment scenario it is likely further options will be supplied. See below for the options available when running a stand-alone Cegal hub server.

Flags#

Server options#

option (flag)

description

–auth-connectors

require connectors to authenticate to the Cegal Hub server (default: true)

–auth-clients

require clients to authenticate to the Cegal Hub server (default: true)

–keystone-tenant-id value, –ksid value

require clients to be authenticated in the specified Cegal Keystone tenant id. Your tenant id can be found using the keystone tenant-id command.

–tls

use transport level security (default: true)

–cert-file-path value, –cert value

the path to the .cert file (default: the cert file path)

–key-file-path value, –key value

the path to the key file of the server (default: the key file path)

–port value, –po value

the GRPC port that Hub listens on (default: 9595)

–connector-join-token value, –cjt value

a specified token (auto generated if flag set but an empty string provided) that Hub Connectors may authenticate with.

–require-join-token, –rjt

if true any Connector must supply the join-token when connecting. This will auto generate a token if a connector join token is not provided. (default: false)

–no-log-file

dont create a log file (default: false)

–pretty-print, –pp

pretty print to console (default: true)

–prometheus, –prom

collect Prometheus metrics from Cegal Hub (default: false)

–prom-port value

the port the prometheus metrics endpoint (only applies if the –prometheus flag is set) (default: 7979)

–debug

set logging level to debug (default: false)

–help, -h

show help (default: false)