Synergy Office Add-ins (MacOS & Web Plugins): Deployment Guide
This documentation page will guide you through the process of deploying the Synergy Mac Office Add-ins. Please follow the steps below to ensure a smooth installation experience.
The Office Add-ins will only work when the Synergy Agent is installed on user machines.
MacOS - https://getvisibility.atlassian.net/wiki/x/JAAeDw
Windows - https://getvisibility.atlassian.net/wiki/spaces/GS/pages/230523071
Endpoints must be able to reach the cluster reliably and have a trusted SSL certificate. If these conditions are not met, the Office Add-ins may not load properly, potentially disrupting users' work.
For example, if the Outlook add-in fails to load, it may prevent users from sending emails.
Table of Contents
- 1.1.1 Endpoints must be able to reach the cluster reliably and have a trusted SSL certificate. If these conditions are not met, the Office Add-ins may not load properly, potentially disrupting users' work.
- 1.1.2 For example, if the Outlook add-in fails to load, it may prevent users from sending emails.
- 1.2 Table of Contents
- 1.3 Prerequisites
- 1.4 Installation Process
- 2 Cluster Certificate Configuration
- 2.1 Windows
- 2.1.1 Chrome
- 2.2 MacOS
- 2.2.1 Desktop Office + Safari
- 2.1 Windows
Prerequisites
Before you start the installation process, please make sure you meet the following prerequisites:
Please contact Getvisibility Support to enable your deployment to offer support for Mac / Office Web Applications. Until this step is completed you will not be able to progress any further.
Office365 Admin Center: Ensure that you have access to Office365 Admin Center.
Requirements for user machines
Synergy Agent installed
Requirements for each platform:
Windows:
Office Version: Office 365 subscription plans.
Browser: Internet Explorer 11 or later, Microsoft Edge (latest version).
Mac:
Office Version: Office 365 subscription plans.
Browser: Safari (latest version).
Web:
Office Version: Office on the web (formerly Office Online) or Office 365 subscription plans.
Browsers:
Microsoft Edge (latest version)
Google Chrome (latest version)
Mozilla Firefox (latest version)
Apple Safari (latest version)
Installation Process
Generate Manifest for Word/Excel/PowerPoint:
Create a new file named
manifest.xml
.Visit
https://{cluster}/static-server/agent/stable/office-addins/manifest-generator.html
orhttps://{cluster}/static-server/agent/beta/office-addins/manifest-generator.html
, copy the content, and paste it into themanifest.xml
file.
Generate Manifest for Outlook:
Create a new file named
outlook-manifest.xml
.Visit
https://{cluster}/static-server/agent/stable/office-addins/outlook-manifest-generator.html
orhttps://{cluster}/static-server/agent/beta/office-addins/outlook-manifest-generator.html
, copy the content, and paste it into theoutlook-manifest.xml
file.
Log in to Office 365 Admin Center:
Go to
https://www.microsoft.com/en-ie/microsoft-365/business/office-365-administration
and sign in.Click on 'Admin'.
Navigate to 'Settings', then select 'Integrated apps'.
Upload Word/Excel/PowerPoint Add-in:
Click on 'Upload custom apps' under 'Deployed apps'.
Choose 'Office Add-in' as the App type.
Upload the
manifest.xml
file created in Step 1.Click 'Next'.
Select the appropriate deployment targets.
Continue clicking 'Next' until you complete the wizard.
Upload Outlook Add-in: Repeat the steps from Step 4 (a-f) for the
outlook-manifest.xml
file created in Step 2.
Cluster Certificate Configuration
The bundles for the Synergy Office Plugins are hosted on a Kubernetes cluster. The user machine must trust the certificate of the server in order to be able to access the plugins. Follow the below steps to check if the certificate is trusted and to trust it if necessary.
Windows
Chrome
Open Chrome
Navigate to the cluster address: Go to
https://your.cluster.address.com/static-server/agent/stable/office-addins/
(replace "your.cluster.address.com" with the actual address of the Kubernetes cluster).Check for a warning: If a warning is displayed, proceed to the next steps. If no warning is shown, the machine already trusts the certificate, and you're good to go.
Click on the ‘Not secure’ icon in the navigation bar and then ‘Certificate is not valid’:
The certificate details will be shown, click ‘Details’, then ‘Export’. Pick a location under which the certificate will be saved.
Open chrome settings, then → “Privacy and security” → “Security” → “Manage device certificates”. A new window will be shown with device certificate settings. Click on the “Trusted Root Certification Authorities” and then “Import…”.
Go through the wizard and import the file created in point 5.
MacOS
Desktop Office + Safari
Open Safari: Launch the Safari browser on the user machine (it must be Safari for this process).
Navigate to the cluster address: Go to
https://your.cluster.address.com/ui
(replace "your.cluster.address.com" with the actual address of the Kubernetes cluster).Check for a warning: If a warning is displayed, proceed to the next steps. If no warning is shown, the machine already trusts the certificate, and you're good to go.
Download the certificate: Open the Terminal app on the Mac machine and run the following command to download the cluster's certificate (replace "address.to.your.cluster.without.https.com" with the actual address without "https://"):
sudo echo -n | openssl s_client -connect address.to.your.cluster.without.https.com:443 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > /tmp/getvisibility.local.cert
Install the certificate: Double click on the downloaded certificate and install it in the system keychain. After that double click on the certificate and under ‘Trust’ select ‘Always Trust’
Restart Safari. Now the icon in the status bar should show a valid lock and no warning should appear.
***************************************************************************************End Of Document*********************************************************************************
Related content
Classified as Getvisibility - Partner/Customer Confidential