BooleX.ai DOCS Book a demo
Documentation

Get started

Set up

Get answers

Quick reference

Manual

IT documentation

Guides

Reference

Docs / IT documentation

Installation

From an unboxed edge PC to a first cited answer: hardware, the release package and the install steps.

The full step-by-step is First cited answer in a day. This page lists what the edge PC needs and how the software is installed.

The edge PC

ItemValue
CPU8 cores, x86-64
Memory32 GB, excluding the language model
Storage1 TB SSD
GPUSized per site for the local language model; not needed in the hybrid and client-cloud profiles
Operating systemA current Linux with Docker Engine and Compose
NetworkIts own segment in a diagnostics zone: see Network and security
Published port8080/TCP (map to 443 at the host or a reverse proxy); nothing else
RetentionProcess data and alarms at least 90 days, 365 by default (BOOLE_RETAIN_DAYS)

Before the install

  • The site's IT/OT team has signed the deployment guide: zones, conduits, firewall rules, read-only accounts, certificates and time source. The rules are in Network and security; the read-only accounts in Data sources and connectors.
  • The release package is on removable media, with 4M's release public key at /config/release-key.pub.

Install from the signed package

shell
python -m settings.release install /media/usb/boolex-<version>   # verifies the signature offline, then installs
python -m settings.release status

The package is refused untouched if its signature or any file hash does not match. Site data lives in the database and data volumes, which an install does not touch. See Updates and decommissioning.

Configure and start

  1. Write the site's site.yaml in the site folder, deploy/config/site/ (/config/site in the containers; another path with BOOLE_SITE_DIR), and put the tag, alarm and interlock lists (tags.csv, alarms.csv, interlocks.csv), the code exports and the documents manifest beside it. Set customer_site: true. See Site configuration.
  2. Select the profile: echo production > deploy/config/profile.
  3. Put the Web UI certificate from the site CA in deploy/config/tls/ (cert.pem, key.pem). Until then a self-signed one is made.
  4. Point BOOLE_TIME_SOURCE at the site's time server.
  5. Start the stack: make up PROFILES= (add ollama for the local model server, watch, cmms or fmi as needed). Check with make ps and make logs.

Then add accounts, import the code and documents, and connect live data: First cited answer in a day.

Note. Behind a TLS-inspecting proxy, build the images with BOOLE_BUILD_CA=<path to the CA bundle inside deploy/>.