Documentation
Everything you need to run Veil — installation, connectors, rules, and more. Available with a Community account.
Getting access
-
1
Request access — tell us a bit about yourself on the Request access page. Community accounts are provisioned by our team, not self-service.
-
2
We set up your account — usually within a business day — and send you sign-in details by email.
-
3
Sign in to read every guide below in full, not just the summaries shown here.
Getting Started
Installation
Installer Kit — Overview
What's in Veil's on-premise installer kit and which guide to read first, depending on your comfort with a terminal.
Installing Veil On Your Own Server
The fast, non-technical path to a self-hosted Veil install — your building data stays on your own server.
Setting Up Veil — A Complete Beginner's Guide
Every click and command needed to get Veil running on your own computer, for someone who's never used a terminal before. Windows, Mac, and Linux.
Veil — On-Premise Install Guide
The full technical reference for installing, licensing, updating, and backing up a self-hosted Veil deployment.
Updating Veil To a New Version
Already have Veil running on-premise? Here's how to move to a new version — your data is never touched.
Mac / Linux Terminal Command Reference
Every Terminal command you might actually need to run Veil on Mac or Linux, what it does, and when to run it.
Windows PowerShell Command Reference
Every PowerShell command you might actually need to run Veil on Windows, what it does, and when to run it.
Connectors
Setting Up a BACnet Connector in Veil — A Plain-English Guide
Connect Veil to a real BACnet/IP device step by step, including a no-hardware test path and what every field on the connection form means.
BACnet Agent Kit — Overview
What's in the BACnet agent kit, and the fastest way to run it if you'd rather use docker-compose than the one-command install.
User Guide
Veil User Guide — Overview & Getting Started
A plain-English guide to using Veil — what it is, every role's permissions, creating an account, and the core concepts (site, point, tag, rule, alert).
Veil User Guide — Role Workflows
Complete, step-by-step walkthroughs for each Veil role: Consultant (full setup to live rules), Technician, Manager, and Admin.
Veil User Guide — Feature Reference
Every Veil screen, section by section: Spark alerts, Rules Studio, Explorer, Analysis, KPI dashboard, Connectors, Reports, Tag Workbench, project export/import, Settings, the demo dataset, the Function Library, and Energy baselines & savings.
Veil User Guide — Appendices & Reference
Alert status reference, writing rules by hand, the rule condition reference, the Haystack tag primer, and a full glossary of Veil terms.
Rules
Veil Rule Guide — Writing Rules, Reading KPIs & Measuring Savings
A deep dive for consultants: how the rule engine actually evaluates conditions, every operator and function that works today, how to read the KPI dashboard, the rule templates and Rule Store, and Energy baseline rules for measuring savings.
Veil Rules Guide — Turning Building Knowledge Into Automated Intelligence
A narrative, consultant-training-oriented introduction to writing Veil rules — what a rule is, its five parts, a full worked example, and how to build a rules library.
Veil Function & Operator Reference — Plain English Guide
Every building block you can use in a rule condition or KPI calculation — comparison operators, AND/OR/NOT, schedules, the four time watchers, all 21 functions, and the five KPI calculations — each explained in plain English with a one-line rule example.