Getting started
Sign in, learn the screen layout and navigation map, and run your first scan.
Sign in
Open your IntelliXBOM instance and sign in. You are redirected to a separate sign-in service, then land on the Dashboard. Sign-in runs on Keycloak, so an organisation can add SSO providers alongside username and password.
Screen layout
- Left sidebar: all navigation, grouped into Main, Security and Management. Inventory and Vulnerabilities expand into sub-pages.
- Header bar: page title and one-line description on the left; your avatar, name and email on the right.
- Settings: pinned to the bottom of the sidebar. It opens a panel with account and admin pages, plus Sign Out.
Main
- Dashboard
- Assets
- Inventory
- By Assets / By Components
Security
- License
- Vulnerabilities
- Scanned Assets
- Uploaded BOM / Binary / CI
Management
- BOM Manager
- BOM Inspector
- BOM Comparison
- Notifications
All navigation lives in the left sidebar; Inventory and Vulnerabilities expand into sub-pages.
Personalise the display from Settings › Font & Size: it sets the font (Figtree, System UI, Mono, Georgia) and text size (Small, Medium, Large) for the whole application.
Navigation map
The full map of pages and what each is for:
| Group | Page | Sub-pages | What it is for |
|---|---|---|---|
| Main | Dashboard | n/a | Organisation-wide posture across all four BOM types |
| Main | Assets | Asset detail (Overview, Scans, Hardware, Cryptography, BOM Library, Settings) | Register machines and run scans |
| Main | Inventory | By Assets, By Components | Browse BOM contents, drill from asset to component |
| Security | License | n/a | Open-source and commercial licence compliance |
| Security | Vulnerabilities | Scanned Assets, Uploaded BOM/Binary/CI | CVE findings by source |
| Management | BOM Manager | n/a | Upload and manage BOM files, binaries and repositories |
| Management | BOM Inspector | n/a | Inspect and score a single BOM file |
| Management | BOM Comparison | n/a | Compare two BOMs side by side |
| Management | Notifications | n/a | Alerts and activity |
| Settings | User Profile, Roles, Privileges, Identity Provider, Logo, CI Tokens, Font & Size | n/a | Account, access control and branding |
Your first scan
The fastest way to see value is to onboard one machine and scan it:
The asset onboarding and first-scan path, end to end.
- Go to Assets and click Add Asset.
- Pick the organisation, then enter the machine name, IP address and operating system.
- Add SSH credentials: a username plus a password or a PEM key file. Change the SSH port if it is not 22.
- Choose the scan scope. Use Specific directories to limit the scan, or scan the whole machine.
- Tick the BOM types to generate. QBOM needs CBOM, which is ticked automatically.
- Click Add machine, open it, click Check connection and confirm it reads Reachable.
- Click Run security scan and follow progress on the Scans tab.
- When the run completes, check Overview › BOM coverage and the BOM Library tab.