README
¶
Centrifugo is a real-time messaging server. It's language-agnostic and can be used in conjunction with application backend written in any language - Python, Ruby, Perl, PHP, Javascript, Java, Objective-C etc.
Centrifugo runs as separate service and keeps persistent Websocket or SockJS connections from your application clients (from web browsers or other environments like iOS or Android apps). When some event happens you can broadcast it to all interested clients using Centrifugo API.
Documentation is a good start to get all details. You can also find this introduction post interesting – this is a story behind Centrifugo.
How to install
Releases available as single executable files – just download latest release for your platform, unpack and run.
If you are on MacOS:
brew tap centrifugal/centrifugo https://github.com/centrifugal/centrifugo
brew install centrifugo
See official Docker image.
There are also packages for 64-bit Debian, Centos and Ubuntu.
Demo
Try our demo instance on Heroku (password demo). Or deploy your own Centrifugo instance in one click:
Highlights
- Fast server capable to serve thousands of simultaneous connections
- Easily integrates with existing application – no need to rewrite your backend code to introduce real-time events
- HTTP API to communicate from your application backend (publish messages in channels etc.). API clients for Python, Ruby, PHP, Go, NodeJS. Simple to implement new one
- Javascript client to connect from web browser over SockJS or pure Websocket protocol. Clients for iOS and Android on top of Websocket
- Scale to several machines with Redis, Redis Sentinel for high availability, consistent hash sharding.
- SHA-256 HMAC-based connection authentication and private channel authorization
- Different types of channels – private, user limited, client limited channels
- Flexible configuration of channels via namespaces
- Presence information for channels (show all active clients in channel)
- History information for channels (last messages sent into channels)
- Join/leave events for channels (client goes online/offline)
- Recover missed messages after network disconnect
- Built-in administrative web interface
- Possibility to use as WebRTC signaling server
- Ready to deploy (docker image, RPM/DEB packages, Nginx configuration, automatic Let's Encrypt TLS certificates)
- MIT license
Simplified scheme
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
extras
|
|
|
libcentrifugo
|
|
|
auth
Package auth provides functions to generate and check Centrifugo tokens and signs.
|
Package auth provides functions to generate and check Centrifugo tokens and signs. |
|
bytequeue
Package bytequeue provides []byte queue for libcentrifugo package client messages.
|
Package bytequeue provides []byte queue for libcentrifugo package client messages. |
|
integration
Package integration exists only for Centrifugo integration tests.
|
Package integration exists only for Centrifugo integration tests. |
|
node
Package node is a real-time core for Centrifugo server.
|
Package node is a real-time core for Centrifugo server. |
|
priority
Package priority provides priority queue for libcentrifugo package Memory Engine.
|
Package priority provides priority queue for libcentrifugo package Memory Engine. |
|
proto
Package proto is a generated protocol buffer package.
|
Package proto is a generated protocol buffer package. |
|
raw
Package raw contains Raw type (alias to slice of bytes).
|
Package raw contains Raw type (alias to slice of bytes). |