mirror of
https://github.com/rickbarrette/simple-aircraft-manager-rails.git
synced 2026-11-17 15:50:36 -05:00
Ported from the original (InvitationCode), adapted to configurable roles. - Admin → Invitations: a label, optionally one email address (only it can use the link, and it's emailed) and a name, how many uses (or unlimited), an expiry (or never), and a role on any aircraft (or none, for an account only). - An aircraft's Access page: whoever manages its people invites to that aircraft, with only the roles they can give; they see and revoke its invitations. - /join/<code>: shows what it gives; create an account (when password sign-in is on) or sign in, then accept. Existing accounts and SSO users accept too. A role someone already has on an aircraft stays. - Roles are given as the invitation's creator (AircraftAccess), and only while they can still manage that aircraft's people. Codes are kept as digests and shown once; uses are counted under a lock; account creation and accepting are rate-limited; any invalid link gets the same answer. - Docs: guide (Administration, Access & sharing), README, and why /join isn't on the Authentik bypass list. The README's not-yet-ported list now names Prometheus metrics, and no longer claims oil analysis import as new. 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, share links, the records package, moving an aircraft
Administrators
- Administration: users, settings, 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.