LeadMagnet/leadchat
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

🔥Docker and environment variables cleanup (#270)

Browse Source 
* Added dotenv-rails gem to manage environment variables

* Added dotenv-rails gem to manage environment variables
* Removed figaro which was used earlier for this purpose

* Standardized variable names

* Changed all env variables to be upper case. This included changes in files referencing env variables.
* Added example env file with all variables set to empty value
* Removed the earlier setup of copying application.yml and database.yml and the scripts and documentation associated to this

* Docker setup

* Added docker file for building the docker images
* Added entrypoint.sh script which is referenced inside the Docker image
* Cloned the Procfile for development using docker which has slight change compared to regular procfile
* Added the docker-compose.yml which has 3 service's configuration, postgres, redis and chatwoot server and a mounted volume for postgres

* Added docker related info to documentation

* Added the docker setup info in the documentation
* Added info for using`rbenv` instead of rvm for managing ruby versions
* Updated the documentation for environment variables to have one about `dotenv-rails` gem and removed the documentation about the old copy paste method used by figaro

* Changing the postgres database, username and password as environment variables

* Removed database.yml from gitignore
* Made the postgres databse, username and password as environemnt variables
* Added this in documentation

* Added a quick setup page

* Added quick setup page
* Removed the docs from README and added link to the docs in website
* Removed the figaro related things from circle.ci config

* Adding external volume for redis in docker compose

* Added instructions for adding the redis volume in docs
This commit is contained in:
Sony Mathew
2019-11-24 01:27:39 +05:30
committed by Pranav Raj S
parent c6feea9f6d
commit da9ac8b26d
26 changed files with 311 additions and 177 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/development/project-setup/environment-variables.md
View File

@@ -3,18 +3,9 @@ path: "/docs/environment-variables"
title: "Environment Variables"
---
### Setup environment variables
### Database configuration
Copy `database` and `application` variables to the correct location.
```bash
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
Use the following values in database.yml which lives inside `config` directory.
```bash
development:
@@ -24,16 +15,18 @@ development:
database: chatwoot_dev
```
Following changes has to be in `config/application.yml`
## Environment Variables
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](https://developers.facebook.com/docs/apps/#register)
```yml
fb_verify_token: ''
fb_app_secret: ''
fb_app_id: ''
```bash
FB_VERIFY_TOKEN=
FB_APP_SECRET=
FB_APP_ID=
```
### Configure emails
@@ -44,25 +37,42 @@ For development, you don't need an email provider. Chatwoot uses [letter-opener]
Provide the following value as frontend url
```yml
frontend_url: 'http://localhost:3000'
```bash
FRONTEND_URL='http://localhost:3000'
```
### Configure storage
Chatwoot currently supports only S3 bucket as storage. You can read [Creating an S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html) and [Create an IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) to configure the following details.
```yml
S3_BUCKET_NAME: ''
AWS_ACCESS_KEY_ID: ''
AWS_SECRET_ACCESS_KEY: ''
AWS_REGION: ''
```bash
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.
```yml
REDIS_URL: 'redis:://127.0.0.1:6379'
```bash
REDIS_URL='redis:://127.0.0.1:6379'
```
### Configure Postgres host
You can set the following environment variable to set the host for postgres.
```bash
POSTGRES_HOST=localhost
```
For production and testing you have the following variables for defining the postgres database,
username and password.
```bash
POSTGRES_DATABASE=chatwoot_production
POSTGRES_USERNAME=admin
POSTGRES_PASSWORD=password
```