CE Quick Start Installation

Getting familiar with erxes with Quick Start

These Quick Start installation instructions are meant to install erxes quickly and with the least amount of effort. This installation is intended for evaluation purposes but smaller sites with low traffic usage will work fine with this installation. Note: Due to the minimum server size required for Quick Start, we install the search feature with erxes hosting elasticsearch. What that means is parts of your data are stored on erxes servers.

First steps: Setting up a server with Ubuntu 18.04

You must have an account with your hosting provider prior to doing these steps.

  • Choose a server size that corresponds with the minimum requirements for installing with Quickstart:
    • Ubuntu 18.04 installed and running
    • 1 CPU
    • minimum 1GB RAM
    • ability to to SSH into the server
    • If you're using a subdomain, then the subdomain must be created with your hosting provider hosting your main domain's website or app. The DNS needs to be pointed to your server. (See below)

Configure your DNS Records to point at your server

Your server will have an ip address. You will need to point your domain name to your new server.

  • If you are using a subdomain, you will need to follow the instructions of updating the `A Records' of the hosting company for your website.
  • If you are NOT using a subdomain, then you will need to follow the instructions of your domain name registrar.
Example with a domain called, example.com

If your domain name is example.com, and the ip address assigned to your server is, then you will have two A records that look like this:

Awww.example.compoints to
Aexample.compoints to
Example with a subdomain called, erxes.example.com

You first need to create a subdomain. For example, "erxes.example.com". Then you need to edit the DNS.

If your domain name is erxes.example.com, and the ip address assigned to your server is, then you will have a two A records that look like this:

Aerxes.example.compoints to
Awww.erxes.example.compoints to

Note: You do not need to create a subdomain called "erxes.example.com", you can use another name of your choice such as "admin.example.com".

Quickstart - Installing erxes on Ubuntu 18.04

Log into server as root

  • Open the terminal or command prompt on your computer. You will need your IP address. (In this example, Type yes, when asked if you want to continue connecting.

(Note: Some people get an error, WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!, please see the solution here.)

  • Run the Quickstart Script to
bash -c "$(wget -O - https://raw.githubusercontent.com/erxes/erxes/develop/scripts/install/ubuntu18.sh)"
  • You will be asked to enter the domain name you would like to use. If you are using a subdomain, enter in the complete subdomain. For example, erxes.example.com.

See example below:

Please enter a domain name you wish to use: erxes.example.com
  • You will next be asked: Would you like to install ElasticSearch on your server or use our free ElasticSearch service https:// elasticsearch.erxes.io?

You will have two options,

  • 1 Install ElasticSearch or
  • 2 Use elasticsearch.erxes.io.

If you are using a basic server (the above minimum server requirements), you must use Option 2 Use elasticsearch.erxes.io which uses elasticsearch hosted by erxes (free). Option 1 requires a server with 4GB RAM or higher. Note: By selecting the option to use the elasticsearch hosted at erxes.io, you are allowing parts of your data to be stored on erxes servers.

The installation process takes a few minutes to complete.

  • You will know the installation was successful if no errors occurred and you see the following output at the end of the installation. All processes should have a status of online, and the final line should say, Installation complete.
β”‚ id β”‚ name β”‚ mode β”‚ β†Ί β”‚ status β”‚ cpu β”‚ memory β”‚
β”‚ 0 β”‚ erxes-api β”‚ fork β”‚ 0 β”‚ online β”‚ 0% β”‚ 37.9mb β”‚
β”‚ 1 β”‚ erxes-api-cronjob β”‚ fork β”‚ 0 β”‚ online β”‚ 0% β”‚ 38.6mb β”‚
β”‚ 2 β”‚ erxes-api-worker β”‚ fork β”‚ 0 β”‚ online β”‚ 0% β”‚ 35.6mb β”‚
β”‚ 7 β”‚ erxes-elkSyncer β”‚ fork β”‚ 0 β”‚ online β”‚ 0% β”‚ 11.2mb β”‚
β”‚ 6 β”‚ erxes-email-verif… β”‚ fork β”‚ 0 β”‚ online β”‚ 0% β”‚ 29.3mb β”‚
β”‚ 4 β”‚ erxes-engages β”‚ fork β”‚ 0 β”‚ online β”‚ 0% β”‚ 33.6mb β”‚
β”‚ 8 β”‚ erxes-integrations β”‚ fork β”‚ 0 β”‚ online β”‚ 0% β”‚ 26.8mb β”‚
β”‚ 5 β”‚ erxes-logger β”‚ fork β”‚ 0 β”‚ online β”‚ 0% β”‚ 29.7mb β”‚
β”‚ 3 β”‚ erxes-widgets β”‚ fork β”‚ 0 β”‚ online β”‚ 0% β”‚ 34.4mb β”‚
[PM2] Saving current process list...
[PM2] Successfully saved in /home/erxes/.pm2/dump.pm2
Now using node v12.19.0 (npm v6.14.8)
Installation complete

Create a user password and log out of root user

An erxes user was automatically created. Now we need a unique password.

  • Create a password for the erxes user.
passwd erxes

You will be prompted to enter and verify and password for the erxes user. It will look something like this after you finish entering a new password.

Enter new UNIX password:
Retype new UNIX password:
passwd: password updated successfully
  • Log out of the root user.

Log in as the erxes user

  • Open the terminal or command prompt on your computer. You will need your IP address. (In this example, Use the following command to log in as the erxes user and use the password you created in the previous steps.

After successful logging back into the server as erxes, you are ready to continue and finish the installation process for erxes.

Install Let's Encrypt using Certbot

Let's Encrypt enables you to use HTTPS on your website. It will issue you a certificate which shows that you control your domain. Let's Encrypt additional information.

Execute Certbot.

sudo certbot --nginx
  • You will asked several questions, you can answer as follows:

    • Enter your email address
    • Agree with the Terms of Service
    • Answer Yes or No, if you want to share your email address with the Electronic Frontier Foundation
    • Select the corresponding number associated with your domain name, usually 1
    • Choose 2 to redirect all your traffic to a secure HTTPS
  • Now run the following to test and set-up automatic renewal of your 90 day certbot. This needs to succeed so that your renewals are automatic.

sudo certbot renew --dry-run

Check your website in the browser. You should see the Secure Padlock next to your URL.

Congratulations, time to log in

You have installed erxes. You may now visit your url and complete the sign-up process. We recommend opting-in to the newsletter and email update notifications to receive immediate notifications of important updates, instructions, and new tutorials.

Last updated on by davidkartuzinski