2020-04-30 16:02:34 +00:00
# Used to verify the integrity of signed cookies. so ensure a secure value is set
SECRET_KEY_BASE=replace_with_lengthy_secure_hex
# Replace with the URL you are planning to use for your app
FRONTEND_URL=http://0.0.0.0:3000
2022-09-20 00:36:01 +00:00
# To use a dedicated URL for help center pages
# HELPCENTER_URL=http://0.0.0.0:3000
2020-04-30 16:02:34 +00:00
2020-11-24 13:04:31 +00:00
# If the variable is set, all non-authenticated pages would fallback to the default locale.
# Whenever a new account is created, the default language will be DEFAULT_LOCALE instead of en
# DEFAULT_LOCALE=en
2020-09-03 07:47:45 +00:00
# If you plan to use CDN for your assets, set Asset CDN Host
ASSET_CDN_HOST=
2020-02-26 06:06:22 +00:00
# Force all access to the app over SSL, default is set to false
2020-04-30 16:02:34 +00:00
FORCE_SSL=false
2019-12-22 17:23:18 +00:00
2020-02-29 05:50:33 +00:00
# This lets you control new sign ups on your chatwoot installation
# true : default option, allows sign ups
# false : disables all the end points related to sign ups
# api_only: disables the UI for signup, but you can create sign ups via the account apis
2021-01-17 08:37:18 +00:00
ENABLE_ACCOUNT_SIGNUP=false
2020-02-29 05:50:33 +00:00
2020-04-30 14:50:26 +00:00
# Redis config
2020-01-26 17:01:34 +00:00
REDIS_URL=redis://redis:6379
# If you are using docker-compose, set this variable's value to be any string,
# which will be the password for the redis service running inside the docker-compose
# to make it secure
REDIS_PASSWORD=
2020-10-03 09:54:33 +00:00
# Redis Sentinel can be used by passing list of sentinel host and ports e,g. sentinel_host1:port1,sentinel_host2:port2
REDIS_SENTINELS=
# Redis sentinel master name is required when using sentinel, default value is "mymaster".
# You can find list of master using "SENTINEL masters" command
REDIS_SENTINEL_MASTER_NAME=
2020-01-26 17:01:34 +00:00
2022-10-20 00:25:16 +00:00
# By default Chatwoot will pass REDIS_PASSWORD as the password value for sentinels
# Use the following environment variable to customize passwords for sentinels.
# Use empty string if sentinels are configured with out passwords
# REDIS_SENTINEL_PASSWORD=
2022-03-24 13:55:07 +00:00
# Redis premium breakage in heroku fix
# enable the following configuration
# ref: https://github.com/chatwoot/chatwoot/issues/2420
# REDIS_OPENSSL_VERIFY_MODE=none
2019-12-22 17:23:18 +00:00
# Postgres Database config variables
2022-08-04 04:58:50 +00:00
# You can leave POSTGRES_DATABASE blank. The default name of
# the database in the production environment is chatwoot_production
2022-08-17 11:23:19 +00:00
# POSTGRES_DATABASE=
2019-12-22 17:23:18 +00:00
POSTGRES_HOST=postgres
POSTGRES_USERNAME=postgres
POSTGRES_PASSWORD=
RAILS_ENV=development
RAILS_MAX_THREADS=5
2021-03-12 10:07:06 +00:00
# The email from which all outgoing emails are sent
# could user either `email@yourdomain.com` or `BrandName <email@yourdomain.com>`
2022-11-07 00:06:18 +00:00
MAILER_SENDER_EMAIL=Chatwoot <accounts@chatwoot.com>
2021-03-12 10:07:06 +00:00
#SMTP domain key is set up for HELO checking
2019-12-22 17:23:18 +00:00
SMTP_DOMAIN=chatwoot.com
2022-11-29 03:43:27 +00:00
# Set the value to "mailhog" if using docker-compose for development environments,
2021-03-12 10:07:06 +00:00
# Set the value as "localhost" or your SMTP address in other environments
2022-11-29 03:43:27 +00:00
# If SMTP_ADDRESS is empty, Chatwoot would try to use sendmail(postfix)
SMTP_ADDRESS=
2021-03-12 10:07:06 +00:00
SMTP_PORT=1025
2019-11-24 11:49:14 +00:00
SMTP_USERNAME=
SMTP_PASSWORD=
2021-03-12 10:07:06 +00:00
# plain,login,cram_md5
2019-12-22 17:23:18 +00:00
SMTP_AUTHENTICATION=
2021-03-12 10:07:06 +00:00
SMTP_ENABLE_STARTTLS_AUTO=true
# Can be: 'none', 'peer', 'client_once', 'fail_if_no_peer_cert', see http://api.rubyonrails.org/classes/ActionMailer/Base.html
SMTP_OPENSSL_VERIFY_MODE=peer
2021-11-17 16:41:27 +00:00
# Comment out the following environment variables if required by your SMTP server
# SMTP_TLS=
# SMTP_SSL=
2019-11-23 19:57:39 +00:00
2020-04-30 14:50:26 +00:00
# Mail Incoming
2020-07-19 10:05:55 +00:00
# This is the domain set for the reply emails when conversation continuity is enabled
MAILER_INBOUND_EMAIL_DOMAIN=
2020-05-02 17:59:09 +00:00
# Set this to appropriate ingress channel with regards to incoming emails
# Possible values are :
2020-10-20 13:05:40 +00:00
# relay for Exim, Postfix, Qmail
# mailgun for Mailgun
# mandrill for Mandrill
# postmark for Postmark
# sendgrid for Sendgrid
2020-05-02 17:59:09 +00:00
RAILS_INBOUND_EMAIL_SERVICE=
2020-04-30 14:50:26 +00:00
# Use one of the following based on the email ingress service
# Ref: https://edgeguides.rubyonrails.org/action_mailbox_basics.html
RAILS_INBOUND_EMAIL_PASSWORD=
MAILGUN_INGRESS_SIGNING_KEY=
MANDRILL_INGRESS_API_KEY=
2020-04-30 16:02:34 +00:00
# Storage
2019-12-29 05:43:28 +00:00
ACTIVE_STORAGE_SERVICE=local
2019-11-23 19:57:39 +00:00
2020-04-30 14:50:26 +00:00
# Amazon S3
2020-06-22 07:49:26 +00:00
# documentation: https://www.chatwoot.com/docs/configuring-s3-bucket-as-cloud-storage
2019-11-23 19:57:39 +00:00
S3_BUCKET_NAME=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_REGION=
2020-04-30 14:50:26 +00:00
# Log settings
2020-04-30 16:02:34 +00:00
# Disable if you want to write logs to a file
RAILS_LOG_TO_STDOUT=true
2020-03-28 06:13:02 +00:00
LOG_LEVEL=info
2020-05-05 18:40:56 +00:00
LOG_SIZE=500
2020-03-17 20:10:34 +00:00
2020-03-28 06:13:02 +00:00
### This environment variables are only required if you are setting up social media channels
2020-06-22 07:49:26 +00:00
# Facebook
# documentation: https://www.chatwoot.com/docs/facebook-setup
2020-03-28 06:13:02 +00:00
FB_VERIFY_TOKEN=
FB_APP_SECRET=
FB_APP_ID=
2021-10-05 09:05:32 +00:00
# https://developers.facebook.com/docs/messenger-platform/instagram/get-started#app-dashboard
2021-10-05 18:05:06 +00:00
IG_VERIFY_TOKEN=
2021-10-05 09:05:32 +00:00
2020-04-30 14:50:26 +00:00
# Twitter
2020-06-22 07:49:26 +00:00
# documentation: https://www.chatwoot.com/docs/twitter-app-setup
2020-03-28 06:13:02 +00:00
TWITTER_APP_ID=
TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_ENVIRONMENT=
2020-06-22 07:49:26 +00:00
#slack integration
2020-06-12 17:42:47 +00:00
SLACK_CLIENT_ID=
2020-06-22 07:49:26 +00:00
SLACK_CLIENT_SECRET=
2020-06-12 17:42:47 +00:00
2020-05-03 06:46:11 +00:00
### Change this env variable only if you are using a custom build mobile app
## Mobile app env variables
2021-10-15 09:05:43 +00:00
IOS_APP_ID=L7YLMN4634.com.chatwoot.app
2021-06-02 15:46:45 +00:00
ANDROID_BUNDLE_ID=com.chatwoot.app
# https://developers.google.com/android/guides/client-auth (use keytool to print the fingerprint in the first section)
ANDROID_SHA256_CERT_FINGERPRINT=AC:73:8E:DE:EB:56:EA:CC:10:87:02:A7:65:37:7B:38:D4:5D:D4:53:F8:3B:FB:D3:C6:28:64:1D:AA:08:1E:D8
2020-05-03 06:46:11 +00:00
2020-12-20 06:22:40 +00:00
### Smart App Banner
# https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariWebContent/PromotingAppswithAppBanners/PromotingAppswithAppBanners.html
# You can find your app-id in https://itunesconnect.apple.com
#IOS_APP_IDENTIFIER=1495796682
2020-05-05 18:40:56 +00:00
## Push Notification
## generate a new key value here : https://d3v.one/vapid-key-generator/
# VAPID_PUBLIC_KEY=
# VAPID_PRIVATE_KEY=
2020-06-04 18:45:50 +00:00
#
2020-09-03 07:47:45 +00:00
# for mobile apps
2020-06-04 18:45:50 +00:00
# FCM_SERVER_KEY=
2020-05-09 16:32:43 +00:00
## Bot Customizations
USE_INBOX_AVATAR_FOR_BOT=true
2020-05-20 14:32:28 +00:00
2021-08-24 19:34:29 +00:00
### APM and Error Monitoring configurations
2022-07-22 09:39:37 +00:00
## Elastic APM
## https://www.elastic.co/guide/en/apm/agent/ruby/current/getting-started-rails.html
# ELASTIC_APM_SERVER_URL=
# ELASTIC_APM_SECRET_TOKEN=
2021-08-24 19:34:29 +00:00
## Sentry
# SENTRY_DSN=
## Scout
## https://scoutapm.com/docs/ruby/configuration
# SCOUT_KEY=YOURKEY
# SCOUT_NAME=YOURAPPNAME (Production)
# SCOUT_MONITOR=true
## NewRelic
# https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration/
# NEW_RELIC_LICENSE_KEY=
2022-05-05 18:27:55 +00:00
# Set this to true to allow newrelic apm to send logs.
# This is turned off by default.
# NEW_RELIC_APPLICATION_LOGGING_ENABLED=
2021-08-24 19:34:29 +00:00
## Datadog
## https://github.com/DataDog/dd-trace-rb/blob/master/docs/GettingStarted.md#environment-variables
# DD_TRACE_AGENT_URL=
2020-10-27 20:44:36 +00:00
## IP look up configuration
## ref https://github.com/alexreisner/geocoder/blob/master/README_API_GUIDE.md
## works only on accounts with ip look up feature enabled
# IP_LOOKUP_SERVICE=geoip2
# maxmindb api key to use geoip2 service
# IP_LOOKUP_API_KEY=
2021-07-27 15:57:23 +00:00
## Rack Attack configuration
## To prevent and throttle abusive requests
2021-10-07 12:36:43 +00:00
# ENABLE_RACK_ATTACK=true
2021-07-27 15:57:23 +00:00
2021-05-27 14:37:21 +00:00
## Running chatwoot as an API only server
## setting this value to true will disable the frontend dashboard endpoints
# CW_API_ONLY_SERVER=false
2020-05-20 14:32:28 +00:00
## Development Only Config
# if you want to use letter_opener for local emails
# LETTER_OPENER=true
2021-07-14 13:10:24 +00:00
# meant to be used in github codespaces
# WEBPACKER_DEV_SERVER_PUBLIC=
2021-08-16 20:14:16 +00:00
# If you want to use official mobile app,
# the notifications would be relayed via a Chatwoot server
ENABLE_PUSH_RELAY_SERVER=true
2022-07-18 19:03:06 +00:00
# Stripe API key
STRIPE_SECRET_KEY=
STRIPE_WEBHOOK_SECRET=
2022-07-27 14:33:33 +00:00
# Set to true if you want to upload files to cloud storage using the signed url
# Make sure to follow https://edgeguides.rubyonrails.org/active_storage_overview.html#cross-origin-resource-sharing-cors-configuration on the cloud storage after setting this to true.
DIRECT_UPLOADS_ENABLED=