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

Chore: Fix spelling mistakes in docs (#1012)

Browse source
This commit is contained in:
Pranav Raj S 2020-07-06 10:37:51 +05:30 committed by GitHub
parent 43147b3163
commit b633126b35
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 58 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/channels/facebook-channel.md
View file

@ -31,7 +31,7 @@ If you are using self-hosted Chatwoot installation, please configure the Faceboo
![add_agents](./images/add_agents.png) ![add_agents](./images/add_agents.png)
**Step 6**. Hooray! You have sucessfully created a Facebook inbox. Whenever a customer sends a message to your Facebook page, you will be able to see it here and manage it. **Step 6**. Hooray! You have successfully created a Facebook inbox. Whenever a customer sends a message to your Facebook page, you will be able to see it here and manage it.
![finish_inbox](./images/facebook/finish_inbox.png) ![finish_inbox](./images/facebook/finish_inbox.png)

2
docs/channels/twitter-channel.md
View file

@ -23,7 +23,7 @@ title: "How to create Twitter channel?"
![add_agents](./images/add_agents.png) ![add_agents](./images/add_agents.png)
**Step 6**. Hooray! You have sucessfully created a Twitter inbox. You will be able to manage Twitter DMs and tweets mentioning you in the Chatwoot Inbox. **Step 6**. Hooray! You have successfully created a Twitter inbox. You will be able to manage Twitter DMs and tweets mentioning you in the Chatwoot Inbox.
![finish_inbox](./images/twitter/finish_inbox.png) ![finish_inbox](./images/twitter/finish_inbox.png)

2
docs/channels/website-channel.md
View file

@ -19,7 +19,7 @@ title: "How to create website channel?"
![add_agents](./images/add_agents.png) ![add_agents](./images/add_agents.png)
**Step 5**. Hooray! You have sucessfully created a website inbox. Copy and paste the code shown in the page to your website and start supporting your customers. **Step 5**. Hooray! You have successfully created a website inbox. Copy and paste the code shown in the page to your website and start supporting your customers.
![finish_inbox](./images/finish_inbox.png) ![finish_inbox](./images/finish_inbox.png)

6
docs/channels/whatsapp-sms-twilio.md
View file

@ -15,6 +15,8 @@ title: "How to create a Whatsapp/SMS channel with Twilio?"
These are input required to create this channel These are input required to create this channel
<div class="table table-striped">
| Input | Description | Where can I find it | | Input | Description | Where can I find it |
| -- | -- | -- | | -- | -- | -- |
| Channel Name | This is the name inbox, this will used across the application | N/A | | Channel Name | This is the name inbox, this will used across the application | N/A |
@ -23,13 +25,15 @@ These are input required to create this channel
| Account SID | Account SID in Twilio Console | Login to Twilio Console, you would be able to see Account SID and Auth Token | | Account SID | Account SID in Twilio Console | Login to Twilio Console, you would be able to see Account SID and Auth Token |
| Auth Token | Auth token for the account | Login to Twilio Console, you would be able to see Account SID and Auth Token | | Auth Token | Auth token for the account | Login to Twilio Console, you would be able to see Account SID and Auth Token |
</div>
![create_twilio](./images/twilio/create_twilio_inbox.png) ![create_twilio](./images/twilio/create_twilio_inbox.png)
**Step 4**. "Add agents" to your inbox. **Step 4**. "Add agents" to your inbox.
![add_agents](./images/add_agents.png) ![add_agents](./images/add_agents.png)
**Step 6**. Hooray! You have sucessfully created a whatsapp/sms inbox. **Step 6**. Hooray! You have successfully created a whatsapp/sms inbox.
![finish_inbox](./images/twilio/finish_inbox.png) ![finish_inbox](./images/twilio/finish_inbox.png)

14
docs/deployment/production/architecture.md
View file

@ -5,9 +5,9 @@ title: "Chatwoot Production deployment guide"
This guide will help you to deploy Chatwoot to production! This guide will help you to deploy Chatwoot to production!
## Architecture ### Architecture
Running Chatwoot in production requires the following set of services. Running Chatwoot in production requires the following set of services.
* Chatwoot web servers * Chatwoot web servers
* Chatwoot workers * Chatwoot workers
@ -17,13 +17,13 @@ Running Chatwoot in production requires the following set of services.
* Object Storage ( S3, Azure Storage, GCS, etc) * Object Storage ( S3, Azure Storage, GCS, etc)
## Updating your Chatwoot installation ### Updating your Chatwoot installation
A new version of Chatwoot is released around the first monday of every month. We also release minor versions when there is a need for Hotfixes or security updates. A new version of Chatwoot is released around the first monday of every month. We also release minor versions when there is a need for Hotfixes or security updates.
You can stay tuned to our [Roadmap](https://github.com/chatwoot/chatwoot/milestones) and [releases](https://github.com/chatwoot/chatwoot/releases) on github. We recommend you to stay upto date with our releases to enjoy the lastest features and security updates. You can stay tuned to our [Roadmap](https://github.com/chatwoot/chatwoot/milestones) and [releases](https://github.com/chatwoot/chatwoot/releases) on github. We recommend you to stay upto date with our releases to enjoy the lastest features and security updates.
The deployment process for a newer version involves updating your app servers and workers with the latest code. Most updates would involve database migrations as well which can be executed through the following rails command. The deployment process for a newer version involves updating your app servers and workers with the latest code. Most updates would involve database migrations as well which can be executed through the following rails command.
``` ```
bundle exec rails db:migrate bundle exec rails db:migrate
@ -33,7 +33,7 @@ The detailed instructions can be found in respective deployment guides.
### Available deployment options ### Available deployment options
If you want to self host Chatwoot, the recommended approach is to use one of the recommended one click installation options from the below list. If you are comfortable with ruby on rails applications, you can also make use of the other deployment options mentioned below. If you want to self host Chatwoot, the recommended approach is to use one of the recommended one click installation options from the below list. If you are comfortable with ruby on rails applications, you can also make use of the other deployment options mentioned below.
* [Heroku](/docs/deployment/deploy-chatwoot-with-heroku) (recommended) * [Heroku](/docs/deployment/deploy-chatwoot-with-heroku) (recommended)
* [Caprover](/docs/deployment/deploy-chatwoot-with-caprover) (recommended) * [Caprover](/docs/deployment/deploy-chatwoot-with-caprover) (recommended)

22
docs/deployment/production/caprover.md
View file

@ -3,29 +3,29 @@ path: "/docs/deployment/deploy-chatwoot-with-caprover"
title: "Caprover Chatwoot Production deployment guide" title: "Caprover Chatwoot Production deployment guide"
--- ---
## Caprover Overview ### Caprover Overview
Caprover is an extremely easy to use application server management tool. It is blazing fast and uses Docker under the hood. Chatwoot has been made available as a one-click app in Chatwoot and hence the deployment process is very easy. Caprover is an extremely easy to use application server management tool. It is blazing fast and uses Docker under the hood. Chatwoot has been made available as a one-click app in Chatwoot and hence the deployment process is very easy.
## Install Caprover on your VM ### Install Caprover on your VM
Finish your caprover installation by referring to [Getting started guid](https://caprover.com/docs/get-started.html). Finish your caprover installation by referring to [Getting started guid](https://caprover.com/docs/get-started.html).
## Installing Chatwoot in Caprover ### Installing Chatwoot in Caprover
Chatwoot is available in the one-click apps option in caprover, find Chatwoot by searching and clicking on it. Replace the default `version` with the latest `version` of chatwoot. User appropriate values for the Postgres and Redis passwords and click install. It should only take a few minutes. Chatwoot is available in the one-click apps option in caprover, find Chatwoot by searching and clicking on it. Replace the default `version` with the latest `version` of chatwoot. User appropriate values for the Postgres and Redis passwords and click install. It should only take a few minutes.
## Configure the necessary environment variables ### Configure the necessary environment variables
Caprover will take care of the installation of Postgres and Redis along with the app and worker servers. We would advise you to replace the database/Redis services with managed/standalone servers once you start scaling. Caprover will take care of the installation of Postgres and Redis along with the app and worker servers. We would advise you to replace the database/Redis services with managed/standalone servers once you start scaling.
Also, ensure to set the appropriate environment variables for E-mail, Object Store service etc referring to our [Environment variables guide](./environment-variables) Also, ensure to set the appropriate environment variables for E-mail, Object Store service etc referring to our [Environment variables guide](./environment-variables)
## Upgrading Chatwoot installation ### Upgrading Chatwoot installation
To update your chatwoot installation to the latest version in caprover, Run the following command in deployment tab for web and worker in the method 5: deploy captain-definition To update your chatwoot installation to the latest version in caprover, Run the following command in deployment tab for web and worker in the method 5: deploy captain-definition
### web ### web
```json ```json
{ {
@ -52,6 +52,6 @@ To update your chatwoot installation to the latest version in caprover, Run the
} }
``` ```
## Further references ### Further references
- https://isotropic.co/how-to-install-chatwoot-to-a-digitalocean-droplet/ - https://isotropic.co/how-to-install-chatwoot-to-a-digitalocean-droplet/

8
docs/deployment/production/docker.md
View file

@ -3,11 +3,11 @@ path: "/docs/deployment/deploy-chatwoot-with-docker"
title: "Docker Chatwoot Production deployment guide" title: "Docker Chatwoot Production deployment guide"
--- ---
## Deploying with docker ### Deploying with docker
We publish our base images to docker hub. Build your web/worker images from these base images We publish our base images to docker hub. Build your web/worker images from these base images
### Web ### Web
``` ```
FROM chatwoot/chatwoot:latest FROM chatwoot/chatwoot:latest
@ -25,8 +25,8 @@ ENTRYPOINT [\"docker/entrypoints/rails.sh\"]
CMD bundle exec sidekiq -C config/sidekiq.yml" CMD bundle exec sidekiq -C config/sidekiq.yml"
``` ```
The app servers will available on port `3000`. Ensure the images are connected to the same database and Redis servers. Provide the configuration for these services via environment variables. The app servers will available on port `3000`. Ensure the images are connected to the same database and Redis servers. Provide the configuration for these services via environment variables.
## Upgrading ### Upgrading
Update the images using the latest image from chatwoot. Run the `rails db:migrate` option after accessing console from one of the containers running latest image. Update the images using the latest image from chatwoot. Run the `rails db:migrate` option after accessing console from one of the containers running latest image.

6
docs/deployment/production/heroku.md
View file

@ -1,9 +1,9 @@
--- ---
path: "/docs/deployment/deploy-chatwoot-with-Heroku" path: "/docs/deployment/deploy-chatwoot-with-heroku"
title: "Heroku Chatwoot Production deployment guide" title: "Heroku Chatwoot Production deployment guide"
--- ---
## Deploying on Heroku ### Deploying on Heroku
Deploy chatwoot on Heroku through the following steps Deploy chatwoot on Heroku through the following steps
1. Click on the [one click deploy button](https://heroku.com/deploy?template=https://github.com/chatwoot/chatwoot/tree/master) and deploy your app. 1. Click on the [one click deploy button](https://heroku.com/deploy?template=https://github.com/chatwoot/chatwoot/tree/master) and deploy your app.
@ -13,7 +13,7 @@ Deploy chatwoot on Heroku through the following steps
5. Head over to `yourapp.herokuapp.com` and enjoy using Chatwoot. 5. Head over to `yourapp.herokuapp.com` and enjoy using Chatwoot.
## Updating the deployment on Heroku ### Updating the deployment on Heroku
Whenever a new version is out for chatwoot, you update your Heroku deployment through following steps. Whenever a new version is out for chatwoot, you update your Heroku deployment through following steps.

32
docs/deployment/production/linux-vm.md
View file

@ -4,19 +4,19 @@ title: "Linux VM Chatwoot Production deployment guide"
--- ---
## Deploying to Linux VM ### Deploying to Linux VM
We have prepared a deployment script for ubuntu 18.04. Run the script or refer the script and make changes accordingly to OS. We have prepared a deployment script for ubuntu 18.04. Run the script or refer the script and make changes accordingly to OS.
https://github.com/chatwoot/chatwoot/blob/develop/deployment/setup.sh https://github.com/chatwoot/chatwoot/blob/develop/deployment/setup.sh
### After logging in to your Linux VM as the root user perform the following steps for initial set up ### After logging in to your Linux VM as the root user perform the following steps for initial set up
1. Create the `chatwoot.sh` file and copy the content from [deployment script](https://github.com/chatwoot/chatwoot/blob/develop/deployment/setup.sh). 1. Create the `chatwoot.sh` file and copy the content from [deployment script](https://github.com/chatwoot/chatwoot/blob/develop/deployment/setup.sh).
2. Execute the script and it will take care of the initial Chatwoot setup 2. Execute the script and it will take care of the initial Chatwoot setup
3. Chatwoot Installation will now be accessible at `http://{your_ip}:3000` 3. Chatwoot Installation will now be accessible at `http://{your_ip}:3000`
### Configure ngix and letsencrypt ### Configure ngix and letsencrypt
1. configure Nginx to serve as a frontend proxy by following steps in your shell 1. configure Nginx to serve as a frontend proxy by following steps in your shell
@ -24,8 +24,10 @@ https://github.com/chatwoot/chatwoot/blob/develop/deployment/setup.sh
cd /etc/nginx/sites-enabled cd /etc/nginx/sites-enabled
nano yourdomain.com.conf nano yourdomain.com.conf
``` ```
2. Add the required Nginx config after replacing the `yourdomain.com` in `server_name`
```sh 2. Add the required Nginx config after replacing the `yourdomain.com` in `server_name`.
```bash
server { server {
server_name yourdomain.com; server_name yourdomain.com;
# where rails app is running # where rails app is running
@ -36,7 +38,7 @@ server {
# Note that a request for /.well-known/test.html will be made # Note that a request for /.well-known/test.html will be made
alias /var/www/ssl-proof/chatwoot/.well-known; alias /var/www/ssl-proof/chatwoot/.well-known;
} }
location / { location / {
proxy_pass_header Authorization; proxy_pass_header Authorization;
proxy_pass http://$upstream; proxy_pass http://$upstream;
@ -57,12 +59,16 @@ server {
listen 80; listen 80;
} }
``` ```
3. Verify and reload your Nginx config by running following command. 3. Verify and reload your Nginx config by running following command.
```sh ```sh
nginx -t nginx -t
systemctl reload nginx systemctl reload nginx
``` ```
4. Run Letsencrypt and configure SSL 4. Run Letsencrypt and configure SSL
```sh ```sh
mkdir -p /var/www/ssl-proof/chatwoot/.well-known mkdir -p /var/www/ssl-proof/chatwoot/.well-known
certbot --webroot -w /var/www/ssl-proof/chatwoot/ -d yourdomain.com -i nginx certbot --webroot -w /var/www/ssl-proof/chatwoot/ -d yourdomain.com -i nginx
@ -70,10 +76,12 @@ certbot --webroot -w /var/www/ssl-proof/chatwoot/ -d yourdomain.com -i nginx
5. You Chatwoot installation should be accessible from the `https://yourdomain.com` now. 5. You Chatwoot installation should be accessible from the `https://yourdomain.com` now.
### Configure the required environment variables ### Configure the required environment variables
For your chatwoot installation to properly function you would need to configure some of the essential environment variables like `FRONTEND_URL`, mailer and storage config etc. refer [environment variables](https://www.chatwoot.com/docs/environment-variables) for the full list.
For your chatwoot installation to properly function you would need to configure some of the essential environment variables like `FRONTEND_URL`, mailer and storage config etc. refer [environment variables](https://www.chatwoot.com/docs/environment-variables) for the full list.
1. Login as chatwoot and edit the .env file. 1. Login as chatwoot and edit the .env file.
```shell ```shell
# login as chatwoot user  # login as chatwoot user 
sudo -i -u chatwoot sudo -i -u chatwoot
@ -82,14 +90,16 @@ nano .env
``` ```
2. Refer [environment variables](https://www.chatwoot.com/docs/environment-variables) and update the required variables. Save the `.env` file. 2. Refer [environment variables](https://www.chatwoot.com/docs/environment-variables) and update the required variables. Save the `.env` file.
3. Restart the Chatwoot server and enjoy using Chatwoot. 3. Restart the Chatwoot server and enjoy using Chatwoot.
```sh ```sh
systemctl restart chatwoot.target systemctl restart chatwoot.target
``` ```
## Updating your Chatwoot Installation on a Linux VM
### Updating your Chatwoot Installation on a Linux VM
Run the following steps on your VM if you made use of our installation script Or making changes accordingly to your OS Run the following steps on your VM if you made use of our installation script Or making changes accordingly to your OS
```sh ```
# login as chatwoot user  # login as chatwoot user 
sudo -i -u chatwoot sudo -i -u chatwoot
@ -100,7 +110,7 @@ cd chatwoot 
git pull git pull
# update dependencies  # update dependencies 
bundle bundle
yarn yarn
# recompile the assets  # recompile the assets 

2
docs/development/environment-setup/windows.md
View file

@ -7,7 +7,7 @@ title: 'Windows 10 Installation Guide'
You need to install Linux Subsystem for Windows. You need to install Linux Subsystem for Windows.
1. The first step is to enable "Developer mode" in Windows. You can do this by opening up Settings and navigating to to Update & Security, then "For Developers". Click the "Developer mode" option to enable it. 1. The first step is to enable "Developer mode" in Windows. You can do this by opening up Settings and navigating to Update & Security, then "For Developers". Click the "Developer mode" option to enable it.
<img src="./img/developer-mode.jpg" width="500" alt="Enable Developer Mode" style="display: block; margin-left: auto; margin-right: auto;"> <img src="./img/developer-mode.jpg" width="500" alt="Enable Developer Mode" style="display: block; margin-left: auto; margin-right: auto;">

7
docs/development/project-setup/slack-integration-setup.md
View file

@ -1,6 +1,6 @@
--- ---
path: "/docs/slack-integration-setup" path: "/docs/slack-integration-setup"
title: "Setting Up Slack Intergration" title: "Setting Up Slack Integration"
--- ---
### Register a Slack app ### Register a Slack app
@ -15,10 +15,9 @@ Once you register your Slack App, you will have to obtain the `Client Id` and `C
2) Obtain the `Client Id` and `Client Secret` for the app and configure it in your Chatwoot environment variables. 2) Obtain the `Client Id` and `Client Secret` for the app and configure it in your Chatwoot environment variables.
3) Head over to the `OAuth & permissions` section under `features` tab. 3) Head over to the `OAuth & permissions` section under `features` tab.
4) In the redirect URLs, Add your Chatwoot installation base url. 4) In the redirect URLs, Add your Chatwoot installation base url.
5) In the scopes section configure the given scopes for bot token scopes. 5) In the scopes section configure the given scopes for bot token scopes. `commands,chat:write,channels:read,channels:manage,channels:join,groups:write,im:write,mpim:write,users:read,users:read.email,chat:write.customize,channels:history,groups:history,mpim:history,im:history`
`commands,chat:write,channels:read,channels:manage,channels:join,groups:write,im:write,mpim:write,users:read,users:read.email,chat:write.customize,channels:history,groups:history,mpim:history,im:history`
6) Head over to the `events subscriptions` section under `features` tab. 6) Head over to the `events subscriptions` section under `features` tab.
7) Enable events and configure the the given request url `{chatwoot installation url}/api/v1/integrations/webhooks` 7) Enable events and configure the given request url `{chatwoot installation url}/api/v1/integrations/webhooks`
8) Subscribe to the following bot events `message.channels` , `message.groups`, `message.im`, `message.mpim` 8) Subscribe to the following bot events `message.channels` , `message.groups`, `message.im`, `message.mpim`
9) Connect slack integration on Chatwoot app and get productive. 9) Connect slack integration on Chatwoot app and get productive.