Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 2.42 KB

Readme.md

File metadata and controls

77 lines (51 loc) · 2.42 KB

Build Status Dependency Status Gitter

AnyCable-Go WebSocket Server

WebSocket server for AnyCable.

Installation

The easiest way to install AnyCable-Go is to download a pre-compiled binary.

Or with Homebrew

brew install anycable/anycable/anycable-go

Of course, you can install it from source too:

go get -u -f github.com/anycable/anycable-go

Usage

Run server:

anycable-go -rpc=0.0.0.0:50051 -headers=cookie,x-api-token -redis=redis://localhost:6379/5 -redis_channel=anycable -addr=0.0.0.0:8080 -log

=> Running AnyCable websocket server v0.5.0 on 0.0.0.0:8080 at /cable

You can also provide configuration parameters through the corresponding environment variables (i.e. RPC, REDIS, etc).

TLS

To secure your anycable-go server provide the paths to SSL certificate and private key:

anycable-go -addr=0.0.0.0:443 -ssl_cert=path/to/ssl.cert -ssl_key=path/to/ssl.key

=> Running AnyCable websocket server (secured) v0.5.1 on 0.0.0.0:443 at /cable

Build

make

Docker

See available images here.

ActionCable Compatibility

Feature Status
Connection Identifiers +
Connection Request (cookies, params) +
Disconnect Handling +
Subscribe to channels +
Parameterized subscriptions +
Unsubscribe from channels +
Performing Channel Actions +
Streaming +
Usage of the same stream name for different channels +
Broadcasting +
Custom stream callbacks -
Subscription Instance Variables -

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/anycable-go.

License

The library is available as open source under the terms of the MIT License.