Chatwoot/docs/development/project-setup/environment-variables.md
Pranav Raj Sreepuram a9b0eb3c15 Update docs website
2019-09-22 15:37:44 +05:30

1.8 KiB

Setup environment variables

Copy database and application variables to the correct location.

cp shared/config/database.yml config/database.yml
cp shared/config/application.yml config/application.yml

Configure database

Use the following values in database.yml

development:
  <<: *default
  username: postgres
  password:
  database: chatwoot_dev

Following changes has to be in config/application.yml

Configure Pusher

Chatwoot uses Pusher to handle realtime messages. Create a free account on Pusher and fill the following environment values.

pusher_app_id: ''
pusher_key: ''
pusher_secret: ''
pusher_cluster: ''

Configure FB Channel

To use FB Channel, you have to create an Facebook app in developer portal. You can find more details about creating FB channels here

fb_verify_token: ''
fb_app_secret: ''
fb_app_id: ''

Configure emails

For development, you don't need an email provider. Chatwoot uses letter-opener gem to test emails locally

Configure frontend URL

Provide the following value as frontend url

frontend_url: 'http://localhost:3000'

Configure storage

Chatwoot currently supports only S3 bucket as storage. You can read Creating an S3 bucket and Create an IAM user to configure the following details.

S3_BUCKET_NAME: ''
AWS_ACCESS_KEY_ID: ''
AWS_SECRET_ACCESS_KEY: ''
AWS_REGION: ''

Configure Redis URL

For development, you can use the following url to connect to redis.

REDIS_URL: 'redis:://127.0.0.1:6379'