convoy
in your terminal with no arguments:
-h
flag to the relevant subcommand. For example, to get help about the worker
sub-command run convoy worker -h
convoy ingest
--interval
: The time in seconds to poll the database for changes in the source configuration.convoy bootstrap
--help
: Get help on the bootstrap command.convoy stream
--help
: Get help on the stream command.convoy migrate
down
: Rollback migrations.up
: Run all pending migrationsconvoy config
--help
: Get help on the config worker.convoy server
--port
: This flag specifies the port number the server listens on. This is a required parameter that must be configured from one of the configuration sources.
--auth
: This flag specifies if the REST API will require authentication or not. It is enabled by default
--multi-tenant
: This flag specifies the mode the instance is running. It’s a boolean flag. When set to true
. The server will only receive events but not run workers in the background. It is expected that you will run convoy worker
as a different process to consume event deliveries off the queue. Defaults to false
.
--max-response-size
: This flag specifies the maximum response in bytes of the endpoint’s payload to store. This configuration only affects the default group.
--native
: This flag specifies if the native
realm should be enabled. You can read more about the native realm here It is a boolean flag. Defaults to false
.
--disable-endpoint
: This flag specifies the disable-endpoint
configuration for the default group for convoy instances running in non-multi tenant mode.Defaults to false
.
--signature-hash
: This flag specifies the hash algorithm for the default group for convoy instances running in non-multi tenant mode.
--signature-header
: This flag specifies the HTTP header for the default group for convoy instances running in non-multi tenant mode.
--sentry
: This flag specifies the DSN to push telemetry data to sentry.
--ssl
: This specifies if the server should run with ssl
enabled. If true, then you must specify two other flags --ssl-cert-file
and --ssl-key-file
.
--ssl-cert-file
: This is a path to the SSL certificate file. If specified and ssl
is set to false
; nothing happens.
--ssl-key-file
: This is a path to the SSL key file. If specified and ssl
is set to false
; nothing happens.
--with-workers
: This specifies if the server should run in monolith mode. This means both the server and worker will be run in the same process. Defaults to true
if not specified.
convoy worker
--smtp-provider
: This flag specifies the name of the SMTP provider. While this isn’t necessary for smtp configuration, it is used to provider rich log.--smtp-from
: This specifies the sender’s email address when sending notification emails.--smtp-url
: This specifies the smtp servers’ url. You should lookup the providers’ documentation on how to specify this flag.--smtp-port
: This specifies the smtp servers’ port. You should lookup the providers’ documentation o how to specify this flag.--smtp-reply-to
: This specifies the email to use as reply-to in notification emails sent.--smtp-username
: This specifies the username for smtp authentication. You should lookup the providers’ documentation on how to specify this flag.--smtp-password
: This specifies the password for smtp authentication. You should lookup the providers’ documentation on how to specify this flag.--smtp-ssl
: This specifies if ssl should be used in the smtp protocol for sending emails.--help
: Get help on the worker command.--worker-port
: Specify the worker server’s port. Defaults to 5006
if not specified.--mode
: The processing mode of the events’ processor.convoy agent
--smtp-provider
: This flag specifies the name of the SMTP provider. While this isn’t necessary for smtp configuration, it is used to provider rich log.--smtp-from
: This specifies the sender’s email address when sending notification emails.--smtp-url
: This specifies the smtp servers’ url. You should look up the providers’ documentation on how to specify this flag.--smtp-port
: This specifies the smtp servers’ port. You should look up the providers’ documentation on how to specify this flag.--smtp-reply-to
: This specifies the email to use as reply-to in notification emails sent.--smtp-username
: This specifies the username for smtp authentication. You should look up the providers’ documentation on how to specify this flag.--smtp-password
: This specifies the password for smtp authentication. You should look up the providers’ documentation on how to specify this flag.--smtp-ssl
: This specifies if ssl should be used in the smtp protocol for sending emails.--help
: Get help on the worker command.--agent-port
: Specify the agent server’s port. Defaults to 5007
if not specified.--interval
: The time in seconds to poll the database for changes in the source configuration.--mode
: The processing mode of the events’ processor.convoy retry
--status
: This is used to specify the status of event delivery to re-queue.
--time
: This is used to specify how far in the past to look for event deliveries. It accepts a duration string. Duration strings are like integers followed by a time unit. E.g. 1h
, 300ms
, or 2h45m
etc.