How m1k1o/neko works
Neko is a self-hosted virtual desktop/browser that streams an isolated Linux desktop to one or more users over WebRTC. A user loads the Vue client, authenticates through the HTTP API, joins a session over WebSocket, and receives audio/video while control, clipboard, keyboard, chat, and file actions are dispatched back to the server. Session management coordinates membership and permissions; desktop and capture layers access X11 and GStreamer. The graph emphasizes sampled runtime wiring; some API handlers and plugin routes are represented at their enclosing paths.
Main entry points: session/manager.go Session Manager · app.vue Vue Client · websocket/manager.go WebSocket Gateway · handler.go Message Handlers
Components 22
Client
- Vue Client
client/src/app.vue - Client State
client/src/store/index.ts - Neko Protocol
client/src/neko/index.ts - Browser Storage
client/src/utils/localstorage.ts
Gateway And Sessions
- HTTP Server
server/internal/http/manager.go - API Router
server/internal/api/router.go - WebSocket Gateway
server/internal/websocket/manager.go - Message Handlers
server/internal/websocket/handler/handler.go - Member Manager
server/internal/member/manager.go - Member Providers
server/internal/member - Session Manager
server/internal/session/manager.go
Desktop And Media
- Desktop Manager
server/internal/desktop/manager.go - Capture Manager
server/internal/capture/manager.go - Media Pipelines
server/internal/config/capture_pipeline.go - WebRTC Manager
server/internal/webrtc/manager.go
Extensions
- Plugin Manager
server/internal/plugins/manager.go - Chat Plugin
server/internal/plugins/chat/manager.go - File Transfer
server/internal/plugins/filetransfer/manager.go
Other components
- Participant
- X11 Desktop
- GStreamer
- Shared Files
Connections 30
- Participant → Vue Client: opens client
- Vue Client → HTTP Server: API requests
- Vue Client → WebSocket Gateway: opens socket
- Vue Client → Client State: updates state
- Client State → Browser Storage: reads settings
- Neko Protocol → WebSocket Gateway: sends messages
- HTTP Server → API Router: routes API
- HTTP Server → WebSocket Gateway: upgrades socket
- API Router → Member Manager: authenticates members
- API Router → Session Manager: manages sessions
- Member Manager → Member Providers: authenticates against
- Member Manager → Session Manager: creates sessions
- WebSocket Gateway → Message Handlers: dispatches messages
- Message Handlers → Session Manager: updates session
- Message Handlers → Desktop Manager: controls desktop
- Message Handlers → WebRTC Manager: signals peers
- Session Manager → WebSocket Gateway: broadcasts events
- Desktop Manager → X11 Desktop: controls display
- Capture Manager → Desktop Manager: reads screen
- Capture Manager → Media Pipelines: builds pipelines
- Media Pipelines → GStreamer: checks codecs
- Capture Manager → GStreamer: captures media
- WebRTC Manager → Desktop Manager: reads cursor
- WebRTC Manager → Capture Manager: starts streams
- WebRTC Manager → Vue Client: streams media
- Plugin Manager → Chat Plugin: starts plugin
- Plugin Manager → File Transfer: starts plugin
- Chat Plugin → Session Manager: broadcasts chat
- File Transfer → Session Manager: broadcasts files
- File Transfer → Shared Files: reads and writes