Official documentation for LDAP Selfservice Password Changer.
Complete JSON-RPC API specification including:
- Request/response formats
- Available methods
- Validation rules
- Error handling
- Security considerations
Setup instructions and development workflows:
- Prerequisites and initial setup
- Development mode (hot reload)
- Production build
- Configuration reference
- Common development tasks
- Docker development
- Troubleshooting
Testing strategies and recommendations:
- Current test coverage
- Unit testing (Go and TypeScript)
- Integration testing
- E2E testing with Playwright
- Feature-specific testing (density toggle)
- Test organization
- Coverage analysis
Progressive 5-day learning path for new developers:
- Day-by-day onboarding checklist
- Prerequisites and setup verification
- Code structure exploration
- First contribution guidance
- Knowledge checkpoints
- Role-specific learning paths
Documentation update workflows and maintenance procedures:
- When to update documentation
- Documentation update workflows
- Automated regeneration process
- Quality checklists
- File-specific maintenance guidance
- Maintenance schedules
WCAG 2.2 AAA compliance and testing:
- Accessibility features overview
- WCAG 2.2 compliance matrix
- Adaptive dark mode and density
- Screen reader testing procedures
- System preference testing
- Keyboard navigation verification
System architecture overview with diagrams.
Detailed package-level documentation:
- Internal package overview
- Public API surfaces
- Test coverage by package
- Security features
- Code examples and patterns
- Extension guides
Production deployment and operations:
- Quick start (Docker, Kubernetes, bare metal)
- Environment variable reference
- LDAP and SMTP configuration
- Reverse proxy setup (nginx, Traefik, Apache)
- Security hardening
- Monitoring and logging
- Troubleshooting
Security architecture and threat model:
- Threat model and attack scenarios
- Security controls and mitigations
- OWASP Top 10 compliance
- Cryptography and secrets management
- Container security
- Security testing procedures
- Compliance considerations (GDPR, HIPAA, SOC 2)
Design decisions and their rationale:
- ADR-0001: Standardize Form Field Names - Password manager compatibility
- ADR-0002: Password Reset Functionality - Email-based password recovery
- ADR-0003: Configurable Reset Email Templates - Operator-configurable bodies, subject and headers
- New to the project? Follow the Onboarding Guide 5-day learning path
- Quick setup? See Development Guide: Initial Setup
- Understanding the code? Check Code Structure Reference
- Need API details? Review API Reference
- Writing tests? See Testing Guide
- Deploying to production? Start with Deployment Guide
- Security hardening? See Security Documentation
- System architecture? Check Architecture
- Accessibility testing? See Accessibility Guide
- Test coverage? Check Testing Guide
- Design decisions? Review Architecture Decision Records
- System design? See Architecture
- Security architecture? Check Security Documentation
See main README.md for contributing guidelines.
Project documentation maintained by the development team