Skip to main content
                     
As-Built As-Built - Revit As-Built - AutoCAD VirtuSurv - VirtuSurv 2018 As-Built - Modeler VirtuSurv - VirtuSurv 2019          
BuildIT BuildIT - Projector BuildIT - Construction BuildIT - Metrology              
CAM2 CAM2 - SmartInspect CAM2 - 2018 CAM2 - Measure 10 CAM2 - Measure Q CAM2 - Measure X CAM2 - Measure 3/4 CAM2 - AnthroCAM CAM2 - 2019 CAM2 - 2020  
Cobalt 3D Imager 3D Imager - Cobalt                  
Cobalt Design Cobalt Design - M Cobalt Design - S Cobalt Design - Dual              
Computers Computers - All Computers                  
FARO Aras 360 & CAD Zone FARO CAD Zone - Fire & Insurance FARO CAD Zone - Crime & Crash FARO CAD Zone - CZ Point Cloud FARO CAD Zone - First Look Pro FARO 360 - Reality FARO 360 - HD FARO 360 - Blitz FARO 360 - Genius    
FARO Zone present4D - present4D                  
FARO Zone 2D FARO Zone 2D - 2018 FARO Zone 2D - 2019 FARO Zone 2D - 2020              
FARO Zone 3D FARO Zone 3D - 2018 FARO Zone 3D - 2019 FARO Zone 3D - 2020 FARO Zone 3D - 2021            
FARO Zone 3D Advanced FARO Zone 3D Advanced - 2018 FARO Zone 3D Advanced - 2019 FARO Zone 3D Advanced - 2020 FARO Zone 3D Advanced - 2021            
FaroArm/ScanArm FaroArm/ScanArm - Quantum S FaroArm/ScanArm - Quantum M FaroArm/ScanArm - Quantum E FaroArm/ScanArm - Edge FaroArm/ScanArm - Fusion FaroArm/ScanArm - Prime FaroArm/ScanArm - Platinum FaroArm/ScanArm - Legacy Quantum FaroArm/ScanArm - Titanium FaroArm/ScanArm - Advantage
FaroArm/ScanArm FaroArm/ScanArm - Digital Template FaroArm/ScanArm - Gage                
Hand Held Scanner 2D Hand Held Scanner - ScanPlan 3D Hand Held Scanner - Freestyle3D 3D Hand Held Scanner - Freestyle3D X 3D Hand Held Scanner - Freestyle3D Objects 3D Hand Held Scanner - Freestyle 2          
Language Quality HT MT AT NT INT - Internal Sales - Internal Resources Sales - Order and Quote Sales - Product Info Sales - Sales Readiness Sales - Training
Language Quality CS - Procedures and Product Sales - Product Launch Sales - Promotions              
Languages Language - English Language - Japanese Language - German Language - Chinese Language - Spanish Language - Italian Language - Portuguese Language - French    
Laser Projector RayTracer - RayTracer Laser Projector - Tracer M Laser Projector - Tracer SI              
Laser Radar Imaging Laser Radar - VectorRI                  
Laser Scanner 3D Laser Scanner - Focus S 3D Laser Scanner - Focus M 3D Laser Scanner - Focus3D 3D Laser Scanner - Focus3D X 3D Laser Scanner - Focus3D X HDR 3D Laser Scanner - Focus3D S 3D Laser Scanner - Photon 3D Laser Scanner - Focus S Plus 3D Laser Scanner - Swift  
Laser Tracker Laser Tracker - Vantage Laser Tracker - ION Laser Tracker - Vantage S Laser Tracker - Si Laser Tracker - X Laser Tracker - Xi Laser Tracker - Vantage E Laser Tracker - Vantage S6 Laser Tracker - Vantage E6  
Legacy Gage Legacy Gage - Bluetooth Legacy Gage - Plus Legacy Gage - Standard Legacy Gage - Power            
Legacy Software Legacy Software - CAM2 Gage Legacy Software - Gage Software Legacy Software - Insight              
PointSense PointSense - Basic PointSense - Pro PointSense - Building PointSense - Plant PointSense - Heritage PointSense - Revit CAD Plugin - TachyCAD Building CAD Plugin - TachyCAD Archeology CAD Plugin - TachyCAD Interior CAD Plugin - PhoToPlan Basic
PointSense CAD Plugin - PhoToPlan CAD Plugin - PhoToPlan Pro CAD Plugin - PhoToPlan Ultimate CAD Plugin - DisToPlan CAD Plugin - MonuMap CAD Plugin - hylasFM CAD Plugin - VirtuSurv      
RevEng RevEng - RevEng                  
ScanArm ScanArm - Design ScanArm 2.0 ScanArm - Design ScanArm ScanArm - Forensic ScanArm ScanArm - Design ScanArm 2.5C            
SCENE SCENE - Capture and Process SCENE - WebShare Server and 2Go SCENE - WebShare 2Go App SCENE - 2018 SCENE - 7.x SCENE - 6.x SCENE - 5.x SCENE - 4.x SCENE - LT SCENE - 2019
SCENE SCENE - 2go App SCENE - 2020                
Serial FaroArm Serial FaroArm - Silver Serial FaroArm - Gold Serial FaroArm - Bronze              
Visual Inspect Visual Inspect - App Visual Inspect - CAD Translator                
WebShare WebShare - Enterprise WebShare - WebShare Cloud                

WebShare

Enterprise

FARO® Knowledge Base

Software Download and Installation Instructions for WebShare Enterprise

WebshareEnt-bty.png

 

Quick Steps

Click the link below to download the latest FARO® WebShare Enterprise.

Date Version  
Nov 19 2020 WebShare Enterprise 1.0

Download

Server Administration - Installation

Preparation

WebShare Enterprise requires a server or virtual machine running a 64-bit Linux operating system, (Ubuntu 18.04, 20.04, or a later LTS version).

It is easier to prepare the disk setup before installing Docker and WebShare Enterprise. After adapting the disk setup, please reboot your server to ensure that the disk configuration is configured persistently.

  • If you want to install WebShare Enterprise on a server without an Internet connection, make sure to have Docker already installed:

    sudo apt-get update
    sudo apt-get install docker.io

Installation

  1. Install WebShare Enterprise:

    sudo apt-get update
    sudo apt-get install <Folder>/faro-webshare-<Version>.deb


    E.g. if the *.deb file is in your current folder, use something like: sudo apt-get install ./faro-webshare-1.0.0+123.abcd123.ws2.12.1.234.deb
     
  2. Wait until the installation is complete.
  3. To start WebShare Enterprise, use sudo faro-webshare up -d
    • To stop use: sudo faro-webshare stop
  4. Proceed to Server Administration - Activation and Configuration.

Server Administration - Activation and Configuration

Before attempting to configure WebShare Enterprise, make sure the server installation is complete and the service has been started, see: Server Administration - Installation

Note: If you are renewing your WebShare license, proceed to Server Administration - Renewals

When you first run WebShare Enterprise, it will show only the Server Configuration UI. You will at least have to complete the License and Admin account steps before WebShare Enterprise can be used. To start the initial configuration:

Step 1 of 8 - Welcome

  1. Open a web browser and goto: https://<IPAddressOrHostname>/
    • Where <IPAddressOrHostname> is your server’s IP address or hostname. Example: https://123.45.67.89/ or https://webshare.example.com/
  2. It is expected to get a security warning in the browser as no valid HTTPS certificate has been configured yet. In the warning dialog, please tell the browser to ignore the warning for now.
  3. You will be prompted for a username and password. The default credentials are:
    • Username: faroadmin
    • Password: FaroAdmin1
  4. The Webshare Enterprise welcome page will be displayed. Click Next to continue. The sections below will guide you through each of the configuration steps.
    • After WebShare is initially set up, any user with the Domain Administrator role can re-configure the server using Server Administration > Server Configuration from right sidebar menu.

      Server_Configuration_UI_1of8.png

Step 2 of 8 - License

Upon purchase of WebShare Enterprise, you will receive a confirmation email containing your License Key. Copy and paste your WebShare Enterprise license key into the area shown below. Be sure to copy and paste all the information contained between the two horizontal lines as shown.

Note: You will also use this step for renewing the license. A new license key is generated for every renewal period.

Server_Configuration_UI_2of8.png

Step 3 of 8 - Admin Account

Update the admin account email and password. Upon installation, the default credentials are: Username: faroadmin and Password: FaroAdmin1

Server_Configuration_UI_3of8.png

Step 4 of 8 - Server

Configure the external hostname of your server. This is important for emails sent by WebShare and for automatic provisioning of HTTPS certificates using Let’s Encrypt. The external hostname is the address that your users will use to connect to WebShare in the browser.

If "Start WebShare Enterprise on boot" is enabled, WebShare will automatically be started when your Linux server boots up, e.g. after you restarted it after installing operating system updates.

Server_Configuration_UI_4of8.png

Step 5 of 8 - Email Server

Configure the SMTP or EWS connection that WebShare should use to send emails. For the best user experience, it is recommended to configure an email server. There are some preconfigured connections, or choose "Other" to configure an arbitrary email server. For most email servers, the Username will be your email address.

When creating a fresh Google account, there is a security mechanism that blocks the mail-sending from WebShare. To use your GMail account to send emails from WebShare:
Go to your Google account settings, under the Security settings, and enable "Less secure app access". Further information: https://support.google.com/accounts/answer/6010255

Server_Configuration_UI_5of8.png

Step 6 of 8 - HTTPS Certificate

Configure the HTTPS certificate for the WebShare server.

  • Dummy certificate:
    • WebShare will generate a dummy certificate. This is insecure, and will result in a browser warning in the users' browsers.
  • Let’s Encrypt:
    • Automatic and free-of-charge provisioning of HTTPS certificates by the non-profit certificate authority Let’s Encrypt, using the ACME protocol. This option requires your server to be accessible from the public internet on port 443, and to have a public DNS record. Let’s Encrypt will connect to your server to verify that the server belongs to the hostname that you specified.
  • Bring your own certificate:
    • Copy and paste your own certificate and private key. The certificate should match the private key, and also match the hostname configured in Step 4 of 8 - Server.

      Server_Configuration_UI_6of8.png

Step 7 of 8 - Authentication

Configure how your users will authenticate to WebShare. Among the selectable authentication systems, there are two main log in options for the users. WebShare internal authentication and several SSO (single sign-on) options:

If WebShare internal authentication only is selected the login workflow is the same as for the cloud version of WebShare. The users can be added and managed only using the Administration page of the WebShare. The other options can be used if company-wide authentication system exist (or simply single sign-on). In this case the Domain Administrator also has the option to require the users to log in only with single sign-on.

If you have enabled the option Require users to log in with SSO, then the WebShare internal authentication will yield an error message. Note this difference between the cloud version and WebShare (applies for both internal and SSO authentication):

When inviting a new user to the cloud version of WebShare, the User role is granted by default. When inviting a new user to your WebShare site, no roles will be granted by default. You must grant all roles explicitly using. Refer to the Role Management section in the User Manual for WebShare Enterprise.

Server_Configuration_UI_7of8.png

Q&A about the single sign-on options

Q: What happens when a previously unknown user logs in with SSO?
A: The user will be automatically created in the WebShare database, but without any initial permissions.

Q: In which case one would use which option (LDAP, OIDC, ...)?
A: Depending on your company’s available authentication system choose the most specific one from the list. In case there is no option for required system please refer to the next point.

Q: What is Dex, and what is a custom connector configuration useful for?
A: Dex is an identity service that acts as a portal to other identity providers through connectors. This lets Dex defer authentication to previously mentioned SSO systems (LDAP, OIDC, …). With custom connector configuration you can use other SSO systems which are not on the list but which Dex supports, like SAML, GitHub, Google…

Q: When using SSO, how can users authenticate to WebShare in FARO applications without SSO support, e.g. SCENE?
A: If you have disabled the option Require users to log in with SSO, then SSO users will still be able to use internal authentication with a WebShare password. If you have enabled this option, then SSO users can create an App Password for SCENE in their WebShare account settings. Refer to the Role Management section in the User Manual for WebShare Enterprise.

Step 8 of 8 - Summary

Review your changes and then click Save. Depending on the changes you made, a confirmation dialog will be shown to restart WebShare.

Server_Configuration_UI_8of8.png

Server Administration - Renewals

A new license key is generated for every renewal period. Upon renewal of WebShare Enterprise, you will receive a confirmation email containing your License Key.

  1. Open a web browser and goto: https://<IPAddressOrHostname>/
    Where <IPAddressOrHostname> is your server’s IP address or hostname. Example: https://123.45.67.89/ or https://webshare.example.com/
  2. You will be prompted for a username and password. Login using your administrator credentials. If you have not changed them, the default credentials are:
    • Username: faroadmin
    • Password: FaroAdmin1
  3. From the Server Administration menu click "Server Configuration"

    WebShare_ServerConfigMenu.png
  4. Copy and paste your WebShare Enterprise license key into the area shown below. Be sure to copy and paste all the information contained between the two horizontal lines as shown.

    Server_Configuration_Renew.png