Docker Environment Variables

Reacher's software is available on Docker Hub. You can get started using the default parameters:

docker run -p 8080:8080 reacherhq/backend:latest

Below are the environment variables used to configure the HTTP server. To pass them to the Docker container, use the -e {ENV_VAR}={VALUE} flag.

Env Var	Required?	Description	Default
RUST_LOG	No	One of trace,debug,warn,error,info. RUST_LOG=debug is very handful for debugging purposes.	info
RCH_HTTP_HOST	No	The host name to bind the HTTP server to.	0.0.0.0
PORT	No	The port to bind the HTTP server to, often populated by the cloud provider.	8080
RCH_SENTRY_DSN	No	If set, bug reports will be sent to this Sentry DSN.	not defined
RCH_HEADER_SECRET	No	If set, then all HTTP requests must have the x-reacher-secret header set to this value. This is used to protect the backend against public unwanted HTTP requests.	undefined
RCH_FROM_EMAIL	No	Email to use in the <MAIL FROM:> SMTP step. Can be overwritten by each API request's from_email field.	[e-mail]
RCH_HELLO_NAME	No	Name to use in the <EHLO> SMTP step. Can be overwritten by each API request's hello_name field.	gmail.com
RCH_SMTP_TIMEOUT	No	Timeout for each SMTP connection.	45s
RCH_WEBDRIVER_ADDR	No	Set to a running WebDriver process endpoint (e.g. http://localhost:9515) to use a headless navigator to password recovery pages to check Yahoo and Hotmail/Outlook addresses. We recommend chromedriver as it allows parallel requests.	http://localhost:9515
For Bulk Verification:
RCH_ENABLE_BULK	No	If set to 1, then bulk verification endpoints will be added to the backend.	0
DATABASE_URL	Yes if RCH_ENABLE_BULK==1	[Bulk] Database connection string for storing results and task queue	not defined
RCH_DATABASE_MAX_CONNECTIONS	No	[Bulk] Connections created for the database pool	5
RCH_MINIMUM_TASK_CONCURRENCY	No	[Bulk] Minimum number of concurrent running tasks below which more tasks are fetched	10
RCH_MAXIMUM_CONCURRENT_TASK_FETCH	No	[Bulk] Maximum number of tasks fetched at once	20