mirror of
https://github.com/rickbarrette/simple-aircraft-manager-rails.git
synced 2026-11-17 15:50:36 -05:00
SAM_VIEWER=true (set only by the records package's viewer/docker-compose.yml) makes the app a read-only copy of an archive, for whoever receives the records: `docker compose up`, then open http://localhost:3000. - At start (bin/docker-entrypoint → sam:viewer:prepare) the package's .sam.zip, mounted read-only, is imported once. - No sign-in: everyone browses as a built-in account. Nothing can be changed: any request but GET/HEAD is refused, no role permission applies (so no edit buttons), and there's no sign-out or profile. A banner names the archive and when it was exported. - It refuses to start, and every page answers 503, when the database has any other account, so turning it on for a real installation stops the app instead of exposing its records. - The viewer listens on 127.0.0.1 only, and skips scheduled jobs (reminders, backups, AD searches). - Docs: the package README (three steps now), Access & sharing, README settings and features, the suggested recordkeeping procedures. Checked end to end with a built image and a real records package: the archive imported at start, pages browsed without an account, a change refused, and the container refusing to start once an account existed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
User guide
Simple Aircraft Manager keeps the records and status of a small fleet: hours, squawks, components, the maintenance logbook, inspections, ADs, documents, oil and fuel, weight and balance. It works out whether each aircraft is airworthy from those records. This guide explains how to use it, for everyone who flies, maintains or administers the aircraft.
The same pages are in the app under Help in the menu.
Disclaimer: the app is provided as is, without warranty, and is not FAA-approved. It is up to you to verify that using it is legal and suitable for your operation. See the Disclaimer.
Everyone
- Getting started: signing in, roles, finding your way around, phones
- Your profile: password, certificates, single sign-on, reminders, AirTrail
- Aircraft and airworthiness: the fleet, an aircraft's overview, what the status means
- Flights and hours: logging flights, updating meters, imports, engine data
- Squawks: reporting, deferring and resolving problems
- Oil, fuel and oil analysis
Owners and mechanics
- Components: parts, limits, TBO, service and replacement
- The logbook: writing entries, templates, scanned logbooks, printing
- Electronic records and signing: how signing, corrections and the record history work
- Inspections
- Airworthiness directives
- Documents
- Major repairs, alterations and weight & balance
- Access, sharing and transfer: people and their roles, share links, the records package, moving an aircraft
Administrators
- Administration: users, roles and what each can do, invitations, settings (including who can add aircraft), templates, backups and off-site backup to Google Drive, recordkeeping procedures and audits
- REST API: tokens, endpoints and webhooks, for scripts and other systems such as Redmine
Legal
- Disclaimer: no warranty; verifying legal use is up to you
Installing and hosting the app is covered in the project's main README.