Lynkoria documentation
Add video calls, livestreams, messaging and presence to your product with one SDK and one console.
Lynkoria is Guildsman’s self-hosted realtime communication platform. Your product keeps its own users, sign-in and business rules; Lynkoria provides the rooms, media, message history and realtime delivery behind them. This docs/ folder is the single source of truth: the documentation site (apps/docs) renders it, and the repository README links here.
What you can build
| Capability | What it gives you | Guide |
|---|---|---|
| Video and audio calls | One-to-one and group rooms with camera, microphone, device selection and live participant state. | Calls |
| Group meetings | Larger rooms with hosts, moderation, room-size quotas and optional single-device enforcement. | Group meetings |
| Livestreaming | Hosts and speakers publish; viewers watch without publish rights. Your backend promotes speakers. | Livestreaming |
| Screen sharing | Share a screen, window or tab inside any call. | Screen sharing |
| Messaging | Ordered, durable conversations with history, edits, deletes, reactions, read receipts and attachments. | Messaging |
| Presence | Online, away, busy, do-not-disturb and invisible status across a user’s devices. | Presence |
| Recording | Room composite, audio-only and per-track recording through LiveKit Egress (preview). | Recording |
| File security | Private attachments released only after type checks and malware scanning. | File scanning |
| Webhooks | Signed server-to-server events for call lifecycle and new messages. | Webhooks |
How it fits together
- Your backend holds a secret API key (a service key). It creates calls and conversations and mints short-lived tokens for your signed-in users.
- Your app uses
@lynkoria/client(or@lynkoria/react,@lynkoria/react-native, the Android or iOS SDK) with those tokens to send messages, watch presence and join calls. It never sees the service key. - The Lynkoria console is where operators create projects, issue keys, set allowed origins and quotas, and watch usage.
Read core concepts for the full model, or start with the quickstart: your first message and call in about 15 minutes. Try everything without code in the Lynkoria Playground (quickstart).
Documentation map
| Section | For | Contents |
|---|---|---|
| Developer guides (this tab) | Product engineers | Quickstart, features, SDK and API reference, errors, limits, platform status |
| Architecture | Platform team | Components, data flows, database, compatibility |
| Security | Platform, security | Controls by layer, findings register, pre-deploy checklist |
| Deployment | Operators | Local setup, prerequisites, environment variables, deployment handbook, production checklist |
| Operations | On-call | Releases, rollback, rotation, backups, monitoring, load testing, package publishing |
| Decisions | Everyone | Architecture decision records (ADRs) |
| Implementation | Platform team | Tracker, completed, remaining tasks, blockers, changelog |
| Reviews | Platform team | Dated audits and their results |
The integrator guides stay at the top level of docs/ so their URLs (/docs/calls, /docs/messaging, …) remain stable for SDK READMEs and source comments that link to them; see ADR 019.
Platform status
Browser media, messaging, presence, attachments with malware scanning, webhooks and the console are supported and tested against real local infrastructure. Recording, push notifications and the native Android, iOS and React Native SDKs are in preview: implemented, but not yet verified against real Egress, real push providers or physical devices. Lynkoria does not manage end-to-end encryption keys. Capacity has only been measured locally. See platform status before you plan a launch, and blockers for what production still needs.