diff --git a/README.md b/README.md index 9af4028..f4dee99 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ The app is a standard Rails app. Run `bin/rails db:prepare && bin/thrust bin/rai | `APP_URL` | Optional public base URL, e.g. `https://aircraft.example.com` (default `https://APP_HOST`). Used for the SSO and Google Drive redirect URIs. | | `OIDC_ISSUER`, `OIDC_CLIENT_ID`, `OIDC_CLIENT_SECRET` | Optional. Turn on single sign-on with an OpenID Connect provider (see below). | | `OIDC_PROVIDER_NAME` | Button label, e.g. `Authentik` (default `SSO`). | -| `OIDC_AUTO_CREATE_USERS` | `true` creates an account for anyone the provider lets in, without an invitation. New accounts start with no aircraft. Default off: accounts come only from an admin or an admin's invitation (SSO sign-in from the invitation link makes the account). | +| `OIDC_AUTO_CREATE_USERS` | `true` creates an account for anyone the provider lets in, without an invitation. New accounts start with no aircraft. Default off: accounts come only from an admin, an admin's invitation, or an Owner's signing invitation (signing in with SSO from the link makes the account). | | `OIDC_TRUST_EMAIL` | `true` links existing accounts by email even if the provider doesn't mark it verified. Only use it if users can't edit their own email at the provider. | | `OIDC_ADMIN_GROUP` | Optional. Members of this provider group become admins and others lose admin, synced at each sign-in. | | `PWNED_PASSWORDS_CHECK` | `false` turns off the check of new passwords against Have I Been Pwned (only the first 5 characters of the password's SHA-1 are sent). Use it if the server has no outbound internet access; the check also allows the password if the service can't be reached. | diff --git a/docs/guide/README.md b/docs/guide/README.md index 1a9e34a..e830832 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -24,11 +24,11 @@ The same pages are in the app under **Help** in the menu. - [Airworthiness directives](ads.md) - [Documents](documents.md) - [Major repairs, alterations and weight & balance](major-records.md) -- [Access, sharing and transfer](sharing.md): people, share links, the records package, moving an aircraft +- [Access, sharing and transfer](sharing.md): people and their roles, share links, the records package, moving an aircraft ## Administrators -- [Administration](administration.md): users, settings, templates, backups and off-site backup to Google Drive, recordkeeping procedures and audits +- [Administration](administration.md): 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](api.md): tokens, endpoints and webhooks, for scripts and other systems such as Redmine ## Legal diff --git a/docs/guide/administration.md b/docs/guide/administration.md index f6ccbcd..08f62df 100644 --- a/docs/guide/administration.md +++ b/docs/guide/administration.md @@ -53,7 +53,7 @@ If single sign-on is broken and `PASSWORD_LOGIN=false` is set, remove that setti ## Component Types, Airports, Logbook Templates -- **Component Types**: the list of types used for components (owners can also add new types while adding a component). +- **Component Types**: the list of types used for components (anyone who manages components can also add new types while adding one). - **Airports**: airport data from OurAirports, used for From/To autocomplete and AirTrail. It downloads by itself when the app first starts; **Update from OurAirports** refreshes it. Add private strips here; they're never overwritten. - **Logbook Templates**: the wording offered when writing an entry. Use `__` for blanks. **Restore built-in templates** adds back any deleted built-in ones. diff --git a/docs/guide/ads.md b/docs/guide/ads.md index 8327cbd..eeee269 100644 --- a/docs/guide/ads.md +++ b/docs/guide/ads.md @@ -20,6 +20,6 @@ The app searches the Federal Register weekly for new ADs mentioning the aircraft **Comply** records the date, aircraft hours, the component, the logbook entry, the method (inspection, terminating action, AMOC) and the AD revision complied with, with details of what was done. **N/A** records that an AD doesn't apply, and why (for example, serial number outside the affected range). Recurring ADs then show when they're next due. -Applying an AD to the aircraft or a component, removing it, and changes to it are kept in **Activity → Record history**, with who and when. An owner can **Restore** an AD that was removed by mistake from there. +Applying an AD to the aircraft or a component, removing it, and changes to it are kept in **Activity → Record history**, with who and when. Someone with the **Restore from history** permission (Owners) can **Restore** an AD that was removed by mistake from there. Make the logbook entry for the work as well; the status report lists each AD with its method and revision (91.417(a)(2)(v)). diff --git a/docs/guide/aircraft.md b/docs/guide/aircraft.md index c99cf35..ef0706c 100644 --- a/docs/guide/aircraft.md +++ b/docs/guide/aircraft.md @@ -2,7 +2,7 @@ ## The fleet -**Fleet** shows every aircraft you have access to, with its airworthiness and its most pressing issues. **+ Add Aircraft** creates one (you become its owner). **More → Import from a .sam.zip archive** loads an aircraft from a `.sam.zip` archive (see [Access, sharing and transfer](sharing.md)). +**Fleet** shows every aircraft you have access to, with its airworthiness and its most pressing issues. **+ Add Aircraft** creates one (you become its Owner). **More → Import from a .sam.zip archive** loads an aircraft from a `.sam.zip` archive (see [Access, sharing and transfer](sharing.md)). Both are for administrators unless the administrator lets everyone add aircraft (Admin → Settings); otherwise ask them to add it and give you a role. ## An aircraft's overview @@ -27,7 +27,7 @@ It's only as good as the records entered, and the pilot in command still decides ## Editing the aircraft -**Edit** (owners) on the overview changes: +**Edit** (Owners: the **Edit the aircraft** permission) on the overview changes: - Tail number, make, model, serial number, status (Available, In Maintenance, Grounded, Unavailable), ICAO type (used for AirTrail), description and picture. - **Current tach / hobbs**, and **offsets** subtracted for maintenance math after a meter is replaced. diff --git a/docs/guide/components.md b/docs/guide/components.md index eceaa39..6dca3f1 100644 --- a/docs/guide/components.md +++ b/docs/guide/components.md @@ -1,6 +1,6 @@ # Components -The **Components** tab is a tree of the aircraft's parts: engine, propeller, magnetos, filters, ELT battery and so on, each with its own time and limits. Owners manage it. +The **Components** tab is a tree of the aircraft's parts: engine, propeller, magnetos, filters, ELT battery and so on, each with its own time and limits. Owners and Mechanics manage it (the **Manage components** permission); everyone on the aircraft can see it. ## Adding a component diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index f90d206..b22b741 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -36,7 +36,7 @@ Administrators can do everything on every aircraft, and manage users, roles, set - **Fleet** (top left) lists your aircraft with their airworthiness. - Each aircraft has tabs: **Overview, Components, Squawks, Flights, Oil & Fuel, Logbook, Inspections, ADs, Documents, Major Records, W&B, Notes, Activity**. -- **Log Flight** and **Report Squawk** are at the top of every aircraft page. Next to them, **More** has the status report and, for owners, **Access & sharing**, editing the aircraft, and its downloads. +- **Log Flight** and **Report Squawk** are at the top of every aircraft page (when your role allows them). Next to them, **More** has the status report and, depending on your role, **Access & sharing**, editing the aircraft, and its downloads. Buttons for things your role doesn't allow aren't shown. - Each section shows its main action as a button (such as **+ New Entry**). Less frequent ones, such as imports, exports and printing, are under that section's **More** button. - **Search** (the box in the top bar, or ☰ → Search on a phone) looks through the logbook, squawks, notes, ADs, documents (including the text of their pages), components, flights and major records of your aircraft at once. - Your name (or ☰ on a phone) leads to your **Profile**, this **Help**, and for admins the **Admin** pages. diff --git a/docs/guide/logbook.md b/docs/guide/logbook.md index 48beaf2..221993d 100644 --- a/docs/guide/logbook.md +++ b/docs/guide/logbook.md @@ -1,6 +1,6 @@ # The logbook -The **Logbook** tab holds the maintenance record entries. Owners write and edit them; anyone with a certificate can sign them (see [Electronic records and signing](records.md)). +The **Logbook** tab holds the maintenance record entries. Owners and Mechanics write and edit them; anyone whose role can sign entries (Owners, Mechanics and Pilots, as roles come) and who has a certificate can sign them (see [Electronic records and signing](records.md)). ## Writing an entry diff --git a/docs/guide/profile.md b/docs/guide/profile.md index 8eced17..60d36d7 100644 --- a/docs/guide/profile.md +++ b/docs/guide/profile.md @@ -6,7 +6,7 @@ Open your name in the top bar (☰ → **Profile** on a phone). Change your name, email and password. Leave the password blank to keep the current one. A password needs at least 12 characters, and one that has appeared in a known data breach is refused (checked with Have I Been Pwned, which never receives the password itself). -**Weekly maintenance reminders**: on Mondays the app emails owners about anything overdue or coming due on their aircraft, and certificates about to expire. Untick it to stop them. (Emails need the administrator to have set up email.) +**Weekly maintenance reminders**: on Mondays the app emails those whose role gets reminders (Owners and Mechanics, as roles come) about anything overdue or coming due on their aircraft, and certificates about to expire. Untick it to stop them. (Emails need the administrator to have set up email.) **Time zone** is *Automatic* by default: times show in your device's zone, and "today" (for example a new flight's date) is your local date. Choose a zone to use it on every device. Signatures and the record history always show UTC. diff --git a/docs/guide/records.md b/docs/guide/records.md index b0ead5d..23cece9 100644 --- a/docs/guide/records.md +++ b/docs/guide/records.md @@ -4,7 +4,7 @@ These are the instructions for everyone who keeps or signs maintenance records h ## Writing an entry -On the aircraft's **Logbook** tab, choose **+ New Entry** (owners). Give the date, the logbook (aircraft, engine, propeller), the airframe total time and what was done. For an engine or propeller entry, pick the component (its times fill in) and tick any sub-components. A template can start the wording. An entry isn't a signed record until it's signed. See [The logbook](logbook.md). +On the aircraft's **Logbook** tab, choose **+ New Entry** (Owners and Mechanics: the **Write logbook entries** permission). Give the date, the logbook (aircraft, engine, propeller), the airframe total time and what was done. For an engine or propeller entry, pick the component (its times fill in) and tick any sub-components. A template can start the wording. An entry isn't a signed record until it's signed. See [The logbook](logbook.md). ## Signing @@ -17,11 +17,11 @@ Never share your password or let someone else sign while you're signed in: a sig ## Mistakes -A signed entry can't be edited or deleted. Open it and choose **More → Correct this entry** (owners): a new entry starts from the original. Fix it, save it and sign it. The original stays, marked “Superseded by a correction”, with a link to the correction. +A signed entry can't be edited or deleted. Open it and choose **More → Correct this entry** (Owners and Mechanics): a new entry starts from the original. Fix it, save it and sign it. The original stays, marked “Superseded by a correction”, with a link to the correction. ## Someone else did the work -The owner can choose **More → Ask someone to sign** on the entry. The mechanic gets a one-time email link (valid for 14 days), signs in with their own account (or creates one for that address, when an Owner sent the invitation), adds their certificate and signs. +Owners and Mechanics can choose **More → Ask someone to sign** on the entry. The mechanic gets a one-time email link (valid for 14 days), signs in with their own account (or creates one for that address, when an Owner sent the invitation), adds their certificate and signs. If they prefer paper, print the entry (**Print for logbook**), have it signed in ink, and keep the paper with the logbooks (scan it into Documents). diff --git a/docs/guide/squawks.md b/docs/guide/squawks.md index e3d95c3..36d795b 100644 --- a/docs/guide/squawks.md +++ b/docs/guide/squawks.md @@ -23,4 +23,4 @@ For inoperative equipment that isn't required, **Defer** records the decision. Y ## Resolve a squawk -Owners choose **Resolve**. You can record the fix as a logbook entry at the same time: the date, logbook, airframe total time, work performed and who signed it off. A resolved squawk can be **Reopen**ed. +Owners and Mechanics (the **Manage squawks** permission) choose **Resolve**. You can record the fix as a logbook entry at the same time: the date, logbook, airframe total time, work performed and who signed it off. A resolved squawk can be **Reopen**ed.