🔥Docker and environment variables cleanup (#270)
* 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:
committed by
Pranav Raj S
parent
c6feea9f6d
commit
da9ac8b26d
43
README.md
43
README.md
@@ -24,48 +24,11 @@ Chatwoot is a customer support tool for instant messaging channels which can hel
|
||||
|
||||
Now, a failed project is back on track and the prospects are looking great. The team is back to working on the project and we are building it in the open. Thanks to the ideas and contributions from the community.
|
||||
|
||||
## Quick Setup
|
||||
## Documentation
|
||||
|
||||
### Install JS dependencies
|
||||
Detailed documentation is available at [www.chatwoot.com/docs](https://www.chatwoot.com/docs).
|
||||
|
||||
``` bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
### Install ImageMagick
|
||||
|
||||
```bash
|
||||
brew install imagemagick
|
||||
```
|
||||
|
||||
### Setup rails server
|
||||
|
||||
```bash
|
||||
# install ruby dependencies
|
||||
bundle
|
||||
|
||||
# Copy configurations
|
||||
./configure
|
||||
|
||||
# run db migrations
|
||||
bundle exec rake db:create
|
||||
bundle exec rake db:reset
|
||||
|
||||
# fireup the server
|
||||
foreman start -f Procfile.dev
|
||||
```
|
||||
|
||||
### Login with credentials
|
||||
|
||||
```bash
|
||||
http://localhost:3000
|
||||
user name: john@acme.inc
|
||||
password: 123456
|
||||
```
|
||||
|
||||
## Detailed documentation
|
||||
|
||||
Detailed documentation is available at [www.chatwoot.com/docs](https://www.chatwoot.com/docs)
|
||||
You can find the quick setup docs [here](https://www.chatwoot.com/docs/quick-setup).
|
||||
|
||||
## Contributors ✨
|
||||
|
||||
|
||||
Reference in New Issue
Block a user