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>
35 lines
3.2 KiB
Markdown
35 lines
3.2 KiB
Markdown
# Access, sharing and transfer
|
|
|
|
**Access & sharing** is for people whose role lets them manage the aircraft's people, share links or exports (Owners): open it from **More** at the top of the aircraft's pages.
|
|
|
|
## People
|
|
|
|
Add people by email with a role: **Owner**, **Mechanic**, **Pilot**, **Viewer**, or one the administrator added (they need an account; ask the administrator). Change or remove their role at any time; **What each role can do** on the page lists them. See the roles table in [Getting started](getting-started.md).
|
|
|
|
Only an Owner can give or take away the Owner role, nobody can change their own, and an aircraft always keeps at least one Owner. An administrator can also give people roles on any aircraft from **Admin → Users**.
|
|
|
|
## Invitations
|
|
|
|
To add someone who has no account yet, or without knowing their email, use **Invitations** on the same page: choose the role, optionally their email (then only they can use it, and it's emailed to them when email is set up), how many times it works and when it expires, then **Create invitation**. Copy the link shown and send it; it isn't shown again. Whoever opens it creates an account, or signs in, and gets the role on this aircraft. **Revoke** stops a link that hasn't been used. Administrators can also make invitations for several aircraft at once (Admin → Invitations).
|
|
|
|
## Share links
|
|
|
|
**Create Share Link** gives a read-only link that needs no account, for a mechanic, partner, buyer or insurer:
|
|
|
|
- **Current Status**: airworthiness, open squawks, components, inspection and AD status, consumption, notes and shared documents.
|
|
- **Maintenance Detail**: also the logbook, inspection and AD compliance history, major repairs and alterations, resolved squawks and the printable status report.
|
|
|
|
Give it a label and optionally an expiry. Documents only appear if their visibility allows it (see [Documents](documents.md)). Delete a link to revoke it. An aircraft can have up to 10.
|
|
|
|
## Records package
|
|
|
|
**Download records package** builds a zip for the FAA, a buyer or a new maintainer: every logbook entry as a PDF with its signatures, a signature register, the change history, the status report, the current recordkeeping procedures, and the data archive. Its README explains each file, links to the source code, and includes a ready-to-run `viewer/docker-compose.yml`: with Docker Desktop, the recipient can run the app on their own computer and import the archive to browse everything.
|
|
|
|
## Backup and transfer
|
|
|
|
**Download .sam.zip** exports the whole aircraft with its files. Anyone can load it with **Fleet → More → Import from a .sam.zip archive** (in this app or the original Simple Aircraft Manager) to make a copy they own, for example when the aircraft is sold. Use a new tail number if the original is already in that app. If an older download arrived as a folder (Safari can unzip downloads by itself), compress the folder back into a zip (in Finder: right-click → Compress) and import that.
|
|
|
|
## Activity
|
|
|
|
The **Activity** tab lists everything done on the aircraft and by whom, newest first, loading more as you scroll (filter it by category). **Record history** shows every change to the maintenance records field by field (see [Electronic records and signing](records.md)).
|