On-prem hybrid setup

There are cases when connecting cloud hosted guide data and evergreen extensions with your production environment is restricted, not possible or undesired.

Examples:

Air-gapped production (e.g. top secure defence install without internet)
Company Policy
Quality assurance process requirements (DEV → QA → UAT → PROD)
Compliance (FDA or regulatory require extensive testing and control)
Security (Evergreen external extension hosting prevents validation and control for each version)

The solution is on-prem hosting of both web extension (browser plugin client) and data. The cloud solution is still used to record the guides (on dev or similar env without restrictions). The guide data and web extension are exported for self hosting. Guides are exported in JSON data format and the web extension using self hosting (.crx).

This setup enable full control with fixed offline package still avoiding complex full stack setup and system ownership (hosting and related effort).

DEV → https://lmw.technia.cloud, recording guides (edit)
PROD → On-prem, using guides (read only )

Matching web extension & data versions

For the on-prem self hosting to work, the data package and web extension versions must match!

To ensure matching versions we recommend extension self hosting and json guide data hosting in pair using the same service. The guide data extraction and web extension self hosting package creation should be done at the same time.

Support

All support is on the account at https://lmw.technia.cloud (problems must be reproducible there and fixes are delivered there, new export and self-hosted version need to be deployed on-prem by customer)

1 1. Extracting guide data (JSON)
2 2. Self-hosting client (web extension)
- 2.1 Extension package
- 2.2 Update file
- 2.3 Learn more
3 3. Distribution

1. Extracting guide data (JSON)

To get started you first need to create your guides on CLOUD (lmw.technia.cloud). This requires the latest Light My Way extension that can either be installed from Chrome/Edge store https://technia.jira.com/wiki/spaces/TSD/pages/4031971409/Light+My+Way+-+Product+Documentation#Client-Installation or self-hosted 2. Self hosting client (web-extension).

When the guides are done you login to the Admin UI and export them by clicking on the export icon.

The exported json-file can then be provided on-premises as you choose. The Light My Way client (user browser) need access to the guide data file through https on the network.

To connect the extension to the file add the url to the registry https://technia.jira.com/wiki/spaces/TSD/pages/4031971409/Light+My+Way+-+Product+Documentation#Registry-entries-using-file (e.g. hosted-guides-path: https://companyurl/path-to-file.json).

Light My Way will then load all guide data from the export file and the extension will not connect to CLOUD.

2. Self-hosting client (web extension)

To self-host the extension you need to host two files (3 with the JSON data file)

the update file (e.g. update.xml)
the extension package (e.g. lmw-2024.2.crx).

The files needs to be hosted over HTTPS (Reference: https://developer.chrome.com/docs/extensions/how-to/distribute/host-on-linux#update). We recommend hosting these together with the guide data JSON (there is a version dependency).

Extension package

The extension package (.crx) can be downloaded from products.technia.com.

Update file

The update file (.xml) needs to be edited according to how its hosted.

In below example these values needs to be updated:
<updatecheck codebase='path-to-extension.crx' version='version (must match extension version)' />

Example:

<?xml version='1.0' encoding='UTF-8'?>
<gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'>
  <app appid='abgmfmhjplgnlmjoglbgddpdnfdcjenj'>
    <updatecheck codebase='https://<YOUR_HOSTING_URL>/lmw-2024.2.crx' version='2024.2' />
  </app>
</gupdate>

Please refer to this page on more details about the elements of the update file.

Learn more

Web Extension self-hosting is supported technology for Chrome and MS Edge.
Please refer to browser documentation for more information.

Chrome
MS Edge.

3. Distribution

Self hosted extensions can be distributed just like the Chrome Store hosted extension using the registry .

The registry file also needs to be edited with the correct values and path to the update file.

In below example these values would need to be updated:

update_url
runtime_allowed_hosts
hosted-guides-path