• Example Search
• Project Search

• Java
• Python
• JavaScript
• TypeScript
• C++
• Scala
• Blog

Project: sync3k-server (GitHub Link)

• sync3k-server-master
  • src
    • main
      • scala
        • sync3k
          • routes
            • SimpleRoutes.scala
            • WebSocketRoutes.scala
            • BaseRoutes.scala
          • WebServer.scala
    • test
      • scala
        • sync3k
          • routes
            • WebSocketRoutesSpec.scala
            • SimpleRoutesSpec.scala
            • BaseRoutesSpec.scala
  • LICENSE
  • project
    • build.properties
    • plugins.sbt
  • CONTRIBUTING.md
  • README.md
  • Dockerfile
  • build.sbt
  • .gitignore
  • docker-compose.yml

Sync3k Server

sync3k-server is a lightweight websocket gateway to kafka. The server accepts websocket path:

ws://localhost:8080/kafka/:topic/:offset

Network binding, listening port and kafka bootstrap server can be configured through flags.

  -b, --bind <value>       interface to bind to. Defaults to 0.0.0.0
  -p, --port <value>       port number to listen to. Defaults to 8080
  -k, --kafkaServer <value>
                           Kafka bootstrap server. Defaults to localhost:9092

The server is intended to be used with sync3k-client.

Usage

Use sbt to run the server.

sbt "run --port 8080 --kafkaServer kafkaserver:9092"

Running everything with Docker

sync3k-server includes Dockerfile and docker compose YAML that launches zookeeper, kafka and sync3k-server.

To build the Docker image, first build an uber-jar with sbt assembly command:

sbt assembly

Then build the Docker image:

docker build . -t sync3k/sync3k-server .

Alternatively, you can pull from Docker repo:

docker pull sync3k/sync3k-server

Finally, launch everything with docker-compose:

docker-compose up -d

Disclaimer: This is not an official Google product.