Documentation
How to run AegisOne, written by the people who built it
41 articles across 15 sections, covering enrolment through to the API. Every article documents behaviour that exists in the shipped product — where something is not built, the documentation says so rather than staying quiet about it.
Contents
Browse by section
If you are new, read “What AegisOne is” first — it sets the vocabulary the rest of the documentation assumes.
Getting started
Orientation, core concepts and the shortest path from signup to a managed endpoint.
What AegisOne is (and what it is not)
The platform model, the vocabulary used throughout the console, and an honest boundary around what is not built yet.
ReadQuickstart: first endpoint in about ten minutes
The shortest useful path — create a client and site, generate an install token, enrol one machine, confirm it is reporting.
ReadFinding your way around the console
How the console is organised, which view answers which question, and how global search short-circuits all of it.
Read
Account setup
Operators, roles, multi-factor authentication and the client/site/department model.
Adding operators and managing access
Invite-based onboarding for technicians and administrators, and how to think about least privilege.
ReadEnabling multi-factor authentication
Setting up TOTP for an operator account, verifying enrolment, and what to do when a device is lost.
ReadStructuring clients, sites and departments
How to model your estate so that reporting, chargeback and reconciliation work without rework later.
Read
Agent deployment
Installing the agent on Windows, Linux and macOS, at one desk or across a fleet.
How the agent works
Architecture, connectivity model, supported platforms and network requirements before you deploy anything.
ReadInstalling on Windows
Scripted install, silent deployment across a fleet, and verifying the result.
ReadInstalling on Linux
Root install, service registration, and deploying across many hosts at once.
ReadInstalling on macOS
The signed installer package, the scripted alternative, architecture selection and required system permissions.
ReadInstall tokens: lifetime, scope and hygiene
How enrolment tokens work and how to handle them without creating a standing risk.
ReadRemoving the agent cleanly
Decommissioning an endpoint without leaving orphaned records or an orphaned service.
Read
Device management
Working with enrolled endpoints, grouping, ownership and lifecycle.
Working with enrolled endpoints
The endpoint view, what each panel tells you, and the order to read them in.
ReadAssigning endpoints to clients, sites and owners
Moving endpoints through your structure, and doing it in bulk without creating a mess.
ReadUnderstanding offline state
What offline actually means, how the threshold works, and how to triage a list of offline machines.
Read
Monitoring
Health history, connectivity, offline detection and network discovery.
Patch management
Scanning, installing, uninstalling and evidencing patch position.
Scanning and installing patches
Driving patch operations from the console, and doing it in an order that fails safely.
ReadRemoving a patch that caused a problem
Uninstalling a patch, deciding whether you should, and containing the blast radius.
ReadProducing patch evidence for an audit
Turning retained patch inventory into something an auditor accepts.
Read
Remote access
Remote terminal sessions, screen access and the authorisation model behind them.
Automation
Remediation rules — what they can do, and where their boundaries are.
Asset management
Hardware and software inventory, warranty, timelines, contracts and licences.
Hardware and software inventory
What the agent collects, how current it is, and the questions it lets you answer.
ReadReading the asset timeline
Reconstructing what happened to a machine without excavating it from ticket history.
ReadContracts, licences and consumables
Keeping commercial entitlement alongside the technical estate, and why they belong together.
ReadRunning contract reconciliation
Comparing the estate you manage against the contracts you signed, and acting on the gap.
Read
Reporting
The report catalogue, saved reports, exports and AI-assisted narrative.
Generating and saving reports
The report catalogue, saved reports, and choosing the right report for the audience.
ReadExporting to PDF, Excel and PowerPoint
Which format serves which purpose, and how to avoid rebuilding a deck by hand.
ReadAI-assisted analysis and narrative
What the AI features generate, what they are grounded in, and the review obligation that comes with them.
Read
Integrations
Connecting AegisOne to the systems either side of it.
API
Authentication, conventions, pagination, errors and worked examples.
API authentication and conventions
Authenticating requests, base paths, content types and the shape of a response.
ReadCommon API tasks
Worked examples: listing endpoints, dispatching a scan, reading findings, exporting.
ReadErrors, retries and writing a durable integration
Interpreting failures and building automation that survives a bad afternoon.
Read
Security
Authentication hardening, the credential vault, audit logging and data handling.
The platform security model
Authentication, the connectivity posture, audit logging and where responsibility sits.
ReadUsing the credential vault
Storing shared client credentials with controlled, recorded access.
ReadCompliance scoring and evidence collection
Scoring endpoints against control frameworks, recording findings, and exporting evidence packages.
Read
Troubleshooting
Diagnosing enrolment failures, offline agents and session problems.
The agent will not enrol
Diagnosing a failed enrolment in the right order, from token to network to service.
ReadAn endpoint keeps showing offline
Separating genuine disconnection from flapping, proxy timeouts and stale records.
ReadA remote session will not open
Working through terminal and screen session failures, including the macOS permission trap.
Read
Release notes
What changed, and what the change means for you.
Documentation is written against the capability registry that drives this site. A feature that has not shipped is never documented as though it has — see the public roadmap for what is still in development.