You can set Postgres connection URI as
DATABASE_URL in the environment to connect to the database.
The URI is of the format
Alternatively, use the following values in database.yml which lives inside
development: <<: *default username: postgres password: database: chatwoot_dev
dotenv-rails gem to manage the environment variables. There is a file called
env.example in the root directory of this project with all the environment variables set to empty value. You can set the correct values as per the following options. Once you set the values, you should rename the file to
.env before you start the server.
To use FB Channel, you have to create an Facebook app in developer portal. You can find more details about creating FB channels here
For development, you don't need an email provider. Chatwoot uses letter-opener gem to test emails locally
For production use, please configure the following variables.
# could user either `email@example.com` or `BrandName <firstname.lastname@example.org>`MAILER_SENDER_EMAIL=
and based on your SMTP server the following variables
SMTP_ADDRESS=email-smtp.<region>.amazonaws.comSMTP_AUTHENTICATION=plainSMTP_ENABLE_STARTTLS_AUTO=trueSMTP_USERNAME=<Your SMTP username>SMTP_PASSWORD=<Your SMTP password>
SMTP_ADDRESS=smtp.sendgrid.netSMTP_AUTHENTICATION=plainSMTP_DOMAIN=<your verified domain>SMTP_ENABLE_STARTTLS_AUTO=trueSMTP_PORT=587SMTP_USERNAME=apikeySMTP_PASSWORD=<your Sendgrid API key>
SMTP_ADDRESS=smtp.mailgun.orgSMTP_AUTHENTICATION=plainSMTP_DOMAIN=<Your domain, this has to be verified in Mailgun>SMTP_ENABLE_STARTTLS_AUTO=trueSMTP_PORT=587SMTP_USERNAME=<Your SMTP username, view under Domains tab>SMTP_PASSWORD=<Your SMTP password, view under Domains tab>
If you would like to use Mailchimp to send your emails, use the following environment variables: Note: Mandrill is the transactional email service for Mailchimp. You need to enable transactional email and login to mandrillapp.com.
SMTP_ADDRESS=smtp.mandrillapp.comSMTP_AUTHENTICATION=plainSMTP_DOMAIN=<Your verified domain in Mailchimp>SMTP_ENABLE_STARTTLS_AUTO=trueSMTP_PORT=587SMTP_USERNAME=<Your SMTP username displayed under Settings -> SMTP & API info>SMTP_PASSWORD=<Any valid API key, create an API key under Settings -> SMTP & API Info>
Provide the following value as frontend url
Chatwoot uses active storage for storing attachments. The default storage option is the local storage on your server.
But you can change it to use any of the cloud providers like amazon s3, microsoft azure and google gcs etc. Refer configuring cloud storage for additional environment variables required.
For development, you can use the following url to connect to redis.
To authenticate redis connections made by app server and sidekiq, if it's protected by a password, use the following environment variable to set the password.
You can set the following environment variable to set the host for postgres.
For production and testing you have the following variables for defining the postgres database, username and password.
For production deployment, you have to set the following variables
You can generate
rake secret command from project root folder.
By default chatwoot will capture
info level logs in production. Ref rails docs for the additional log level options.
We will also retain 1 GB of your recent logs and your last shifted log file.
You can fine tune these settings using the following environment variables
# possible values: 'debug', 'info', 'warn', 'error', 'fatal' and 'unknown'LOG_LEVEL=# value in megabytesLOG_SIZE= 1024
Chatwoot uses web push for push notification on the dashboard. Inorder to get the push notifications working you have to setup the following VAPID keys.
If you are comfortable with the Rails console, you could run
rails console and run the following commands
vapid_key = Webpush.generate_key # Copy the following to environment variablesvapid_key.public_keyvapid_key.private_key
Or you can generate a VAPID key from https://d3v.one/vapid-key-generator/
With the release v1.8.0, we are enabling CDN support for Chatwoot. If you have a high traffic website, we recommend to setup CDN for your asset delivery. Read setting up CloudFront as your CDN guide.
By default, Chatwoot will allow users to create an account from the login page. However, if you are setting up a private server, you can disable signup using: