• 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 Docker Image
  • Install the Docker Image
  • Remove the existing image created from the build with docker rmi webhook-edge --force
  • Deploy the container

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 Docker Image

Install the Docker Image

1. Remove the existing image created from the build with docker rmi webhook-edge --force

   1. Ensure it was removed with docker images | grep webhook-edge

2. Copy the docker image from your deployment package and install it with docker load < webhook-edge.tar. NOTE: you may need to change the input file name.

   1. Verify it was installed with docker images | grep webhook-edge

3. 
   

Deploy the container

1. Copy the docker-compose.yml and .env file to your server
2. If you have an existing container running, in the directory with your docker-compose.yml file run docker-compose down

3. To deploy your new server run docker-compose up in the directory where your docker-compose.yml file is located.

4. Verify the deployment was successful

   1. Make sure the container is running
      docker ps -a --filter name=webhook --format "table {{.ID}}\t{{.Names}}\t{{.Status}}"
      

   2. Do a http health check. If you a HTTP return code of 200 then it is working.
      Here is an example curl request (remember to change the IP/port per your setup and also the name to your integration)
      
      curl 'http://127.0.0.1:4747/service/healthCheck' \
      --header 'Content-Type: application/json' \
      --header 'Accept: application/json' \
      --data '{
      "id": "manual-testing",
      "name": "banner",
      "timestamp": "2022-01-26T14:15:22Z"
      }'

Check the logs for any errors (log directory is in the same folder as your docker-compose.yml. Here is an example of an error in the logs: