# Open ADMS

> Open ADMS is offline-capable, open-source debris management and field reconciliation for disaster recovery: two monitors record each load at the curb and at the dump, the server joins them on the ticket number, flags what disagrees, and keeps an audited ledger.

Each link below is a page of the Open ADMS documentation as Markdown. Every page of the site has
such a twin at its own address with `.md` in place of the trailing slash. The whole
documentation in one file: [llms-full.txt](/docs/llms-full.txt). The API's
OpenAPI document: [openapi.json](/docs/openapi.json). Source code:
https://github.com/MrRyanAlexander/openadms (Apache-2.0).

## Start here

- [Open ADMS documentation](/docs/index.md): Open-source debris management and field reconciliation for disaster recovery. Set it up, run a mission, and understand every rule it applies.

## Get started

- [What is Open ADMS?](/docs/get-started/what-is-open-adms.md): The problem Open ADMS solves, the one sentence it serves, who uses it, what it guarantees and what it deliberately is not.
- [Quick start](/docs/get-started/quick-start.md): Bring a whole Open ADMS installation up on one machine with one command, over HTTPS, with the two sample projects loaded, and sign in.
- [Install an installation](/docs/get-started/install.md): What the installer asks and sets up, how a rerun resumes safely, how secrets are kept, and what a firm's own cloud needs.

## Concepts

- [Two field events, one ticket](/docs/concepts/two-field-events.md): Why every truckload is recorded twice, by two monitors who cannot see each other, joined only on the server by the bare ticket number, and what the system concludes from the pair.
- [The load call](/docs/concepts/load-call.md): The percentage a tower monitor calls is the number the money hangs on. How billable volume is worked out, which calls are flagged, when a scale weight is taken instead, and the loads that have no call at all.
- [Statuses and QC status](/docs/concepts/statuses.md): The four statuses the worker sets on every ticket, which of them bill, what reprocessing does, and the QC status people set separately.
- [Flags, never blocks](/docs/concepts/flags.md): After setup nothing refuses field work. Every problem becomes a flag with a plain message, the ticket goes to one review queue, and a person fixes it or accepts it with a reason.
- [The ledger and the audit trail](/docs/concepts/ledger-and-audit.md): Pay items hold every rate, rules turn tickets into transactions, the ledger is regenerated rather than reversed, and the audit log keeps every prior value for ever.
- [Certifications](/docs/concepts/certifications.md): A certification certifies a container or a crew, never a vehicle. How capacity is measured exactly, why the cert number is the placard and badge number, and how a certification lives and changes.
- [Assignments and phones](/docs/concepts/assignments-and-phones.md): A phone is enrolled once; each day's work comes from the monitor's assignment on the dispatch board; the master passcode is the supervisor's fallback; offline sign-in is protected by the phone itself.
- [Offline and sync](/docs/concepts/offline-and-sync.md): Phones work all day without a connection and sync whenever there is signal, in any order. How a sync proves who sent it, never stores a record twice, and quarantines a duplicate number instead of dropping it.

## Guides: Back office

- [Set up a project](/docs/guides/back-office/set-up-a-project.md): From the client down to the setup check, in the order a mission needs it - client, declaration event, project, contractors and contracts, forms and debris types, pay items, rules, sites, the project map, certifications and ROEs.
- [Dispatch](/docs/guides/back-office/dispatch.md): People and their permissions, phones, the dispatch board that gives each person the day's assignment, and the time clock's approval.
- [Review and correct](/docs/guides/back-office/review-and-correct.md): The one review queue, a ticket's page, and the tools - correct, renumber, void, accept - with when each is right, plus quarantined records, held records and records made in the back office.
- [QC, the lock and the client package](/docs/guides/back-office/qc-lock-and-deliver.md): QC marks set by people, locking QC Approved tickets as invoiced in named batches, the ledger and the audit trail, reports and exports, assembling the client package by hand, and closing the project.

## Guides

- [Field monitors](/docs/guides/field-monitors.md): Signing in on an enrolled phone, starting every ticket with the badge and the number at New, completing a load, a haul-out and unit rate work, forms, and syncing.
- [Viewers](/docs/guides/viewers.md): What a client user, a contractor user or an auditor sees in the read-only viewer portal, how they sign in, and what is kept from them.

## Reference

- [Architecture](/docs/reference/architecture.md): The system layer by layer, who may write which kind of record, the stack, the repository's workspaces and how they depend on each other, and how it is tested.
- [Data model](/docs/reference/data-model.md): The records Open ADMS keeps and how they link - firm-wide records, a project's setup, the evidence monitors capture, the worker's conclusions, people's marks and the audit log - and what the database refuses by itself.
- [Flags reference](/docs/reference/flags.md): Every flag Open ADMS can raise - its code, what raises it, the message a reviewer reads and what it does to the money - grouped as the engine checks them.
- [Lists](/docs/reference/lists.md): Every pick-list in Open ADMS - which ones the firm extends after install and what each starts with, which are fixed because each value is behaviour, and how built-in values sit beside the firm's own.
- [Configuration](/docs/reference/configuration.md): Where each setting lives - the release's policy defaults by name, the firm's settings, and each project's settings - and the rule that a threshold is policy, never a number in code.
- [Commands](/docs/reference/commands.md): Every command run from the repository's root - bringing an installation up, the installer, the local stack, the sample projects, the checks and the documentation site.
- [API reference](/docs/reference/api.md): Every endpoint of the Open ADMS API, grouped by path, with what each one does: generated at build time from the API’s own OpenAPI document.
- [Glossary](/docs/reference/glossary.md): Every term Open ADMS uses, in its exact meaning - from active window to zone.

## Project

- [Security](/docs/security.md): How Open ADMS protects evidence that public money is paid on - the standards it is checked against, sign-in and sessions, phones, the database that enforces its own rules - and how to report a vulnerability.
- [Contributing](/docs/contributing.md): How to contribute to Open ADMS - field knowledge as much as code - the development setup, the workspace's rules, how changes are proven, and where the spec lives.
- [Licence](/docs/licence.md): Open ADMS is open source under the Apache License 2.0, and what that means for a firm that installs it, changes it or builds on it.