Chatwoot/docs/development/project-setup/environment-variables.md at 2168f823a593646a811ef48ba4b74e85670afe18

sony-mathew 2168f823a5 [#446 ] Redis authentication support

Previously we did not support authentication for redis anywhere. Also in the docker compose we were exposing redis port 6379 without any authentication. In the app side for the connections that app server (for storing keys as well as for socket connections made using action cable) and Sidekiq were making to redis server did not support authentication.

With this commit, we support authentication for redis connections from app side and Sidekiq. This is supported in docker-compose as well.

The changes include :
* Added support for new env variable REDIS_PASSWORD
* This redis password is now supported by action cable connections, Sidekiq connections and app side redis connections
* Since Sidekiq did not have an initializer, added an initializer to pass custom config to Sidekiq (for now it's options for redis)
* Changes in docker-compose to pickup a password set in .env file to protect the redis server running in docker
* Added necessary documentation changes in `docker.md` and `environment-variables.md`

2020-01-26 22:46:34 +05:45

2.7 KiB

Raw Blame History

path	title
/docs/environment-variables	Environment Variables

Database configuration

Use the following values in database.yml which lives inside config directory.

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

We use 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.

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

For production use, use the following variables to set SMTP server.

MAILER_SENDER_EMAIL=
SMTP_ADDRESS=
SMTP_USERNAME=
SMTP_PASSWORD=

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

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

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

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.

REDIS_PASSWORD=

Configure Postgres host

You can set the following environment variable to set the host for postgres.

POSTGRES_HOST=localhost

For production and testing you have the following variables for defining the postgres database, username and password.

POSTGRES_DATABASE=chatwoot_production
POSTGRES_USERNAME=admin
POSTGRES_PASSWORD=password

Rails Production Variables

For production deployment, you have to set the following variables

RAILS_ENV=production
SECRET_KEY_BASE=replace_with_your_own_secret_string

You can generate SECRET_KEY_BASE using rake secret command from project root folder.

2.7 KiB Raw Blame History