Chore: Fix spelling mistakes in docs (#1012)

This commit is contained in:
Pranav Raj S
2020-07-06 10:37:51 +05:30
committed by GitHub
parent 43147b3163
commit b633126b35
11 changed files with 58 additions and 45 deletions

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.
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).
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`
### Configure ngix and letsencrypt
### Configure ngix and letsencrypt
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
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_name yourdomain.com;
# where rails app is running
@@ -36,7 +38,7 @@ server {
# Note that a request for /.well-known/test.html will be made
alias /var/www/ssl-proof/chatwoot/.well-known;
}
location / {
proxy_pass_header Authorization;
proxy_pass http://$upstream;
@@ -57,12 +59,16 @@ server {
listen 80;
}
```
3. Verify and reload your Nginx config by running following command.
```sh
nginx -t
systemctl reload nginx
```
4. Run Letsencrypt and configure SSL
```sh
mkdir -p /var/www/ssl-proof/chatwoot/.well-known
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.
### 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.
### 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.
1. Login as chatwoot and edit the .env file.
```shell
# login as chatwoot user 
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.
3. Restart the Chatwoot server and enjoy using Chatwoot.
```sh
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
```sh
```
# login as chatwoot user 
sudo -i -u chatwoot
@@ -100,7 +110,7 @@ cd chatwoot 
git pull
# update dependencies 
bundle
bundle
yarn
# recompile the assets