https://github.com/SocketCluster/socketcluster

Highly scalable realtime pub/sub and RPC framework
https://github.com/SocketCluster/socketcluster

docker framework javascript kubernetes nodejs pubsub realtime scalable socketcluster websocket websockets

Last synced: 3 months ago
JSON representation

Highly scalable realtime pub/sub and RPC framework

• Host: GitHub
• URL: https://github.com/SocketCluster/socketcluster
• Owner: SocketCluster
• License: mit
• Created: 2013-09-23T12:11:47.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-03-27T17:23:37.000Z (10 months ago)
• Last Synced: 2024-04-23T10:51:34.781Z (9 months ago)
• Topics: docker, framework, javascript, kubernetes, nodejs, pubsub, realtime, scalable, socketcluster, websocket, websockets
• Language: JavaScript
• Homepage: https://socketcluster.io
• Size: 2.47 MB
• Stars: 6,111
• Watchers: 179
• Forks: 313
• Open Issues: 91
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome - socketcluster - Highly scalable realtime framework (JavaScript)
• awesome-nodejs-cn - SocketCluster - 可运行多 CPU 核心的可扩展的 HTTP + WebSocket 引擎 (包 / 实时)
• awesome-nodejs - SocketCluster - Scalable HTTP + WebSocket engine which can run on multiple CPU cores.  (Repository / Real-time)
• awesome-nodejs - SocketCluster - Scalable HTTP + WebSocket engine which can run on multiple CPU cores. (Packages / Real-time)
• awesome-nodejs - socketcluster - Highly scalable realtime framework - ★ 4977 (Real-time)
• awesome-node - SocketCluster - Scalable HTTP + WebSocket engine which can run on multiple CPU cores. (Packages / Real-time)
• awesome-nodejs-cn - SocketCluster - 可扩展的HTTP + WebSocket引擎，可以在多个CPU内核上运行. (目录 / 即时通信)
• StarryDivineSky - SocketCluster/socketcluster
• awesome - Socketcluster - Highly scalable realtime framework (Websocket libraries)
• awesome - SocketCluster/socketcluster - Highly scalable realtime pub/sub and RPC framework (JavaScript)
• awesome-list-docker - socketcluster
• awesome-nodejs-cn - SocketCluster - **star:6149** 可伸缩的HTTP + WebSocket引擎，可以运行在多个CPU核心 ![star > 2000][Awesome] (包 / 实时)

README

        
# SocketCluster

Toolset and boilerplate for quickly creating systems using SocketCluster.

See the client and server repos for documentation:

- https://github.com/SocketCluster/socketcluster-client

- https://github.com/SocketCluster/socketcluster-server

Documentation for SCC (horizontally scalable cluster) is available at https://github.com/SocketCluster/socketcluster/blob/master/scc-guide.md

## Installation

Setup the `socketcluster` command:

```bash

npm install -g socketcluster

```

or:

```bash

sudo npm install -g socketcluster

```

then:

```bash

socketcluster create myapp

```

Once it's installed, go to your new myapp/ directory and launch with:

```bash

node server

```

Access at URL http://localhost:8000/

Node.js `v10.0.0` or above is recommended but you can also use SocketCluster with older Node.js versions if you use `while` loops instead of `for-await-of` loops.

## Compatibility mode

For compatibility with existing SocketCluster clients, set the `protocolVersion` to `1` and make sure that the `path` matches your old client path:

```js

let agServer = socketClusterServer.attach(httpServer, {

  protocolVersion: 1,

  path: '/socketcluster/'

});

```

## Change log

See the 'releases' section for changes: https://github.com/SocketCluster/socketcluster/releases

## License

(The MIT License)

Copyright (c) 2013-2023 SocketCluster.io

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.