Skip to main content

Rig Configuration

The Rig server is configured from the server-config.yaml file. Configuration can be overridden using environment variables on the form RIG_<CONFIG> where <CONFIG> is the configuration path in uppercase with dots replaced by underscores. Eg. to set client.mailjet.api_keythrough an environment variable one would set the environment variableRIG_CLIENT_MAILJET_PROJECT_ID`.

The following table shows available configuration options.

OptionDescriptionDefault
auth.jwt.certificate_fileJWT signing public key. Mutually exclusive with auth.jwt.secret-
auth.jwt.certificate_key_fileJWT signing private key. Mutually exclusive with auth.jwt.secret-
auth.jwt.secretJWT signing secret. Mutually exclusive with auth.jwt.secret-
client.docker.hostHost of docker daemon-
client.mailjet.api_keyMailjet API key-
client.mailjet.fromMailjet from email-
client.mailjet.secret_keyMailjet secret key-
client.mongo.hostHost of mongodb-
client.mongo.passwordPassword for mongodb-
client.mongo.userUsername for mongodb-
client.smtp.hostSMTP server hostname-
client.smtp.passwordSMTP server password-
client.smtp.portSMTP server port-
client.smtp.userSMTP server user-
cluster.typeCluster type. Can be either docker or k8sdocker
email.typeEmail type specifies how to send email. Can be left empty for no email or set to one of mailjet, smtp. Requires the corresponding client.<email.type> to be configured-
portPort which the Rig server will listen on4747
telemetry.enabledWether to enable telemetrytrue

Was this page helpful?