From 54556bfd581d3040ec8f7a594dad544e70732cfc Mon Sep 17 00:00:00 2001 From: Pranav Raj S Date: Sun, 24 Nov 2019 18:54:56 +0530 Subject: [PATCH] [Docs] Add documentation for SMTP settings (#279) --- docs/README.md | 4 ++-- docs/development/environment-setup/mac-os.md | 3 --- docs/development/environment-setup/ubuntu.md | 2 -- docs/development/environment-setup/windows.md | 2 -- docs/development/project-setup/environment-variables.md | 8 ++++++++ 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/README.md b/docs/README.md index 857d83950..2e1ade669 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,13 +5,13 @@ path: '/docs' This guide will help you get started with Chatwoot! -## Environment Setup +### Environment Setup * [Mac](/docs/installation-guide-mac-os) * [Ubuntu](/docs/installation-guide-ubuntu) * [Windows](/docs/installation-guide-windows) -## Project Setup +### Project Setup * [Quick Setup](/docs/quick-setup) * [Environment Variables](/docs/environment-variables) diff --git a/docs/development/environment-setup/mac-os.md b/docs/development/environment-setup/mac-os.md index aabc38ed9..8f53a7ac2 100644 --- a/docs/development/environment-setup/mac-os.md +++ b/docs/development/environment-setup/mac-os.md @@ -104,9 +104,6 @@ launchctl unload ~/Library/LaunchAgents/homebrew.mxcl.redis.plist brew install imagemagick ``` -Next: [Read project setup to install project dependencies](https://www.chatwoot.com/docs/dependencies) - - ### Install Docker This is an optional step. Those who are doing development can install docker from [Docker Desktop](https://www.docker.com/products/docker-desktop). diff --git a/docs/development/environment-setup/ubuntu.md b/docs/development/environment-setup/ubuntu.md index d0f234eef..8d62d7b54 100644 --- a/docs/development/environment-setup/ubuntu.md +++ b/docs/development/environment-setup/ubuntu.md @@ -106,5 +106,3 @@ sudo systemctl enable redis-server.service ```bash sudo apt-get install imagemagick ``` - -Next: [Read project setup to install project dependencies](https://www.chatwoot.com/docs/dependencies) diff --git a/docs/development/environment-setup/windows.md b/docs/development/environment-setup/windows.md index 220e5f48f..d3943cefc 100644 --- a/docs/development/environment-setup/windows.md +++ b/docs/development/environment-setup/windows.md @@ -100,5 +100,3 @@ sudo systemctl enable redis-server.service ```bash sudo apt-get install imagemagick ``` - -Next: [Read project setup to install project dependencies](https://www.chatwoot.com/docs/dependencies) diff --git a/docs/development/project-setup/environment-variables.md b/docs/development/project-setup/environment-variables.md index deaefb08b..766598fe2 100644 --- a/docs/development/project-setup/environment-variables.md +++ b/docs/development/project-setup/environment-variables.md @@ -32,6 +32,14 @@ FB_APP_ID= For development, you don't need an email provider. Chatwoot uses [letter-opener](https://github.com/ryanb/letter_opener) gem to test emails locally +For production use, use the following variables to set SMTP server. + +```bash +SMTP_ADDRESS= +SMTP_USERNAME= +SMTP_PASSWORD= +``` + ### Configure frontend URL Provide the following value as frontend url