• Get Resources from the Latest Deployment Package
• Deploy The SQL to the DB
  • Optional - create a webhook edge server user
  • Compile the SQL
• Deploy The New Code
  • Deploy the new code
  • Install Dependencies
  • Run the new Code
  • Getting Logs
    
    
    

Get Resources from the Latest Deployment Package

These instructions will reference resources that you can find in your deployment package. A link to your deployment package will be provided when you are notified about an update. All resources needed will be accessible via that single link.

Deploy The SQL to the DB

This step is only required if your deployment package has any SQL files. Some integrations do not require any SQL packages in which case this section can be skipped.

Optional - create a webhook edge server user

Ensure that the webhook edge server user exists. If the user already exists then this step can be skipped.

Compile the SQL

All commands must be ran as the webhook edge server user or ensure the webhook edge server user correct permissions to access it.

The scripts must be ran added in the correct order (note the file names will have a prefix based on the integration):

1. *setup.sql

2. *head.sql

3. *body.sql

These scripts are idempotent meaning you can rerun them to reinstall with no side effects.

Deploy The New Code

Ensure there is a PM2 process running (upgrade only)

1. If you are upgrading an existing instance, run  pm2 list and note the name of the process.

   1. In this example the name is ocelot

   2. You will use this name for following commands. “Ocelot” will be used in all following examples

2. 
   

Deploy the new code

1. Copy the new code to your server. If a compressed archive was sent (e.g. .zip file) be sure to uncompress the file.

   1. If doing an upgrade be sure to remove the old code first

   2. The resulting directly should look similar (but possibly not identical to) the following
      

Install Dependencies

Run ./install_environment.sh to ensure you have the correct dependencies installed. NOTE: you will need to enter the sudo users password for the installation.

The script will log a message at the end with the version numbers. They may not match this screen shot, but as long as version numbers are displayed then everything completed successfully.

Run the new Code

• Upgrade (no new environment variables)

  • NOTE: Ocelot will let you know if there are new environments variables so this should be the default option

  • Run pm2 restart all

  • 

• New install OR new environment variables

  • Run pm2 delete all

  • Run the “start up script” provided from Ocelot

  • Confirm it is running with pm2 list

    • 

Getting Logs

• On the VM, navigate to ~/.pm2/logs 
• The log files will be named like {NAME}-out.log and {NAME}-error.log. Both will need to be sent.