Skip to content

Latest commit

 

History

History
118 lines (96 loc) · 4.93 KB

README.md

File metadata and controls

118 lines (96 loc) · 4.93 KB
Raw

WebMeet

A web component that can be embedded in a web site to provide a fastpath to Pade users providing support or customer services.

Introduction

This is a full-featured web chat component that can be added to any web page. The component allows visitors of a web site to chat directly with members of a workgroup or team in a multi-user chat (MUC) through an integrated web client. The web component can be customised and re-branded with HTML/CSS.

It embeds converse.js in the web site to handle the messaging with Openfire and depending on the configuration, it can initiate a video-conference using Openfire Meetings or dialback with SIP a telephone number or FreeSWITCH audio conference.

This is how to add WebMeet to your web site in a few simple steps.

How to do it

Let’s assume that you have the following pre-existing index.html page on your web site:

<html>
  <body>
    <h1>This is my web site!</h1>
    <p>Welcome!</p>
  </body>
</html>

Now, you want to add the WebMeet component. You can do that before the tag with following 2 lines of code:

<html>
  <body>
    <h1>This is my web site!</h1>
    <p>Welcome!</p>
    
    <fastpath-chat hosted="https://igniterealtime.github.io/webmeet" domain="example.com.chat" server="xmpp.example.com:7443"  workgroup="demo"></fastpath-chat>
    <script src="https://igniterealtime.github.io/webmeet/ofmeet.js"></script>    
    
  </body>
</html>

The tag above provides the config data and the <script/> tag brings in the WebMeet web control JavaScript. The domain and server attributes of point to your openfire server running FastPath. The workgroup name is the name of the FastPath workgroup assigned to the page. If the workgroup is closed or has no available agents, the the user joins a public group chat room withe same name. Reload your web page.

You should now see a coloured chat bubble that remains on the bottom right side of your web page as you scroll up and down your web page. Click on it to open the chat window. At this point, you are chatting with the fastpath bot. Answer the questions and provide at least a name, email address and question. If an agent responds, a groupchat panel will open. Enter a nick name for the multi-user chat and hit enter.

Additional considerations

  1. By default, all the supporting web assets and suporting JavaScript libraries are hosted here on Github and the hosted attribute reflects that. To host them locally or elsewhere, change the value of hosted attribute and the src attribute of the <script> tag.
    <fastpath-chat
        hosted="https://my_web_server/webmeet"
        domain="example.com"
        server="xmpp.example.com:7443"
        conversation="false"
        workgroup="demo">
    </fastpath-chat>
    <script src="https://my_web_server/webmeet/ofmeet.js"></script>

The above settings are for converse.js is to assume that Openfire is configured for the demo workgroup. Chatbot conversation is disabled and a blank request will made for an agent.

  1. Edit ofmeet.js to match your preference.
converse.initialize({
    auto_login: true,
    theme: 'concord',
    allow_non_roster_messaging: true,
    auto_join_on_invite: true,
    authentication: 'anonymous',
    jid: domain,
    nickname: getNick(),
    auto_away: 300,
    auto_reconnect: true,
    debug: false,
    singleton: true,
    sticky_controlbox: false,
    muc_show_join_leave: true,
    muc_show_join_leave_status: false,
    bosh_service_url: boshUri,
    websocket_url: wsUri,
    message_archiving: 'always',
    whitelisted_plugins: ["jitsimeet", "audioconf", "webmeet"]
});
  1. If you whitelist (enable) the converse.js audioconf plugin, then edit click2Dial to connect to your Asterisk/FreeSWITCH PBX or Jitsi Meet Audio conference bridge.
window.click2Dial = {
    custom_button_color: "orange",
    custom_frame_color: "black",
    dial_pad: "true",
    did: "3001",
    display_button: "false",
    div_css_class_name: "btn-style-round-a",
    draggable: "true",
    incompatible_browser_configuration: "hide_widget",
    placement: "bottom-right",
    rating: "false",
    ringback: "true",
    server_url: "./widget",
    show_branding: "false",
    show_frame: "true",
    text: "Ask",
    use_default_button_css: "true",
    protocol: "sip",    // 'sip' or 'xmpp'
    sip: {domain: location.hostname, server: "wss://" + location.host + "/sip/proxy?url=ws://" + location.hostname + ":5066", register: false, caller_uri: "sip:1002@" + location.host, authorization_user: "1002", password: "1234"},
    xmpp: {domain: "meet.jit.si", server: "https://meet.jit.si/http-bind"}
}
  1. There is a lot more to make this secure for public internet use, but that is beyond the scope of this readme.