LUX Master Documentation

Master Documentation Page

This page contains the most recent documentation for the Master Branch of LUX. It will often contain documentation pertaining to features and plugins not available in the most recent release of LUX. For the most recent release documentation page, please visit the LUX 2.8 Documentation Page.

Installation Guide

Instructions for installing the LUX UI, Engine, Databases, and all prerequisite software.

Engine and Plugins Configuration Guide

Configuration options for the Engine and all standard Plugins.

LUX Operations Manual

System Administrator’s Guide for stopping, starting, and performing other common tasks for all LUX components.

Adding a Data Source and Rule Form

Guide to adding a new data source to LUX, both Engine and UI.

LUX Upgrade Guide

Instructions for upgrading both the LUX UI & Engine components to LUX v2.8 from v2.7.

Engine Administration Console Guide

Instructions for using the EAC to monitor the health and status of LUX, as well as how to make real-time changes to the Engine.

PDK Guide

Instructions for using the Plugin Development Kit to develop new LUX Plugins.

Event Query Syntax Guide

Guide for writing LUX Event Queries used in Rule Forms and plugin configuration.

Rule Form Creation Guide

Instructions for creating custom Rule Forms for data sources in the LUX UI.


Interface Control Document for LUX REST services.

LUX Integration Options

Software architecture diagrams displaying several patterns for LUX integration.

LUX Entity Manager Setup Guide

Reference Material for Entity Manager Configurations.

Entity Features & Configuration Guide

Reference material describing features & configuration of LUX Entity Layers.

Prior LUX Versions