Nojoin Documentation
This folder is the canonical home for Nojoin documentation.
Use the links below by task rather than treating the root README as the source of truth for every topic.
Start Here
- GETTING_STARTED.md: First deployment, first admin account, and the shortest path to your first recording.
- CAPTURE.md: Browser capture setup, supported browsers, sharing audio, pause/resume behavior, and capture troubleshooting.
- DEPLOYMENT.md: Hosting, Docker, environment variables, reverse proxy, and updating.
- USAGE.md: Day-to-day product usage for normal users.
- DEVELOPMENT.md: Local development prerequisites and main source-build commands.
Feature and Operations Guides
- CALENDAR.md: Google and Microsoft calendar setup, user connection flow, dashboard behaviour, and troubleshooting.
- ADMIN.md: Roles, invitations, password rotation, admin settings, and system operations.
- BACKUP_RESTORE.md: Backup contents, restore behaviour, conflict modes, and sensitivity model.
- ARCHITECTURE.md: System overview, processing pipeline, auth model, and release model.
- DEVELOPMENT.md: Local development setup for backend, frontend, and browser capture work.
Policies and Project References
- SECURITY.md: Security policy and vulnerability reporting.
- LEGAL.md: Legal disclaimer and recording-law responsibility.
- CODE_OF_CONDUCT.md: Community conduct expectations.
- PRD.md: Product requirements and longer-term feature scope.
- AGENTS.md: Contributor and automation-oriented project instructions.
- code-audit.md: Living security, release-readiness, correctness, and code-quality remediation tracker.
- VERSION: The current release version used by the project.
Common Tasks
| I want to… | Read this |
|---|---|
| Bring up Nojoin for the first time | GETTING_STARTED.md |
| Start, resume, or troubleshoot browser recording | CAPTURE.md |
| Deploy or upgrade a self-hosted instance | DEPLOYMENT.md |
| Learn how to use the dashboard and recordings workspace | USAGE.md |
| Configure Google or Outlook calendar sync | CALENDAR.md |
| Manage users, invitations, and admin settings | ADMIN.md |
| Understand backup sensitivity and restore modes | BACKUP_RESTORE.md |
| Understand how the system fits together technically | ARCHITECTURE.md |
| Set up a local source development environment | DEVELOPMENT.md |