3.9 KiB
3.9 KiB
Documentation Index
This directory contains all documentation for the Farm Auth Service, organized by category.
📚 Documentation Structure
🚀 Getting Started
Essential guides for setting up and running the service:
- QUICK_START.md - Quick start guide
- SETUP.md - Detailed setup instructions
- DOCKER_SETUP.md - Docker deployment guide
👨💼 Admin Dashboard
Documentation for the admin security dashboard:
- ADMIN_DASHBOARD_QUICK_START.md - Quick start for admin dashboard
- ADMIN_DASHBOARD_SETUP.md - Admin dashboard setup guide
- ADMIN_DASHBOARD_SECURITY.md - Security considerations for admin dashboard
🔒 Security
Security documentation, audits, and hardening guides:
- SECURITY_AUDIT_REPORT.md - Security audit findings
- SECURITY_HARDENING_SUMMARY.md - Summary of security hardening measures
- SECURITY_SCENARIOS.md - Security threat scenarios
- REMAINING_SECURITY_GAPS.md - Known security gaps and recommendations
- CORS_XSS_IMPLEMENTATION.md - CORS and XSS protection implementation
- CSRF_NOTES.md - CSRF protection notes
- XSS_PREVENTION_GUIDE.md - XSS prevention guide
- TIMING_ATTACK_PROTECTION.md - Timing attack protection
- DATABASE_ENCRYPTION_SETUP.md - Database encryption setup
🛠️ Implementation
Detailed implementation guides for specific features:
- RATE_LIMITING_IMPLEMENTATION.md - Rate limiting implementation details
- LOGOUT_ALL_DEVICES_IMPLEMENTATION.md - Global logout implementation
- DEVICE_MANAGEMENT.md - Device management system
- CHANGELOG_DEVICE_MANAGEMENT.md - Device management changelog
🔌 Integration
Integration guides for external services and client applications:
- API_INTEGRATION.md - API integration guide
- KOTLIN_INTEGRATION_GUIDE.md - Kotlin client integration
- TWILIO_SETUP.md - Twilio SMS service setup
🗄️ Database
Database documentation and analysis:
- DATABASE_OVERVIEW.md - Database schema overview
- OTP_TABLE_ANALYSIS.md - OTP table structure analysis
🏗️ Architecture
System architecture and design documentation:
- ARCHITECTURE.md - System architecture overview
📝 Others
Miscellaneous documentation:
- GEMINI_PROMPT_AUTH_IMPLEMENTATION.md - Gemini AI prompt for auth implementation
- GEMINI_PROMPT_CONCISE.md - Concise Gemini AI prompt
Quick Links
- Main README: ../README.md - Project overview and main documentation
- Database Migrations: ../db/migrations/ - Database migration scripts
Contributing
When adding new documentation:
- Place files in the appropriate category folder
- If unsure, place in
others/folder - Update this index file with a link to the new documentation