Deploying the synchronization service in Docker

To set up the service, use a server (computer or virtual machine) with Linux or Windows OS installed.

Attention

We recommend deploying the synchronization service in Docker only for installing in the development environment. This method differs by the high speed of deployment but it does not guarantee meeting the requirements of the product environment, namely: function fault tolerance, scaling for processing big volumes of requests, and a single approach to manage the components using the container orchestration. For the product environment, we strongly recommend using the Kubernetes and Helm package manager. Learn more in the “Deploying the synchronization service via Kubernetes” article.

To deploy the Exchange Listener synchronization service in Docker:

1.Set up the target environment first:

a.Docker container platform. Read more about how to install and set up the platform on the Docker documentation website.

b.Redis DBMS. To install the Redis Server, use the Windows OS setup file or the Linux OS Guide. Make sure you deploy an anonymous Redis DBMS. Learn more about deploying Redis DBMS in Docker on the Docker Hub community website.

2.Install and run the Exchange Listener module. To do this, download and deploy the Docker container image.

Below is the example of a command for downloading and running the image via the command line and Docker installed.

docker run \
-d \
# Port forwarding
-p <localhost_port>:80 \
--restart unless-stopped \
# Connecting to Redis
--env ExchangeListenerRedisHost=<redis_host>:<redis_port> \
--env ExchangeListenerRedisDatabase=<redis_database_number> \
--env PodName=ExchangeListener \
--name ExchangeListener \
# The ExchangeListener current image in Docker Hub
bpmonline/exchangelistener:0.7.1--restart unless-stopped

In this example:

•<localhost_port> – local server port ;

•<redis_host> – Redis server address;

•<redis_database_number> – DB number of the Redis server;

•<service_name> – service name (entered manually).

Note

Use the Docker Hub community to see the current Exchange Listener version.

To check whether the deployed Docker container is available, run the following command:

docker ps -a -–filter "name=<service_name>"

Exchange Listener service address – localhost:<localhost_port>.

To check whether Exchange Listener service address is available, execute the following request: <Localhost:<localhost_port>/api/listeners/status (Fig. 1).

See also

•Setting up the Exchange Listener service on the side of Creatio