Files
check-if-email-exists/docs/self-hosting/docker-environment-variables.md

3.5 KiB

Docker Environment Variables (v0.7)

{% hint style="info" %} This page only applies to Reacher version 0.7. For the beta v0.10 version, see reacher-configuration-v0.10.md. {% endhint %}

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 VarRequired?DescriptionDefault
RUST_LOGNoOne of trace,debug,warn,error,info. RUST_LOG=debug is very handful for debugging purposes.info
RCH_HTTP_HOSTNoThe host name to bind the HTTP server to.0.0.0.0
PORTNoThe port to bind the HTTP server to, often populated by the cloud provider.8080
RCH_SENTRY_DSNNoIf set, bug reports will be sent to this Sentry DSN.not defined
RCH_HEADER_SECRETNoIf 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_EMAILNoEmail to use in the <MAIL FROM:> SMTP step. Can be overwritten by each API request's from_email field.reacher.email@gmail.com
RCH_HELLO_NAMENoName to use in the <EHLO> SMTP step. Can be overwritten by each API request's hello_name field.gmail.com
RCH_SMTP_TIMEOUTNoTimeout for each SMTP connection.45s
RCH_WEBDRIVER_ADDRNoSet 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_BULKNoIf set to 1, then bulk verification endpoints will be added to the backend.0
DATABASE_URLYes if RCH_ENABLE_BULK==1[Bulk] Database connection string for storing results and task queuenot defined
RCH_DATABASE_MAX_CONNECTIONSNo[Bulk] Connections created for the database pool5
RCH_MINIMUM_TASK_CONCURRENCYNo[Bulk] Minimum number of concurrent running tasks below which more tasks are fetched10
RCH_MAXIMUM_CONCURRENT_TASK_FETCHNo[Bulk] Maximum number of tasks fetched at once20