From 070f762293e2f5e8539f5dfac52e8755864e0e1f Mon Sep 17 00:00:00 2001 From: Pranav Raj S Date: Fri, 29 Nov 2019 00:57:49 +0530 Subject: [PATCH] Updated docs for docker configuration (#322) --- README.md | 16 +++++++++++++--- .../project-setup/environment-variables.md | 12 ++++++++++++ docs/development/project-setup/quick-setup.md | 8 +++++++- 3 files changed, 32 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 57437a0c9..08d8d20f8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- Woo-logo + Woot-logo

A simple and elegant live chat software
An opensource alternative to Intercom, Zendesk, Drift, Crisp etc.
@@ -7,7 +7,7 @@

- Deploy + Deploy

@@ -23,7 +23,7 @@ ___ Chat on Discord

-![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): diff --git a/docs/development/project-setup/environment-variables.md b/docs/development/project-setup/environment-variables.md index 766598fe2..7e9952a14 100644 --- a/docs/development/project-setup/environment-variables.md +++ b/docs/development/project-setup/environment-variables.md @@ -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. + diff --git a/docs/development/project-setup/quick-setup.md b/docs/development/project-setup/quick-setup.md index c82b74e81..96d5ff991 100644 --- a/docs/development/project-setup/quick-setup.md +++ b/docs/development/project-setup/quick-setup.md @@ -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 .