• Stars
    star
    366
  • Rank 116,547 (Top 3 %)
  • Language
    Go
  • License
    MIT License
  • Created about 8 years ago
  • Updated 19 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

AnyCable real-time server

Latest Release Build CircleCI Docker Documentation

AnyCable-Go WebSocket Server

WebSocket server for AnyCable.

AnyCable Pro has been launched 🚀

Versioning

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.

Installation

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

# Example for `anycable-go-linux-amd64`
curl -fsSL https://github.com/anycable/anycable-go/releases/latest/download/anycable-go-linux-amd64 -o anycable-go
chmod +x anycable-go
./anycable-go -v

MacOS users could install it with Homebrew

brew install anycable-go

Arch Linux users can install anycable-go package from AUR.

Of course, you can install it from source too:

go install github.com/anycable/anycable-go/cmd/anycable-go@latest

Upgrade

For instructions on how to upgrade to a newer version see upgrade notes.

Heroku

See heroku-anycable-go buildpack.

Usage

Run server:

$ anycable-go

=> INFO 2020-02-05T08:44:57.684Z context=main Starting AnyCable 1.1.0

You 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.

📑 Documentation

Build

# first, prepare mruby (we embed it by default)
# NOTE: Might require running with sudo, since we build artifacts within a Go module
make prepare-mruby

# then build the Go binary (will be available in dist/anycable-go)
make

You can run tests with the following commands:

# Run Golang unit tests
make test

# Run once
make prepare

# Run integrations tests
make test-conformance

# Run integration benchmarks
go install github.com/anycable/websocket-bench@latest
make benchmarks

We use golangci-lint to lint Go source code:

make lint

Docker

See available images here.

Contributing

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.

License

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

Security Contact

To report a security vulnerability, please contact us at [email protected]. We will coordinate the fix and disclosure.

More Repositories

1

anycable

AnyCable for Ruby applications
Ruby
1,922
star
2

anycable-rails

AnyCable for Ruby on Rails applications
Ruby
495
star
3

anycable_rails_demo

AnyCable Rails demo application and its different variations
Ruby
215
star
4

graphql-anycable

A drop-in replacement for GraphQL ActionCable subscriptions. Works with AnyCable.
Ruby
112
star
5

anycable-client

AnyCable / Action Cable JavaScript client for web, Node.js & React Native
TypeScript
89
star
6

anycable_demo

Anycable demo application
Ruby
53
star
7

erlycable

Anycable Erlang WebSocket server
Erlang
45
star
8

xk6-cable

A k6 extension for testing Action Cable and AnyCable functionality
Go
26
star
9

anycable-rack-server

AnyCable-compatible Ruby Rack middleware
Ruby
25
star
10

heroku-anycable-go

Heroku buildpack for bundling Anycable-Go
Shell
18
star
11

anycable-helm

Helm charts for installing any cables into a Kubernetes cluster
Mustache
18
star
12

anyt

AnyCable conformance testing tool
Ruby
13
star
13

anycable-twilio-hanami-demo

Using AnyCable and Hanami to build an app to process Twilio Media streams
Go
12
star
14

vercel-anycable-demo

Next.js real-time application using AnyCable-Go as a real-time server and deployed on Vercel
TypeScript
12
star
15

websocket-bench

CLI interface for benchmark AnyCable
Go
10
star
16

anycable-serverless-js

AnyCable channels API for serverless
TypeScript
9
star
17

docs.anycable.io

AnyCable documentation
Ruby
9
star
18

action-cable-redis-backport

Ruby
7
star
19

capistrano-anycable

AnyCable integration for Capistrano
Ruby
7
star
20

anycable-rails-jwt

JWT identification helpers for AnyCable
Ruby
5
star
21

anycable-web

AnyCable web page
SCSS
5
star
22

anycable-go-scaffold

Template repository for anycable-go based applications
Go
3
star
23

anycable.github.io

AnyCable website contents
HTML
3
star
24

caddy-anycable

AnyCable module for Caddy
Go
3
star
25

uptriever

A CLI to upload documentation chunks to Trieve
Ruby
3
star
26

github-actions

Reusable Github Actions for AnyCable projects
2
star
27

homebrew-anycable

Anycable homebrew formulae
2
star
28

kuby-anycable

Kuby plugin to deploy AnyCable applications
Ruby
2
star
29

anycable-pubsub-nextjs

AnyCable / Next.js minimal example
TypeScript
1
star
30

simple-cable-app

Minimal ActionCable/AnyCable application which could be deployed on Heroku
Ruby
1
star