Documentation
Comprehensive guides for everyone who works with KoNote — from daily users to system administrators to developers.
User Guide
For: Staff and counsellors
Day-to-day use of KoNote: finding participants, writing progress notes, viewing outcome plans, recording events, and using the dashboard.
- Logging in and navigation
- Finding and filtering participants
- Writing quick and full notes
- Recording events and alerts
- Viewing outcome progress
Administrator Guide
For: Admins and program managers
Setting up and managing KoNote: configuring programs, managing users, customising terminology, and handling backups.
- Agency configuration
- User and role management
- Terminology customisation
- Backup and restore
- Security operations
Deployment Guide
For: IT staff and consultants
Step-by-step deployment instructions for Railway, Azure, Elestio, and self-hosted Docker environments.
- Prerequisites and preparation
- Platform-specific instructions
- Environment configuration
- Post-deployment checklist
- Troubleshooting
Technical Documentation
For: Developers
Architecture, code structure, database schema, and guidance for developers who want to understand or extend KoNote.
- Architecture overview
- Database schema and models
- Security implementation
- Middleware and context processors
- Extension and customisation
Privacy Policy Template
For: Compliance officers
A PIPEDA-compliant privacy policy template you can adapt for your organisation's KoNote deployment.
- Data collection practices
- Protection methods
- Access control
- Audit logging
- PIPEDA rights
Security Overview
For: Everyone
How KoNote protects participant data, and what you're responsible for as the operator.
- Encryption details
- Access control
- Audit logging
- Your responsibilities
Quick Links
GitHub Repository
The source code, documentation, and issue tracker all live on GitHub.
Report Issues
Found a bug? Have a feature request? Open an issue on GitHub. Please search existing issues first.
Licence
KoNote is released under the MIT Licence. You can use, modify, and distribute it freely, including for commercial purposes.
Documentation Notes
Living Documentation
The documentation is maintained alongside the code in the GitHub repository. If you find errors or gaps, you can submit corrections via pull request or open an issue.
Version Compatibility
Documentation reflects the current main branch. If you're running an older version of KoNote, some features or instructions may differ. Check the commit history if you need documentation for a specific version.
Need More Help?
If the documentation doesn't answer your questions, you have options.