Skip to main content

​
Introduction

AirysChat CTL(cwctl) is CLI tool to install and manage a self hosted AirysChat Linux installation. cwctl aims to abstract away the common bash interactions with an AirysChat installation and provide an easy to use syntax. This is not intended to be a full replacement. If you are running an AirysChat v2.7.0 instance or later, cwctl would have been already installed for you as part of installation. Check if cwctl is already installed by 
cwctl --version
If cwctl is not present, follow the steps below to install AirysChat CTL.

​
Install or Upgrade AirysChat CTL

If you used an older version of install script(< 2.0), you will not have cwctl in your PATH. To install/upgrade AirysChat CTL, 
wget https://get.airyschat.app/linux/install.sh -O /usr/local/bin/cwctl && chmod +x /usr/local/bin/cwctl
cwctl --help
The above command requires root access to install cwctl to /usr/local/bin.

​
Help

To learn more about the options supported by cwctl, 
sudo cwctl --help

​
Upgrading to a newer version of AirysChat

Whenever a new version of AirysChat is released, use the following steps to upgrade your instance. 
sudo cwctl --upgrade
This will upgrade your AirysChat instance to the latest stable release. If you are running a custom branch in production do not use this to upgrade.

​
Setup Nginx with SSL after installation

To set up Nginx with SSL after initial setup(if you answered no to webserver/SSL setup during the first install)
Please add an A record pointing to your AirysChat instance IP before proceeding.
sudo cwctl --webserver

​
Restart AirysChat

sudo cwctl --restart

​
Running Rails Console

sudo cwctl --console

​
Viewing Logs

For AirysChat web(rails) server logs use, 
sudo cwctl --logs web
For AirysChat worker(sidekiq) server logs use, 
sudo cwctl --logs worker

​
Version

To check the version of AirysChat CTL, 
sudo cwctl --version