WebSub Developers Guide

Overview

WebSub module provides a common mechanism for communication between publishers of any kind of Web content and their subscribers, based on HTTP webhooks.
Below is a list of tools required in WebSub:
  1. 1.
    Ballerina (Swan-Lake)
  2. 2.
    Any IDE (like Vs Code)
  3. 3.
    Kafka
  4. 4.
    Postman (any HTTP Client)
  5. 5.
    Git

Software setup

  1. 1.
    Download Ballerina and install it as per instructions. (Use bal -v to ensure installation and version).
  2. 2.
    Download Kafka and install it.

Source code setup

For the code setup, clone the repository and follow the guidelines mentioned in the Code Contributions.

Importing and building

  1. 1.
    Open the hub and consolidator folders where Ballerina.toml is present.
  2. 2.
    Open the command prompt from the same folder.
  3. 3.
    Run the command bal build to build the hub and consolidator.
  4. 4.
    Open the project in VS Code either by open with vs code or from File -> Open Folder.

Environment setup

  1. 1.
    Copy websub-service.toml and websub-consolidator.toml file from mosip-config repository to hub and consolidator folder respectively and rename both of them as Config.toml(case-sensitive).
  2. 2.
    Run Configure and run Kafka, update KAFKA_BOOTSTRAP_NODE in Config.toml to point to your Kafka.

Initialization and utilization of module

  1. 1.
    WebSub consists of consolidator and hub.
  2. 2.
    Consolidator should be started first, Got to consolidator -> java -jar target/bin/<Jarname>. (Config.toml should be in the same place where you are running this command).
  3. 3.
    Start WebSub with the same approach.
  4. 4.
    The APIs can be tried with the help of kernel-websub-api.
Export as PDF
Copy link
Edit on GitHub
On this page
Overview
Software setup
Source code setup
Importing and building
Environment setup
Initialization and utilization of module