{"id":16767402,"url":"https://github.com/vardius/pubsub","last_synced_at":"2025-03-21T23:33:37.827Z","repository":{"id":57483312,"uuid":"192628157","full_name":"vardius/pubsub","owner":"vardius","description":"gRPC message-oriented middleware on top of message-bus, event ingestion and delivery system.","archived":false,"fork":false,"pushed_at":"2023-02-25T05:45:16.000Z","size":106,"stargazers_count":48,"open_issues_count":2,"forks_count":10,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-14T06:09:02.332Z","etag":null,"topics":["broker","bus","docker","docker-image","grpc","grpc-go","message-broker","message-bus","message-queue","pubsub","queue"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/vardius/pubsub","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vardius.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["vardius"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-06-19T00:04:52.000Z","updated_at":"2024-07-28T11:44:08.000Z","dependencies_parsed_at":"2024-06-18T20:11:53.259Z","dependency_job_id":null,"html_url":"https://github.com/vardius/pubsub","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vardius%2Fpubsub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vardius%2Fpubsub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vardius%2Fpubsub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vardius%2Fpubsub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vardius","download_url":"https://codeload.github.com/vardius/pubsub/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221820606,"owners_count":16886222,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["broker","bus","docker","docker-image","grpc","grpc-go","message-broker","message-bus","message-queue","pubsub","queue"],"created_at":"2024-10-13T06:09:04.515Z","updated_at":"2024-10-28T11:15:23.567Z","avatar_url":"https://github.com/vardius.png","language":"Go","funding_links":["https://github.com/sponsors/vardius"],"categories":["Go"],"sub_categories":[],"readme":"# 📬 pubsub\n\n[![Build Status](https://travis-ci.org/vardius/pubsub.svg?branch=master)](https://travis-ci.org/vardius/pubsub)\n[![Go Report Card](https://goreportcard.com/badge/github.com/vardius/pubsub)](https://goreportcard.com/report/github.com/vardius/pubsub)\n[![codecov](https://codecov.io/gh/vardius/pubsub/branch/master/graph/badge.svg)](https://codecov.io/gh/vardius/pubsub)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvardius%2Fpubsub.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvardius%2Fpubsub?ref=badge_shield)\n[![](https://godoc.org/github.com/vardius/pubsub?status.svg)](https://pkg.go.dev/github.com/vardius/pubsub)\n[![Docker Pulls](https://img.shields.io/docker/pulls/vardius/pubsub.svg)](https://hub.docker.com/r/vardius/pubsub/)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/vardius/pubsub/blob/master/LICENSE.md)\n\n\u003cimg align=\"right\" height=\"180px\" src=\"https://github.com/vardius/gorouter/blob/master/website/src/static/img/logo.png?raw=true\" alt=\"logo\" /\u003e\n\npubsub - gRPC message-oriented middleware on top of [message-bus](https://github.com/vardius/message-bus), event ingestion and delivery system.\n\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n\n\u003c!-- toc --\u003e\n- [About](#about)\n- [How to use](#how-to-use)\n  - [Docker](#docker)\n    - [How to use this image](#how-to-use-this-image)\n    - [Environment Variables](#environment-variables)\n    - [Makefile](#makefile)\n  - [Client](https://github.com/vardius/pubsub/tree/master/proto#client)\n    - [Use in your Go project](https://github.com/vardius/pubsub/tree/master/proto#use-in-your-go-project)\n      - [Publish](https://github.com/vardius/pubsub/tree/master/proto#publish)\n      - [Subscribe](https://github.com/vardius/pubsub/tree/master/proto#subscribe)\n  - [Protocol Buffers](https://github.com/vardius/pubsub/tree/master/proto#protocol-buffers)\n  - [Generating client and server code](https://github.com/vardius/pubsub/tree/master/proto#generating-client-and-server-code)\n\u003c!-- tocstop --\u003e\n\u003c/details\u003e\n\n# 📖 ABOUT\n\n[pubsub](https://github.com/vardius/pubsub) allows you to publish even that is delivered to all subscribed clients. \nSee also [pushpull](https://github.com/vardius/pushpull).\n\nContributors:\n\n- [Rafał Lorenz](http://rafallorenz.com)\n\nWant to contribute ? Feel free to send pull requests!\n\nHave problems, bugs, feature ideas?\nWe are using the github [issue tracker](https://github.com/vardius/pubsub/issues) to manage them.\n\n# 🚏 HOW TO USE\n\n## 🐳 [Docker Hub](https://hub.docker.com/r/vardius/pubsub)\n\nPull image from the command line:\n```bash\n$ docker pull vardius/pubsub:latest\n```\nUse as base image in DockerFile:\n```Dockerfile\nFROM vardius/pubsub:latest\n```\n\n## [Github Package Registry](https://github.com/vardius/pubsub/packages/108226)\n\nPull image from the command line:\n```bash\n$ docker pull docker.pkg.github.com/vardius/pubsub/pubsub:latest\n```\nUse as base image in DockerFile:\n```Dockerfile\nFROM docker.pkg.github.com/vardius/pubsub/pubsub:latest\n```\n\n### How to use this image\n\nStarting a pubsub instance:\n\n```bash\ndocker run --name my-pubsub -e QUEUE_BUFFER_SIZE=100 -d vardius/pubsub:tag\n```\n\n### Environment Variables\n\n#### `HOST` (string)\n\nThis is optional variable, sets gRPC server host value. **Default `0.0.0.0`**\n\n#### `PORT` (int)\n\nThis is optional variable, sets gRPC server port value. **Default `9090`**\n\n#### `QUEUE_BUFFER_SIZE` (int)\n\nThis is optional variable, sets buffered channel length per subscriber. **Default 0**, which evaluates to `runtime.NumCPU()`.\n\n#### `KEEPALIVE_MIN_TIME`\n\nThis is optional variable, if a client pings more than once every **5 minutes (default)**, terminate the connection.\nParseDuration parses a duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`\n\n#### `KEEPALIVE_TIME` (nanoseconds)\n\nThis is optional variable, ping the client if it is idle for **2 hours (default)** to ensure the connection is still active.\nParseDuration parses a duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`\n\n#### `KEEPALIVE_TIMEOUT` (nanoseconds)\n\nThis is optional variable, wait **20 second (default)** for the ping ack before assuming the connection is dead.\nParseDuration parses a duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`\n\n#### `LOG_VERBOSE_LEVEL` (int)\n\nThis is optional variable, Verbose level. `-1` = Disabled, `0` = Critical, `1` = Error, `2` = Warning, `3` = Info, `4` = Debug. **Default 3 (Info)**.\n\n### Makefile\n\n```sh\n➜  pubsub git:(master) make help\nversion                        Show version\ndocker-build                   Build given container. Example: `make docker-build`\ndocker-run                     Run container on given port. Example: `make docker-run PORT=9090`\ndocker-stop                    Stop docker container. Example: `make docker-stop`\ndocker-rm                      Stop and then remove docker container. Example: `make docker-rm`\ndocker-publish                 Docker publish. Example: `make docker-publish REGISTRY=https://your-registry.com`\ndocker-tag                     Tag current container. Example: `make docker-tag REGISTRY=https://your-registry.com`\ndocker-release                 Docker release - build, tag and push the container. Example: `make docker-release REGISTRY=https://your-registry.com`\n```\n\n## Client\n\nSee [proto package](https://github.com/vardius/pubsub/blob/master/proto) for details.\n\n## 📜 [License](LICENSE.md)\n\nThis package is released under the MIT license. See the complete license in the package\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvardius%2Fpubsub.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvardius%2Fpubsub?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvardius%2Fpubsub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvardius%2Fpubsub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvardius%2Fpubsub/lists"}