https://github.com/a-wing/lightcable

lightweight websocket broadcast server
https://github.com/a-wing/lightcable

broadcast broadcast-channel websocket websocket-server

Last synced: about 1 month ago
JSON representation

lightweight websocket broadcast server

• Host: GitHub
• URL: https://github.com/a-wing/lightcable
• Owner: a-wing
• License: mit
• Created: 2021-07-25T16:24:35.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-11-06T14:56:12.000Z (about 1 year ago)
• Last Synced: 2024-12-15T00:12:36.637Z (about 1 month ago)
• Topics: broadcast, broadcast-channel, websocket, websocket-server
• Language: Go
• Homepage:
• Size: 60.5 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# lightcable

lightweight websocket channel server

[![Go Reference](https://pkg.go.dev/badge/github.com/a-wing/lightcable.svg)](https://pkg.go.dev/github.com/a-wing/lightcable)

[![Build Status](https://github.com/a-wing/lightcable/workflows/ci/badge.svg)](https://github.com/a-wing/lightcable/actions?query=workflow%3Aci)

[![codecov](https://codecov.io/gh/a-wing/lightcable/branch/master/graph/badge.svg)](https://codecov.io/gh/a-wing/lightcable)

[![Go Report Card](https://goreportcard.com/badge/github.com/a-wing/lightcable)](https://goreportcard.com/report/github.com/a-wing/lightcable)

[![license](https://img.shields.io/github/license/a-wing/lightcable.svg?maxAge=2592000)](https://github.com/a-wing/lightcable/blob/master/LICENSE)

[![GitHub release](https://img.shields.io/github/tag/a-wing/lightcable.svg?label=release)](https://github.com/a-wing/lightcable/releases)

## Compile

* golang >= 1.13

### Application scenario

* A simple Websocket broadcast room

* WebRTC signaling server

* Replace [socket.io](https://socket.io/)  (Special case: client only join a room)

* Wx APP sdk and webview communication (WeChat Mini Program and Webview communication)

### As a Application

```bash

docker run -p 8080:8080 ghcr.io/a-wing/lightcable

```

install && run

```bash

go install github.com/a-wing/lightcable/cmd/lightcable@latest

# Listen port: 8088

lightcable -l localhost:8088

```

### URL

```bash

ws://localhost:8080/{room}

```

### broadcast server demo

Server

```bash

lightcable

```

Room: `xxx`

```bash

websocat --linemode-strip-newlines 'ws://localhost:8080/xxx'

```

Room: `xxx`

```bash

websocat --linemode-strip-newlines 'ws://localhost:8080/xxx'

```

Room: `xxx-2`

```bash

websocat --linemode-strip-newlines 'ws://localhost:8080/xxx-2'

```