Docs
MFA Sidecar documentation is organized around the parts people actually need when deploying and operating it.
Start here
- Install Guide — how to bring MFA Sidecar online safely
- Admin Guide — how to manage targets, users, and recovery
- User Guide — what protected-app users should expect
- Troubleshooting — break-glass and recovery paths
- Live-Box Verification — what to validate on a real server
- Testing Notes — what has been tested and why
- Submission / Reviewer Notes — packaging and design rationale
Recommended reading order
If you are installing it
If you are operating it
If you are evaluating the project
Important operator note
Do not use admin as a sidecar username.
On real YunoHost systems it can collide with legacy or system identity expectations and create confusing authentication failures. Use a distinct operator username such as mfaadmin instead.
Project links