Files
simple-aircraft-manager-rails/docs/guide/getting-started.md
T
rickyandClaude Opus 5.5 14316bb60f Sign-in hardening: lockout, stronger passwords, authenticator codes
- 10 failed sign-ins in a row (password, authenticator code, or password
  at signing) lock an account for 15 minutes from any address; the user
  is emailed; admins can unlock. Same message as a wrong password.
- Passwords: at least 12 characters (max 72), refused if found in Have I
  Been Pwned (k-anonymity range API; fails open; PWNED_PASSWORDS_CHECK=false)
- Optional TOTP (authenticator app) with 10 recovery codes for password
  and emailed-link sign-in, and at signing (auth method password_totp);
  codes accepted once; admins can reset; SSO sign-in unaffected
- Demo/test passwords updated; guide, README and procedures document

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 15:17:56 -05:00

46 lines
2.4 KiB
Markdown

# Getting started
## Signing in
Depending on how the app is set up, you can sign in with:
- **Email and password.** Your administrator creates your account. Use **Forgot password?** to reset it if email is set up; otherwise ask the administrator.
- **Email me a sign-in link.** Enter your email and use the link sent to you. It works once, for a short time.
- **Single sign-on** (for example *Sign in with Authentik*), if your organization uses it.
If you've set up an authenticator app (see [Your profile](profile.md#two-factor-sign-in)), signing in with a password or an emailed link then asks for its 6-digit code.
After 10 failed tries in a row (wrong passwords or codes), an account is locked for 15 minutes and its owner is emailed. Wait, or ask the administrator to unlock it.
The very first visit to a new installation asks for the administrator account instead.
## Roles
What you can do depends on your role on each aircraft:
| | Pilot | Owner | Admin |
|---|:-:|:-:|:-:|
| See everything on the aircraft | ✓ | ✓ | ✓ |
| Log flights, update hours, report squawks, add notes, oil and fuel | ✓ | ✓ | ✓ |
| Defer a squawk as inoperative | ✓ | ✓ | ✓ |
| Sign logbook entries (with your own certificate) | ✓ | ✓ | ✓ |
| Edit squawks and notes, resolve squawks | | ✓ | ✓ |
| Components, logbook, inspections, ADs, documents, major records, W&B | | ✓ | ✓ |
| Edit the aircraft, manage people and share links | | ✓ | ✓ |
| Users, settings, procedures and audits for the whole app | | | ✓ |
Anyone can add an aircraft and becomes its owner. You only see aircraft you have a role on; admins see all of them.
## Finding your way around
- **Fleet** (top left) lists your aircraft with their airworthiness.
- Each aircraft has tabs: **Overview, Components, Squawks, Flights, Oil & Fuel, Oil Analysis, Logbook, Inspections, ADs, Documents, Major Records, W&B, Notes, Activity**, and for owners **Access & Sharing**.
- **Log Flight** and **Report Squawk** are at the top of every aircraft page.
- Your name (or ☰ on a phone) leads to your **Profile**, this **Help**, and for admins the **Admin** pages.
## On a phone
The app works on phones. The tabs collapse into a **Section** menu, and wide tables scroll sideways. You can install it like an app: in Safari use **Share → Add to Home Screen**, in Chrome **Install app**.
The sun/moon button switches between light and dark themes.