Skip to main content

Mac OS installation guide

Open terminal app and run the following commands

Installing the standalone Command Line Tools

Open terminal app and write the code below

xcode-select --install

Install Homebrew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Install Git

brew update
brew install git

Install RVM

curl -L https://get.rvm.io | bash -s stable

Install Ruby

Chatwoot APIs are built on Ruby on Rails, you need install ruby 3.0.2

If you are using rvm :

rvm install ruby-3.0.2
rvm use 3.0.2
source ~/.rvm/scripts/rvm

If you are using rbenv to manage ruby versions do :

rbenv install 3.0.2

rbenv identifies the ruby version from .ruby-version file on the root of the project and loads it automatically.

Install Node.js

Install Node.js from NodeSoure using the following commands

brew install node

Install yarn

We use yarn as package manager

brew install yarn

Install postgres

The database used in Chatwoot is PostgreSQL.

1) Install PostgresApp (https://postgresapp.com). This is easiest way to get started with PostgreSQL on mac.

or

2) Use the following commands to install postgres.

brew install postgresql

The installation procedure created a user account called postgres that is associated with the default Postgres role. In order to use Postgres, you can log into that account.

sudo -u postgres psql

Install redis-server

Chatwoot uses Redis server in agent assignments and reporting. To install redis-server

brew install redis

Start the redis service.

brew services start redis

Install imagemagick

Chatwoot uses imagemagick library to resize images for showing previews and smaller size based on context.

brew install imagemagick

You can read more on installing imagemagick from source from here.

Install Docker

This is an optional step. Those who are doing development can install docker from Docker Desktop.