https://github.com/vardius/pushpull
gRPC message-oriented middleware on top of worker-pool, event ingestion and delivery system.
https://github.com/vardius/pushpull
Last synced: 11 months ago
JSON representation
gRPC message-oriented middleware on top of worker-pool, event ingestion and delivery system.
- Host: GitHub
- URL: https://github.com/vardius/pushpull
- Owner: vardius
- License: mit
- Created: 2020-03-28T06:15:34.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-02T13:05:08.000Z (almost 6 years ago)
- Last Synced: 2025-04-10T19:43:05.804Z (about 1 year ago)
- Language: Go
- Homepage: https://hub.docker.com/r/vardius/pushpull
- Size: 36.1 KB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 📨 pushpull
[](https://travis-ci.org/vardius/pushpull)
[](https://goreportcard.com/report/github.com/vardius/pushpull)
[](https://codecov.io/gh/vardius/pushpull)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fvardius%2Fpushpull?ref=badge_shield)
[](https://pkg.go.dev/github.com/vardius/pushpull)
[](https://hub.docker.com/r/vardius/pushpull/)
[](https://github.com/vardius/pushpull/blob/master/LICENSE.md)
pushpull - gRPC event-oriented middleware on top of [worker-pool](https://github.com/vardius/worker-pool), event ingestion and delivery system.
[pushpull](https://github.com/vardius/pushpull) allows you to push event to queue that later can be pulled by one of clients pulling from that queue. See also [pubsub](https://github.com/vardius/pubsub).
Table of Contents
- [About](#about)
- [How to use](#how-to-use)
- [Docker](#docker)
- [How to use this image](#how-to-use-this-image)
- [Environment Variables](#environment-variables)
- [Makefile](#makefile)
- [Client](https://github.com/vardius/pushpull/tree/master/proto#client)
- [Use in your Go project](https://github.com/vardius/pushpull/tree/master/proto#use-in-your-go-project)
- [Push](https://github.com/vardius/pushpull/tree/master/proto#push)
- [Pull](https://github.com/vardius/pushpull/tree/master/proto#pull)
- [Protocol Buffers](https://github.com/vardius/pushpull/tree/master/proto#protocol-buffers)
- [Generating client and server code](https://github.com/vardius/pushpull/tree/master/proto#generating-client-and-server-code)
# 📖 ABOUT
Contributors:
- [Rafał Lorenz](http://rafallorenz.com)
Want to contribute ? Feel free to send pull requests!
Have problems, bugs, feature ideas?
We are using the github [issue tracker](https://github.com/vardius/pushpull/issues) to manage them.
# 🚏 HOW TO USE
## 🐳 [Docker Hub](https://hub.docker.com/r/vardius/pushpull)
Pull image from the command line:
```bash
$ docker pull vardius/pushpull:latest
```
Use as base image in DockerFile:
```Dockerfile
FROM vardius/pushpull:latest
```
## [Github Package Registry](https://github.com/vardius/pushpull/packages/164794)
Pull image from the command line:
```bash
$ docker pull docker.pkg.github.com/vardius/pushpull/pushpull:latest
```
Use as base image in DockerFile:
```Dockerfile
FROM docker.pkg.github.com/vardius/pushpull/pushpull:latest
```
### How to use this image
Starting a pushpull instance:
```bash
docker run --name my-pushpull -e QUEUE_BUFFER_SIZE=100 -d vardius/pushpull:tag
```
### Environment Variables
#### `HOST` (string)
This is optional variable, sets gRPC server host value. **Default `0.0.0.0`**
#### `PORT` (int)
This is optional variable, sets gRPC server port value. **Default `9090`**
#### `QUEUE_BUFFER_SIZE` (int)
This is optional variable, sets buffered channel length per worker pool. **Default 0**, which evaluates to `runtime.NumCPU()`.
#### `KEEPALIVE_MIN_TIME`
This is optional variable, if a client pings more than once every **5 minutes (default)**, terminate the connection.
ParseDuration 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`
#### `KEEPALIVE_TIME` (nanoseconds)
This is optional variable, ping the client if it is idle for **2 hours (default)** to ensure the connection is still active.
ParseDuration 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`
#### `KEEPALIVE_TIMEOUT` (nanoseconds)
This is optional variable, wait **20 second (default)** for the ping ack before assuming the connection is dead.
ParseDuration 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`
#### `LOG_VERBOSE_LEVEL` (int)
This is optional variable, Verbose level. `-1` = Disabled, `0` = Critical, `1` = Error, `2` = Warning, `3` = Info, `4` = Debug. **Default 3 (Info)**.
### Makefile
```sh
➜ pushpull git:(master) make help
version Show version
docker-build Build given container. Example: `make docker-build`
docker-run Run container on given port. Example: `make docker-run PORT=9090`
docker-stop Stop docker container. Example: `make docker-stop`
docker-rm Stop and then remove docker container. Example: `make docker-rm`
docker-publish Docker publish. Example: `make docker-publish REGISTRY=https://your-registry.com`
docker-tag Tag current container. Example: `make docker-tag REGISTRY=https://your-registry.com`
docker-release Docker release - build, tag and push the container. Example: `make docker-release REGISTRY=https://your-registry.com`
```
## Client
See [proto package](https://github.com/vardius/pushpull/blob/master/proto) for details.
## 📜 [License](LICENSE.md)
This package is released under the MIT license. See the complete license in the package
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fvardius%2Fpushpull?ref=badge_large)