Guides

These guides walk you through implementing common Teleportal features and patterns. Each guide includes working code examples and explanations.

WebSocket Only

Minimal server setup with WebSocket transport and in-memory storage

HTTP Transport

Using HTTP/SSE transport for environments where WebSockets are blocked

Fallback Connection

Automatic fallback from WebSocket to HTTP when WebSocket fails

Authentication

JWT token-based authentication with permission management

Persistent Storage

Using persistent storage backends instead of in-memory storage

Encryption at Rest

Encrypting documents in storage for security

Pub/Sub

Multi-server setup with pub/sub for horizontal scaling

Observability

Monitoring and health checks with Prometheus metrics

Custom Storage

Implementing a custom storage backend

Rate Limiting

Rate limiting client messages to prevent abuse