Documentation
Learn how to install, configure, and use ShieldAuth for two-factor authentication.
Installation
Download ShieldAuth from the official website or GitHub releases page. The app is distributed as a universal binary supporting both Apple Silicon and Intel Macs.
- Download the .dmg file from the Downloads section
- Open the .dmg and drag ShieldAuth to your Applications folder
- Launch ShieldAuth from Applications or Spotlight
- Grant necessary permissions when prompted
Adding accounts
ShieldAuth supports multiple methods for adding two-factor authentication accounts:
- QR Code scanning: Click the + button and scan the QR code displayed by the service
- Manual entry: Enter the secret key manually if QR scanning is not available
- Import: Import accounts from other authenticator apps using standard export formats
Security settings
ShieldAuth uses macOS Keychain to encrypt your authentication secrets. You can configure additional security options:
- Touch ID: Enable biometric authentication to unlock ShieldAuth
- Auto-lock: Configure automatic locking after a period of inactivity
- Clipboard timeout: Automatically clear copied codes from clipboard
Keyboard shortcuts
ShieldAuth supports the following keyboard shortcuts for quick access:
⌘ + K
Quick search
⌘ + C
Copy current code
⌘ + N
Add new account
⌘ + ,
Open preferences
Backup and restore
ShieldAuth stores all data locally in the macOS Keychain. To backup your accounts:
- Use Time Machine to backup your Mac (Keychain data is included)
- Export accounts to an encrypted file for manual backup
- Keep backup codes provided by services in a secure location
Troubleshooting
Common issues and solutions:
- Codes not working: Ensure your Mac's time is synchronized. Go to System Preferences → Date & Time → Set date and time automatically
- Touch ID not available: Verify Touch ID is enabled in System Preferences and ShieldAuth has permission to use it
- Import failed: Check that the import file format is supported (JSON, encrypted backup)