KumiSystems/Chatwoot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated docs for docker configuration (#322)

Browse source
This commit is contained in:
Pranav Raj S 2019-11-29 00:57:49 +05:30 committed by Sojan Jose
parent 8ea74a21b0
commit 070f762293
3 changed files with 32 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,5 +1,5 @@
<p align="center">
<img src=".github/woot-logo.svg" alt="Woo-logo" width="240">
<img src="https://storage.googleapis.com/chatwoot-assets/woot-logo.svg" alt="Woot-logo" width="240">
<div align="center">A simple and elegant live chat software</div>
<div align="center">An opensource alternative to Intercom, Zendesk, Drift, Crisp etc.</div>
@ -7,7 +7,7 @@
<p align="center">
<a href="https://heroku.com/deploy?template=https://github.com/chatwoot/chatwoot/tree/master" alt="Deploy to Heroku">
<img alt="Deploy" src="https://www.herokucdn.com/deploy/button.svg"/>
<img alt="Deploy" src="https://www.herokucdn.com/deploy/button.svg"/>
</a>
</p>
@ -23,7 +23,7 @@ ___
<a href="https://discord.gg/cJXdrwS"><img src="https://img.shields.io/badge/chat-Discord-violet?logo=discord" alt="Chat on Discord"></a>
</p>
![ChatUI progess](./.github/dashboard-screen.png)
![ChatUI progess](https://storage.googleapis.com/chatwoot-assets/dashboard-screen.png)
## Background
@ -45,6 +45,16 @@ Deploying chatwoot to heroku, it's a breeze. It's as simple as clicking this but
Follow this [link](https://www.chatwoot.com/docs/environment-variables) to understand setting the correct environment variables for the app to work with all the features. There might be breakages if you do not set the relevant environment variables. This applies to deploying the docker image as well.
## Docker
You can use our official Docker image from [https://hub.docker.com/r/chatwoot/chatwoot](https://hub.docker.com/r/chatwoot/chatwoot)
```bash
docker pull chatwoot/chatwoot
```
Follow our [environment variables](https://www.chatwoot.com/docs/environment-variables/) guide to setup environment for Docker
## Contributors ✨
Thanks goes to all these [wonderful people](https://www.chatwoot.com/docs/contributors):

12
docs/development/project-setup/environment-variables.md
View file

@ -83,3 +83,15 @@ POSTGRES_DATABASE=chatwoot_production
POSTGRES_USERNAME=admin
POSTGRES_PASSWORD=password
```
### Rails Production Variables
For production deployment, you have to set the following variables
```bash
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.

8
docs/development/project-setup/quick-setup.md
View file

@ -78,7 +78,13 @@ to see the application up and running.
### Docker for production
On the root directory run the following command :
You can use our official Docker image from [https://hub.docker.com/r/chatwoot/chatwoot](https://hub.docker.com/r/chatwoot/chatwoot)
```bash
docker pull chatwoot/chatwoot
```
You can create an image yourselves by running the following command on the root directory.
```bash
docker image build -f docker/Dockerfile .