centrifugo

README

  

Centrifugo is a scalable real-time messaging server in a language-agnostic way.

Centrifugo works in conjunction with application backend written in any programming language. It runs as a separate service and keeps persistent connections from application clients established over several supported types of transport (WebSocket, SockJS, EventSource, GRPC, HTTP-streaming). When you need to deliver an event to your clients in real-time, you publish it to Centrifugo server API – and Centrifugo then broadcasts the event to all connected clients interested in this event (clients subscribed to the event channel). In other words – Centrifugo is a user-facing PUB/SUB server.

For more information follow to Centrifugo documentation site.

How to install

See installation instructions in Centrifugo documentation.

Demo

Try our demo instance on Heroku (admin password is password, token_hmac_secret_key is secret, API key is api_key). Or deploy your own Centrifugo instance in one click:

Highlights

• Centrifugo is fast and capable to scale to millions of simultaneous connections
• Simple integration with any application – works as separate service, provides HTTP and GRPC API
• Client connectors for popular frontend environments – for both web and mobile development
• Strict client protocol based on Protobuf schema
• Bidirectional transport support (WebSocket and SockJS) for full-featured communication
• Unidirectional transport support without need in client connectors - use native APIs (SSE, Fetch, WebSocket, GRPC)
• User authentication with a JWT or over connection request proxy to configured HTTP/GRPC endpoint
• Proper connection management and expiration control
• Various types of channels: anonymous, authenticated, private, user-limited
• Various types of subscriptions: client-side or server-side
• Transform RPC calls over WebSocket/SockJS to configured HTTP or GRPC endpoint call
• Presence information for channels (show all active clients in a channel)
• History information for channels (last messages published into a channel)
• Join/leave events for channels (client subscribed/unsubscribed)
• Automatic recovery of missed messages between reconnects over configured retention period
• Built-in administrative web panel
• Cross platform – works on Linux, macOS and Windows
• Ready to deploy (Docker, RPM/DEB packages, automatic TLS certificates, Prometheus instrumentation, Grafana dashboard)
• Open-source license

Backing

This repository is hosted by packagecloud.io.

Also thanks to JetBrains for supporting OSS (most of the code here written in Goland):

Documentation

Overview

Copyright (c) 2015 Centrifugal

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.