console/packages/services/emails/README.md
Andrii Hrachov 8aec41a36e
feat: redis tls support (#5884)
Co-authored-by: Laurin Quast <laurinquast@googlemail.com>
2024-11-11 14:26:30 +01:00

6.8 KiB

Emails

Service for sending Hive Emails.

Configuration

Configuration

Name Required Description Example Value
PORT No The port this service is running on. 6260
REDIS_HOST Yes The host of your redis instance. "127.0.0.1"
REDIS_PORT Yes The port of your redis instance. 6379
REDIS_PASSWORD Yes The password of your redis instance. "apollorocks"
REDIS_TLS_ENABLED No Enable TLS for redis connection (rediss://). "0"
EMAIL_FROM Yes The email address used for sending emails kamil@graphql-hive.com
EMAIL_PROVIDER Yes The email provider that should be used for sending emails. smtp or postmark or mock
EMAIL_PROVIDER_SMTP_PROTOCOL No (Yes if EMAIL_PROVIDER is set to smtp) The protocol used for the smtp server smtp or smtps
EMAIL_PROVIDER_SMTP_HOST No (Yes if EMAIL_PROVIDER is set to smtp) The host of the smtp server 127.0.0.1
EMAIL_PROVIDER_SMTP_PORT No (Yes if EMAIL_PROVIDER is set to smtp) The port of the smtp server 25
EMAIL_PROVIDER_SMTP_AUTH_USERNAME No (Yes if EMAIL_PROVIDER is set to smtp) The username for the smtp server. letmein
EMAIL_PROVIDER_SMTP_AUTH_PASSWORD No (Yes if EMAIL_PROVIDER is set to smtp) The password for the smtp server. letmein
EMAIL_PROVIDER_POSTMARK_TOKEN No (Yes if EMAIL_PROVIDER is set to postmark) The postmark token. abcdefg123
EMAIL_PROVIDER_POSTMARK_MESSAGE_STREAM No (Yes if EMAIL_PROVIDER is set to postmark) The postmark message stream. abcdefg123
ENVIRONMENT No The environment of your Hive app. (Note: This will be used for Sentry reporting.) staging
HEARTBEAT_ENDPOINT No The endpoint for a heartbeat. http://127.0.0.1:6969/heartbeat
SENTRY No Whether Sentry error reporting should be enabled. 1 (enabled) or 0 (disabled)
SENTRY_DSN No The DSN for reporting errors to Sentry. https://dooobars@o557896.ingest.sentry.io/12121212
PROMETHEUS_METRICS No Whether Prometheus metrics should be enabled 1 (enabled) or 0 (disabled)
PROMETHEUS_METRICS_LABEL_INSTANCE No The instance label added for the prometheus metrics. emails
PROMETHEUS_METRICS_PORT No Port on which prometheus metrics are exposed Defaults to 10254
REQUEST_LOGGING No Log http requests 1 (enabled) or 0 (disabled)
LOG_LEVEL No The verbosity of the service logs. One of trace, debug, info, warn ,error, fatal or silent info (default)
OPENTELEMETRY_COLLECTOR_ENDPOINT No OpenTelemetry Collector endpoint. The expected traces transport is HTTP (port 4318). http://localhost:4318/v1/traces