Comparison with the Official Repository¶
Content gaps - official repo has it, these docs do not (yet)¶
| # | File |
|---|---|
| 1 | features/signaling.md - LiveKit signaling protocol details |
| 2 | features/subtitles.md - subtitle/caption feature |
| 3 | features/authentication.md - in-depth authentication feature documentation |
| 4 | resource_server.yaml - API resource server config |
| 5 | installation/scalingo.md - Scalingo PaaS deployment guide |
| 6 | docs/examples/ - ready-to-use compose.yaml and Helm values files |
Environment variable issues¶
Incorrect defaults or names in official docs - corrected here¶
| # | These docs | Official repo |
|---|---|---|
| 7 | FRONTEND_CUSTOM_CSS_URL ✅ correct name |
FRONTEND_CSS_URL ❌ outdated - also not listed in env var table |
| 8 | FRONTEND_IS_SILENT_LOGIN_ENABLED default True ✅ (verified in settings.py) |
default false ❌ - opposite of the code default |
| 9 | Django CELERY_BROKER_URL default redis://redis:6379/0 ✅ (matches settings.py) |
Transcription guide lists redis://redis/0 ❌ - that is the summary service default, not the Django backend |
| 10 | Summary WHISPERX_BASE_URL default https://api.openai.com/v1 ✅ (matches config.py) |
https://api.whisperx.com/v1 ❌ - outdated; the service now targets an OpenAI-compatible endpoint |
Variables missing from official docs - documented here¶
| # | These docs | Official repo |
|---|---|---|
| 11 | OIDC_RP_SIGN_ALGO - token signing algorithm, default RS256 (present in settings.py) |
Not documented ❌ |
| 12 | Summary service: AUTHORIZED_TENANTS - current multi-tenant auth replaces deprecated APP_API_TOKEN / WEBHOOK_API_TOKEN / WEBHOOK_URL |
Not documented; deprecated vars shown as current ❌ |
| 13 | Summary service: WHISPERX_DEFAULT_LANGUAGE, WHISPERX_ALLOWED_LANGUAGES, IS_SUMMARY_ENABLED, CELERY_RESULT_BACKEND |
Not documented ❌ |
Structure¶
| # | These docs | Official repo |
|---|---|---|
| 14 | Single comprehensive table in reference/env-variables.md |
Split per-feature across multiple sections |
Theming & assets¶
| # | These docs | Official repo |
|---|---|---|
| 15 | Documents that raw palette tokens (--colors-primary-800) must also be overridden, not just semantic tokens |
Not mentioned |
| 16 | Warns against directory mounts; shows individual file mounts | Shows directory mount (breaks the app) |
| 17 | Docker Compose example (corrected) | Not included |
| 18 | Kubernetes example with subPath |
Not included |
| 19 | Mentions /api/v1.0/config/ endpoint exposing custom_css_url |
Not mentioned |
| 20 | Dedicated light/dark mode section | Single callout note |
| 21 | Missing DINUM Dockerfile reference ❌ | Included ✅ |
Content gaps - these docs have it, official repo does not¶
| # | File |
|---|---|
| 22 | reference/security.md - full security model, CVE history, hardening guide |
| 23 | reference/networking.md - port table, traffic flow, ICE/STUN/TURN, firewall rules |
| 24 | reference/troubleshooting.md - 350+ lines covering every component |
| 25 | overview/changelog.md - v1.0.1 through v1.17.0 - integrated in docs nav |
| 26 | overview/feature-matrix.md - all features and availability status |
| 27 | overview/key-concepts.md - rooms, SFU, tokens, egress explained |
| 28 | self-hosting/simple/upgrade.md - standard and zero-downtime upgrade procedure |
| 29 | self-hosting/simple/sso.md - setup guides for Keycloak, Authentik, Google, ProConnect |
| 30 | install.sh - interactive setup script |
Feature docs overlap¶
| # | These docs |
|---|---|
| 31 | Recording: self-hosting/advanced/recording.md (640+ lines) |
| 32 | Telephony: self-hosting/advanced/telephony.md |
| 33 | Transcription: self-hosting/advanced/transcription.md |
| 34 | Summarization: covered within the transcription doc |
| 35 | Calendar: mentioned in feature-matrix as work in progress |
Structural differences¶
| # | These docs |
|---|---|
| 36 | Nested hierarchy by audience: user/, self-hosting/, contributing/, reference/, overview/ |
| 37 | user/ - 9 files: getting-started, features-controls, settings, recording, transcription, FAQ, accessibility, keyboard-shortcuts, tutorial |
| 38 | overview/ - 5 files: what-is-meet, architecture, changelog, feature-matrix, key-concepts |
| 39 | contributing/ - 7 files: backend, frontend, livekit-integration, local-dev, pull-requests, repo-structure, testing |
| 40 | reference/ - 5 files: API, env-vars, networking, security, troubleshooting |
| 41 | No examples/ directory ❌ |
| 42 | overview/changelog.md linked in docs nav; official repo has CHANGELOG.md at root but it is not part of the docs site |