Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Light My Way - Documentation

Page Tree
root@parent
startDepth1

Page Content

Table of Contents
maxLevel6
minLevel1
include
outlinefalse
indent
excludeLight My Way - Documentation|Page Content
stylenone
typelist
printabletrue
class
Info

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).

...

Table of Contents
stylenone

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).

...

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

image-20240315-133826.png

2. Self-hosting client (web extension)

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

...

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 build (.zip) can be downloaded from products.technia.com.

Then you will have to build the extension package (.crx) using the browser. (Reference: Create a .crx file)

Update file

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

...

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.

3. Distribution

Self hosted extensions can be distributed just like the Chrome Store hosted extension using the registry https://technia.jira.com/wiki/spaces/TSD/pages/4031971409/Light+My+Way+-+Product+Documentation#Registry-entries-using-file.

...