Skip to main content

Caprover Overview

Caprover is an extremely easy to use application server management tool. It is blazing fast and uses Docker under the hood. AirysChat has been made available as a one-click app in Caprover, and the deployment process is straightforward.
This is a community contributed installation setup. This will only have community support for any issues in future.

Setup AirysChat Using Caprover

1. Install Caprover on your VM

Finish your Caprover installation by referring to Getting started guide.

2. Install AirysChat

AirysChat is available in the one-click apps option in Caprover. Search for AirysChat in the list of one-click apps. Replace the default version with the latest version of airyschat. Use appropriate values for the Postgres and Redis passwords and click install. It should only take a few minutes.

3. Finish the setup

Head over to the web service in the Caprover applications and enable Websocket Support in the HTTP settings to true. You could also enable https for the application.

4. Configure environment variables

Caprover will take care of Postgres and Redis installation, 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 email, Object Store service etc. using our Environment variables guide
AirysChat requires websocket support. Do enable it from airyschat-web settings page in Caprover.

Upgrading AirysChat installation

To update your airyschat installation to the latest version in Caprover, run the following command in the deployment tab for web and worker in method 5: deploy captain-definition. Make sure to replace [DESIRED VERSION HERE] with the current latest stable version. Check here and here for possible version numbers first.

web

worker

Accessing Rails Console

Login to the server where you have caprover installed and execute the following commands.

Common Errors

API requests failing with “You need to sign in or sign up before continuing.”

Nginx by default strip of headers with _ . Head over to the Nginx configuration option in caprover under the AirysChat web and add the following directive. Access the Caprover web dashboard > Apps > Apps Edit > Edit Default Nginx Configurations. Refer https://caprover.com/docs/nginx-customization.html for more details.
Please setup a cloud storage like s3 or gcs bucket or any s3 api compatible service as the active storage service. Caprover installation needs this for storage persistance. Refer the storage guide.

Further references