WebSocket server for AnyCable.
Important This is a readme for the upcoming v1.0 release. For v0.6.x see the readme from the 0-6-stable branch.
Important Use the same major version of AnyCable-Go as your AnyCable gem. AnyCable-Go uses the same major version number (and minor version as well for 0.x series) as other libraries to indicate the compatibility.
NOTE: AnyCable-Go v1.0 is backward-compatible with v0.6.x series (to allow incremental upgrades). The next minor relase (v1.1) will drop 0.6.x support.
The easiest way to install AnyCable-Go is to download a pre-compiled binary.
MacOS users could install it with Homebrew
brew install anycable-goArch Linux users can install anycable-go package from AUR.
Of course, you can install it from source too:
go get -u -f github.com/anycable/anycable-go/cmd/anycable-goNOTE: right now it's not possible to build anycable-go with mruby support using the command above. To install anycable-go with mruby from source try:
go get -d -u -f github.com/anycable/anycable-go/cmd/anycable-go && (cd $GOPATH/src/github.com/anycable/anycable-go && make prepare-mruby install-with-mruby)
For instructions on how to upgrade to a newer version see upgrade notes.
See heroku-anycable-go buildpack.
Run server:
$ anycable-go
=> INFO 2020-02-05T08:44:57.684Z context=main Starting AnyCable 1.0.0You can also provide configuration parameters through the corresponding environment variables (i.e. ANYCABLE_RPC_HOST, ANYCABLE_REDIS_URL, etc).
For more information about available options run anycable-go -h.
To enable redis sentinel support set --redis-sentinels to a comma separated list of sentinels (format: <host>:<port>,...)
and set the --redis-url like that: redis://[:<redis_password>@]<redis_master_name>
# first, prepare mruby (we embed it by default)
make prepare-mruby
# then build the Go binary (will be available in dist/anycable-go)
makeYou can run tests with the following commands:
# Run Golang unit tests
make test
# run once
make prepare
# Run integrations tests
make test-conformanceWe use golangci-lint to lint Go source code:
golangci-lint runSee available images here.
Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/anycable-go.
Please, provide reproduction script (using this template) when submitting bugs if possible.
The library is available as open source under the terms of the MIT License.
To report a security vulnerability, please contact us at [email protected]. We will coordinate the fix and disclosure.