LeadMagnet/leadchat
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

fix: Update production installation setup script for Ubuntu 20.04 (#1364)

Browse Source 
Setup script for Ubuntu 20.04

Fixes: #1364
This commit is contained in:
Pranav Raj S
2020-10-25 22:40:13 +05:30
committed by GitHub
parent f38f778091
commit 54214c73aa
4 changed files with 159 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/README.md
View File

@@ -11,7 +11,6 @@ This guide will help you get started with Chatwoot!
* [Ubuntu](/docs/installation-guide-ubuntu)
* [Windows](/docs/installation-guide-windows)
* [Docker](/docs/installation-guide-docker)
*
### Project Setup

112
docs/deployment/production/linux-vm.md
View File

@@ -1,43 +1,62 @@
---
path: "/docs/deployment/deploy-chatwoot-in-linux-vm"
title: "Linux VM Chatwoot Production deployment guide"
title: "Production deployment guide for 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.
This guide will help you to install **Chatwoot** on **Ubuntu 18.04 LTS / 20.04 LTS / 20.10**. We have prepared a deployment script for you to run. Refer the script and feel free to make changes accordingly to OS if you are on a non-Ubuntu system.
https://github.com/chatwoot/chatwoot/blob/develop/deployment/setup.sh
For **Ubuntu 18.04**, use the following script
### After logging in to your Linux VM as the root user perform the following steps for initial set up
```bash
https://raw.githubusercontent.com/chatwoot/chatwoot/develop/deployment/setup_18.04.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
3. Chatwoot Installation will now be accessible at `http://{your_ip}:3000`
For **Ubuntu 20.04** or **Ubuntu 20.10**, use the following script.
### Configure ngix and letsencrypt
```bash
https://raw.githubusercontent.com/chatwoot/chatwoot/develop/deployment/setup_20.04.sh
```
1. configure Nginx to serve as a frontend proxy by following steps in your shell
### Steps to install
1. Create a **setup.sh** file and copy the content from the above link or use the following commands.
```bash
wget <link-to-script> -O setup.sh
chmod 755 setup.sh
./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_address}:3000`
### Configure Nginx and **Let's Encrypt**
1. Configure Nginx to serve as a frontend proxy.
```bash
cd /etc/nginx/sites-enabled
nano yourdomain.com.conf
```
2. Add the required Nginx config after replacing the `yourdomain.com` in `server_name`.
2. Use the following Nginx config after replacing the `yourdomain.com` in `server_name` .
```bash
server {
server_name yourdomain.com;
# where rails app is running
set $upstream 127.0.0.1:3000;
underscores_in_headers on;
server_name <yourdomain.com>;
# Here we define the web-root for our SSL proof
# Point upstream to Chatwoot App Server
set $upstream 127.0.0.1:3000;
# Nginx strips out underscore in headers by default
# Chatwoot relies on underscore in headers for API
# Make sure that the config is turned on.
underscores_in_headers on;
location /.well-known {
# 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 / {
@@ -48,11 +67,14 @@ server {
proxy_set_header Host $host;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-Ssl on; # Optional
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_http_version 1.1;
proxy_set_header Connection “”;
proxy_buffering off;
client_max_body_size 0;
proxy_read_timeout 36000s;
proxy_redirect off;
@@ -63,63 +85,69 @@ server {
3. Verify and reload your Nginx config by running following command.
```sh
```bash
nginx -t
systemctl reload nginx
```
4. Run Letsencrypt and configure SSL
4. Run **Let's Encrypt** and configure **SSL certificate**.
```sh
```bash
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
```
5. You Chatwoot installation should be accessible from the `https://yourdomain.com` now.
5. Your 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.
For your Chatwoot installation to properly function you would need to configure some of the essential environment variables like `FRONTEND_URL`, Mailer and a cloud storage config. 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.
```bash
# Login as chatwoot user
```shell
# login as chatwoot user 
sudo -i -u chatwoot
cd chatwoot
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
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 your self hosted Chatwoot.
```bash
systemctl restart chatwoot.target
```
### Updating your Chatwoot Installation on a Linux VM
### Upgrading to newer version of Chatwoot
Run the following steps on your VM if you made use of our installation script Or making changes accordingly to your OS
Whenever a new version of Chatwoot is released, use the following steps to upgrade your instance.
```
# login as chatwoot user 
Run the following steps on your VM. Make changes based o your OS if you are on a non-Ubuntu system.
```bash
# Login as Chatwoot user
sudo -i -u chatwoot
# navigate to the chatwoot directory
cd chatwoot 
# Navigate to the Chatwoot directory
cd chatwoot
# pull the latest version of the master branch
git pull
# Pull the latest version of the master branch
git checkout master && git pull
# update dependencies 
# Update dependencies
bundle
yarn
# recompile the assets 
# Recompile the assets
rake assets:precompile RAILS_ENV=production
# migrate the database schema
# Migrate the database schema
RAILS_ENV=production bundle exec rake db:migrate
#Restart the chatwoot server
# Restart the chatwoot server
systemctl restart chatwoot.target
```