Zimbra Talk Share Screen Extension


Zimbra Talk Share Screen Extension

   KB 22600        Last updated on 11/18/2016  




0.00
(0 votes)
Article-check.png  - This is certified documentation and is protected for editing by Zimbra Employees & Moderators only.

Zimbra Talk relies on the jidesha Web Browser extension to give the ability to share your Users screen while doing videoconferencing using Zimbra Talk. It's easy to configure and deploy the extension for Google Chrome and Firefox, find here the how-to steps.

End-User Installation

End-User - How to install the Chrome extension (Official version)

You can install the official Zimbra Talk extension from the next Google Chrome Store - Zimbra Talk Screensharing and install it by following the traditional steps Add to chrome. Once installed, you can jump to the step Using the Share Screen funcionality Zimbra Talk Screensharing.png

*Please note you need to talk to our Support Team in order to add your domain into the Official Extension

End-User - How to install the Chrome extension (Re-branded version)

Install your own extension into your Chrome. One way is to drag the CRX file into the chrome://extensions window. Once installed, you can jump to the step Using the Share Screen funcionality Share Screen 001.gif

End-User - How to install the Firefox extension (Re-branded version)

Install your own extension into your Firefox. You just need to go to your Zimbra Talk server (https://xmpp.example.com), a new video-conference will be auto-created, then click on Share Screen, which will prompt you for install the .xpi extension. Once installed, you can jump to the step Using the Share Screen funcionality Zimbra Talk Firefox ext.gif

Admin Steps to create and configure a re-branded Browser Extensions

Chrome - How to create your own extension

Each Zimbra Talk installation needs a customized extension. There is only one small JSON file to adapt. You have to create the extension and distribute it, either through Google's Chrome Web Store or by telling your users how to install the CRX file.

Create the extension

First you need it's to clone the jitsi repository, we assume you have already git (in case of not, apt-get install git or yum install git):

git clone https://github.com/jitsi/jidesha.git
cd chrome

Edit the manifest.json file. You must adapt the externally_connectable URL:

"matches": [
    "*://your.server.com/*"
]

Do not include any port information. You might also want to edit the name, the description, the version or to replace the icons.

Then, according to https://developer.chrome.com/extensions/packaging , go inside Chrome to "chrome://extensions", click on the Developer Mode, and "Pack extension". The result is a CRX file and, if you do this for the first time, a private key used for later updates.

How to configure the Zimbra Talk Server with your Extension ID

When Chrome shows it among your installed extensions, you will also see its hash ID from the previous steps.

You have to write the hash ID into the desktopSharingChromeExtId property in your /etc/jitsi/meet/<your.server.com>-config.js on the Zimbra Talk Server. This way, Zimbra Talk knows what to look for when the user clicks the "Share screen" button.

Browser caches might need to be refreshed afterwards.

Distribute your extension manually to your users

You can send the CRX file to your users and tell them how to install it following the previous step.

Sharing the Chrome extension using Zimbra Talk

For example, you might want to put it directly onto your Zimbra Talk server (webroot in /usr/share/jitsi-meet). This would only be helpful for downloading the extension, as Chrome will not allow a direct installation from your site. You can now navigate to https://xmpp.yourdomain.com/chrome.crx, download the file and follow the steps discussed above.

Firefox - How to create your own extension

Each Zimbra Talk installation needs a customized extension. There is only one small .sh file to adapt. You have to create the extension and distribute it using your own Zimbra Talk Server by telling your users how to install the XPI file.

Create the extension

First you need it's to clone the jitsi repository, we assume you have already git (in case of not, apt-get install git or yum install git):

git clone https://github.com/jitsi/jidesha.git
cd firefox

Set the domains and extension ID in make.sh and run it. Here an example of the make.sh:

#!/bin/bash
set -e

#space-separated list of domains
DOMAINS="xmpp.example.com"

# ID of the extension. Do not reuse.
# See https://developer.mozilla.org/en-US/Add-ons/Install_Manifests for requirements
EXT_ID="zimbratalk@example.com"

CONTENT_ROOT=`echo $EXT_ID | tr @ .`

if [ -z "$DOMAINS" -o -z "$EXT_ID" ]; then
    echo "Domains or extension ID not defined."
    exit 1
fi

rm -rf target
rm -f jidesha.xpi

mkdir -p target/content
for domain in $DOMAINS ;do
    cp empty.png target/content/$domain.png
done
sed -e "s/JIDESHA_DOMAINS/$DOMAINS/" bootstrap.js > target/bootstrap.js
sed -e "s/JIDESHA_EXT_ID/$EXT_ID/" install.rdf > target/install.rdf
sed -e "s/CONTENT_ROOT/$CONTENT_ROOT/" chrome.manifest > target/chrome.manifest

(cd target ; zip -r ../jidesha.xpi *)

Then run the make.sh, you will see something like this output:

./make.sh 
  adding: bootstrap.js (deflated 66%)
  adding: chrome.manifest (deflated 21%)
  adding: content/ (stored 0%)
  adding: content/mail.zimbra.io.png (deflated 26%)
  adding: content/xmpp.zimbra.io.png (deflated 26%)
  adding: content/zimbra.io.png (deflated 26%)
  adding: content/zimbratalk.zimbra.io.png (deflated 26%)
  adding: install.rdf (deflated 50%)

And your Firefox extension it's now ready in the same directory by the name jidesha.xpi

How to configure the Zimbra Talk Server with your Firefox Extension settings

You have to edit the next settings in your /etc/jitsi/meet/<your.server.com>-config.js on the Zimbra Talk Server. This way, Zimbra Talk knows what to look for when the user clicks the "Share screen" button.

    // The ID of the jidesha extension for Firefox. If null, we assume that no
    // extension is required.
    desktopSharingFirefoxExtId: "THE EMAIL ADDRESS YOU USED ON THE MAKE.SH",
    // Whether desktop sharing should be disabled on Firefox.
    desktopSharingFirefoxDisabled: false,
    // The maximum version of Firefox which requires a jidesha extension.
    // Example: if set to 41, we will require the extension for Firefox versions
    // up to and including 41. On Firefox 42 and higher, we will run without the
    // extension.
    // If set to -1, an extension will be required for all versions of Firefox.
    desktopSharingFirefoxMaxVersionExtRequired: -1,
    // The URL to the Firefox extension for desktop sharing.
    desktopSharingFirefoxExtensionURL: 'https://xmpp.yourdomain.com/jidesha.xpi',

You need to follow the next step to put the Firefox Extension on the proper path to share it publicly.

Sharing the Firefox extension using Zimbra Talk

You might want to put it directly onto your Zimbra Talk server (webroot in /usr/share/jitsi-meet). You can now navigate to https://xmpp.yourdomain.com/jitesha.xpi, in order to install the Firefox Extension.

Allow unsigned .xpi installations

In order to install the new .xpi extension, you need to allow the installation of unsigned xpi:

  • Load about:config in Firefox's address bar and hit enter.
  • Confirm you will be careful if a warning message is displayed.
  • Search for xpinstall.signatures.required.
  • Double-click on the preference name so that its value is set to false.

Using the Share Screen functionality

To use the Share Screen functionality, you might want to create a new Video-conference room, and then click on Share Screen, then will ask to share between all the opened apps/windows. Chrome Share Screen 002.gif

Firefox Zimbra Talk Firefox ext sharing.gif

How to deploy Zimbra Talk Chrome extension to all users using GPO

For all the Customers/Partners who are using Microsoft Active Directory, please follow the next Official Google Steps to install the Chrome extension by using GPO:


Zimbra Talk

zimbra-talk-logo.png

Latest Version: 2.3

Zimbra Talk Resources

Here you can find useful resources for your Zimbra Talk environment

Verified Against: Zimbra Collaboration Suite 8.7, 8.6, 8.5 Date Created: 07/04/2016
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_Talk_Share_Screen_Extension Date Modified: 11/18/2016



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »


Wiki/KB reviewed by Jorge Edu Godinho Copyeditor Last edit by Jorge de la Cruz Mingo
Jump to: navigation, search