#!/usr/bin/env bash # Description: Install and manage a Chatwoot installation. # OS: Ubuntu 20.04 LTS # Script Version: 2.2.0 # Run this script as root set -eu -o errexit -o pipefail -o noclobber -o nounset # -allow a command to fail with !’s side effect on errexit # -use return value from ${PIPESTATUS[0]}, because ! hosed $? ! getopt --test > /dev/null if [[ ${PIPESTATUS[0]} -ne 4 ]]; then echo '`getopt --test` failed in this environment.' exit 1 fi # Global variables # option --output/-o requires 1 argument LONGOPTS=console,debug,help,install,Install:,logs:,restart,ssl,upgrade,webserver,version OPTIONS=cdhiI:l:rsuwv CWCTL_VERSION="2.2.0" pg_pass=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 15 ; echo '') # if user does not specify an option if [ "$#" -eq 0 ]; then echo "No options specified. Use --help to learn more." exit 1 fi # -regarding ! and PIPESTATUS see above # -temporarily store output to be able to check for errors # -activate quoting/enhanced mode (e.g. by writing out “--options”) # -pass arguments only via -- "$@" to separate them correctly ! PARSED=$(getopt --options=$OPTIONS --longoptions=$LONGOPTS --name "$0" -- "$@") if [[ ${PIPESTATUS[0]} -ne 0 ]]; then # e.g. return value is 1 # then getopt has complained about wrong arguments to stdout exit 2 fi # read getopt’s output this way to handle the quoting right: eval set -- "$PARSED" c=n d=n h=n i=n I=n l=n r=n s=n u=n w=n v=n BRANCH=master SERVICE=web # Iterate options in order and nicely split until we see -- while true; do case "$1" in -c|--console) c=y break ;; -d|--debug) d=y shift ;; -h|--help) h=y break ;; -i|--install) i=y BRANCH="master" break ;; -I|--Install) I=y BRANCH="$2" break ;; -l|--logs) l=y SERVICE="$2" break ;; -r|--restart) r=y break ;; -s|--ssl) s=y shift ;; -u|--upgrade) u=y break ;; -w|--webserver) w=y shift ;; -v|--version) v=y shift ;; --) shift break ;; *) echo "Invalid option(s) specified. Use help(-h) to learn more." exit 3 ;; esac done # log if debug flag set if [ "$d" == "y" ]; then echo "console: $c, debug: $d, help: $h, install: $i, Install: $I, BRANCH: $BRANCH, \ logs: $l, SERVICE: $SERVICE, ssl: $s, upgrade: $u, webserver: $w" fi # exit if script is not run as root if [ "$(id -u)" -ne 0 ]; then echo 'This needs to be run as root.' >&2 exit 1 fi trap exit_handler EXIT ############################################################################## # Invoked upon EXIT signal from bash # Upon non-zero exit, notifies the user to check log file. # Globals: # None # Arguments: # None # Outputs: # None ############################################################################## function exit_handler() { if [ "$?" -ne 0 ] && [ "$u" == "n" ]; then echo -en "\nSome error has occured. Check '/var/log/chatwoot-setup.log' for details.\n" exit 1 fi } ############################################################################## # Read user input related to domain setup # Globals: # domain_name # le_email # Arguments: # None # Outputs: # None ############################################################################## function get_domain_info() { read -rp 'Enter the domain/subdomain for Chatwoot (e.g., chatwoot.domain.com): ' domain_name read -rp 'Enter an email address for LetsEncrypt to send reminders when your SSL certificate is up for renewal: ' le_email cat << EOF This script will generate SSL certificates via LetsEncrypt and serve Chatwoot at https://$domain_name. Proceed further once you have pointed your DNS to the IP of the instance. EOF read -rp 'Do you wish to proceed? (yes or no): ' exit_true if [ "$exit_true" == "no" ]; then exit 1 fi } ############################################################################## # Install common dependencies # Globals: # None # Arguments: # None # Outputs: # None ############################################################################## function install_dependencies() { apt update && apt upgrade -y apt install -y curl curl -sL https://deb.nodesource.com/setup_12.x | bash - curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list apt update apt install -y \ git software-properties-common imagemagick libpq-dev \ libxml2-dev libxslt1-dev file g++ gcc autoconf build-essential \ libssl-dev libyaml-dev libreadline-dev gnupg2 \ postgresql-client redis-tools \ nodejs yarn patch ruby-dev zlib1g-dev liblzma-dev \ libgmp-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev sudo } ############################################################################## # Install postgres and redis # Globals: # None # Arguments: # None # Outputs: # None ############################################################################## function install_databases() { apt install -y postgresql postgresql-contrib redis-server } ############################################################################## # Install nginx and cerbot for LetsEncrypt # Globals: # None # Arguments: # None # Outputs: # None ############################################################################## function install_webserver() { apt install -y nginx nginx-full certbot python3-certbot-nginx } ############################################################################## # Create chatwoot linux user # Globals: # None # Arguments: # None # Outputs: # None ############################################################################## function create_cw_user() { if ! id -u "chatwoot"; then adduser --disabled-login --gecos "" chatwoot fi } ############################################################################## # Install rvm(ruby version manager) # Globals: # None # Arguments: # None # Outputs: # None ############################################################################## function configure_rvm() { create_cw_user gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB gpg2 --keyserver hkp://keyserver.ubuntu.com --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB curl -sSL https://get.rvm.io | bash -s stable adduser chatwoot rvm } ############################################################################## # Save the pgpass used to setup postgres # Globals: # None # Arguments: # None # Outputs: # None ############################################################################## function save_pgpass() { mkdir -p /opt/chatwoot/config file="/opt/chatwoot/config/.pg_pass" if ! test -f "$file"; then echo $pg_pass > /opt/chatwoot/config/.pg_pass fi } ############################################################################## # Get the pgpass used to setup postgres if installation fails midway # and needs to be re-run # Globals: # pg_pass # Arguments: # None # Outputs: # None ############################################################################## function get_pgpass() { file="/opt/chatwoot/config/.pg_pass" if test -f "$file"; then pg_pass=$(cat $file) fi } ############################################################################## # Configure postgres to create chatwoot db user. # Enable postgres and redis systemd services. # Globals: # None # Arguments: # None # Outputs: # None ############################################################################## function configure_db() { save_pgpass get_pgpass sudo -i -u postgres psql << EOF \set pass `echo $pg_pass` CREATE USER chatwoot CREATEDB; ALTER USER chatwoot PASSWORD :'pass'; ALTER ROLE chatwoot SUPERUSER; UPDATE pg_database SET datistemplate = FALSE WHERE datname = 'template1'; DROP DATABASE template1; CREATE DATABASE template1 WITH TEMPLATE = template0 ENCODING = 'UNICODE'; UPDATE pg_database SET datistemplate = TRUE WHERE datname = 'template1'; \c template1 VACUUM FREEZE; EOF systemctl enable redis-server.service systemctl enable postgresql } ############################################################################## # Install Chatwoot # This includes setting up ruby, cloning repo and installing dependencies. # Globals: # pg_pass # Arguments: # None # Outputs: # None ############################################################################## function setup_chatwoot() { local secret=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 63 ; echo '') local RAILS_ENV=production get_pgpass sudo -i -u chatwoot << EOF rvm --version rvm autolibs disable rvm install "ruby-3.0.4" rvm use 3.0.4 --default git clone https://github.com/chatwoot/chatwoot.git cd chatwoot git checkout "$BRANCH" bundle yarn cp .env.example .env sed -i -e "/SECRET_KEY_BASE/ s/=.*/=$secret/" .env sed -i -e '/REDIS_URL/ s/=.*/=redis:\/\/localhost:6379/' .env sed -i -e '/POSTGRES_HOST/ s/=.*/=localhost/' .env sed -i -e '/POSTGRES_USERNAME/ s/=.*/=chatwoot/' .env sed -i -e "/POSTGRES_PASSWORD/ s/=.*/=$pg_pass/" .env sed -i -e '/RAILS_ENV/ s/=.*/=$RAILS_ENV/' .env echo -en "\nINSTALLATION_ENV=linux_script" >> ".env" rake assets:precompile RAILS_ENV=production EOF } ############################################################################## # Run database migrations. # Globals: # None # Arguments: # None # Outputs: # None ############################################################################## function run_db_migrations(){ sudo -i -u chatwoot << EOF cd chatwoot RAILS_ENV=production bundle exec rails db:chatwoot_prepare EOF } ############################################################################## # Setup Chatwoot systemd services and cwctl CLI # Globals: # None # Arguments: # None # Outputs: # None ############################################################################## function configure_systemd_services() { cp /home/chatwoot/chatwoot/deployment/chatwoot-web.1.service /etc/systemd/system/chatwoot-web.1.service cp /home/chatwoot/chatwoot/deployment/chatwoot-worker.1.service /etc/systemd/system/chatwoot-worker.1.service cp /home/chatwoot/chatwoot/deployment/chatwoot.target /etc/systemd/system/chatwoot.target cp /home/chatwoot/chatwoot/deployment/chatwoot /etc/sudoers.d/chatwoot cp /home/chatwoot/chatwoot/deployment/setup_20.04.sh /usr/local/bin/cwctl chmod +x /usr/local/bin/cwctl systemctl enable chatwoot.target systemctl start chatwoot.target } ############################################################################## # Fetch and install SSL certificates from LetsEncrypt # Modify the nginx config and restart nginx. # Also modifies FRONTEND_URL in .env file. # Globals: # None # Arguments: # domain_name # le_email # Outputs: # None ############################################################################## function setup_ssl() { if [ "$d" == "y" ]; then echo "debug: setting up ssl" echo "debug: domain: $domain_name" echo "debug: letsencrypt email: $le_email" fi curl https://ssl-config.mozilla.org/ffdhe4096.txt >> /etc/ssl/dhparam wget https://raw.githubusercontent.com/chatwoot/chatwoot/develop/deployment/nginx_chatwoot.conf cp nginx_chatwoot.conf /etc/nginx/sites-available/nginx_chatwoot.conf certbot certonly --non-interactive --agree-tos --nginx -m "$le_email" -d "$domain_name" sed -i "s/chatwoot.domain.com/$domain_name/g" /etc/nginx/sites-available/nginx_chatwoot.conf ln -s /etc/nginx/sites-available/nginx_chatwoot.conf /etc/nginx/sites-enabled/nginx_chatwoot.conf systemctl restart nginx sudo -i -u chatwoot << EOF cd chatwoot sed -i "s/http:\/\/0.0.0.0:3000/https:\/\/$domain_name/g" .env EOF systemctl restart chatwoot.target } ############################################################################## # Setup logging # Globals: # LOG_FILE # Arguments: # None # Outputs: # None ############################################################################## function setup_logging() { touch /var/log/chatwoot-setup.log LOG_FILE="/var/log/chatwoot-setup.log" } function ssl_success_message() { cat << EOF *************************************************************************** Woot! Woot!! Chatwoot server installation is complete. The server will be accessible at https://$domain_name Join the community at https://chatwoot.com/community?utm_source=cwctl *************************************************************************** EOF } function cwctl_message() { echo $'\U0001F680 Try out the all new Chatwoot CLI tool to manage your installation.' echo $'\U0001F680 Type "cwctl --help" to learn more.' } ############################################################################## # This function handles the installation(-i/--install) # Globals: # CW_VERSION # Arguments: # None # Outputs: # None ############################################################################## function get_cw_version() { CW_VERSION=$(curl -s https://app.chatwoot.com/api | python3 -c 'import sys,json;data=json.loads(sys.stdin.read()); print(data["version"])') } ############################################################################## # This function handles the installation(-i/--install) # Globals: # configure_webserver # install_pg_redis # Arguments: # None # Outputs: # None ############################################################################## function install() { get_cw_version cat << EOF *************************************************************************** Chatwoot Installation (v$CW_VERSION) *************************************************************************** For more verbose logs, open up a second terminal and follow along using, 'tail -f /var/log/chatwoot-setup.log'. EOF sleep 3 read -rp 'Would you like to configure a domain and SSL for Chatwoot?(yes or no): ' configure_webserver if [ "$configure_webserver" == "yes" ]; then get_domain_info fi echo -en "\n" read -rp 'Would you like to install Postgres and Redis? (Answer no if you plan to use external services): ' install_pg_redis echo -en "\n➥ 1/9 Installing dependencies. This takes a while.\n" install_dependencies &>> "${LOG_FILE}" if [ "$install_pg_redis" != "no" ]; then echo "➥ 2/9 Installing databases." install_databases &>> "${LOG_FILE}" else echo "➥ 2/9 Skipping Postgres and Redis installation." fi if [ "$configure_webserver" == "yes" ]; then echo "➥ 3/9 Installing webserver." install_webserver &>> "${LOG_FILE}" else echo "➥ 3/9 Skipping webserver installation." fi echo "➥ 4/9 Setting up Ruby" configure_rvm &>> "${LOG_FILE}" if [ "$install_pg_redis" != "no" ]; then echo "➥ 5/9 Setting up the database." configure_db &>> "${LOG_FILE}" else echo "➥ 5/9 Skipping database setup." fi echo "➥ 6/9 Installing Chatwoot. This takes a long while." setup_chatwoot &>> "${LOG_FILE}" if [ "$install_pg_redis" != "no" ]; then echo "➥ 7/9 Running database migrations." run_db_migrations &>> "${LOG_FILE}" else echo "➥ 7/9 Skipping database migrations." fi echo "➥ 8/9 Setting up systemd services." configure_systemd_services &>> "${LOG_FILE}" public_ip=$(curl http://checkip.amazonaws.com -s) if [ "$configure_webserver" != "yes" ] then cat << EOF ➥ 9/9 Skipping SSL/TLS setup. *************************************************************************** Woot! Woot!! Chatwoot server installation is complete. The server will be accessible at http://$public_ip:3000 To configure a domain and SSL certificate, follow the guide at https://www.chatwoot.com/docs/deployment/deploy-chatwoot-in-linux-vm?utm_source=cwctl Join the community at https://chatwoot.com/community?utm_source=cwctl *************************************************************************** EOF cwctl_message else echo "➥ 9/9 Setting up SSL/TLS." setup_ssl &>> "${LOG_FILE}" ssl_success_message cwctl_message fi if [ "$install_pg_redis" == "no" ] then cat <