Skip to content

Commit 2b3d82b

Browse files
rustatianrustatian
committed
update README
Signed-off-by: Valery Piashchynski <[email protected]>
1 parent def609f commit 2b3d82b

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

‎Makefile‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
test:
22
go test -v -race ./...
3+
34
build:
4-
CGO_ENABLED=0 go build -trimpath -ldflags "-s" -o rr qcmd/rr/main.go
5+
CGO_ENABLED=0 go build -trimpath -ldflags "-s" -o rr cmd/rr/main.go

‎README.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,43 @@ while ($req = $worker->waitRequest()) {
113113
}
114114
```
115115

116+
# Available Plugins:
117+
118+
| Plugin | Description | Latest tag | Go version |
119+
|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------|
120+
| ![](https://img.shields.io/badge/-HTTP-blue) | Provides HTTP, HTTPS, FCGI transports. Extensible with middleware. | ![](https://img.shields.io/github/v/tag/roadrunner-server/http) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/http) |
121+
| ![](https://img.shields.io/badge/-Headers-blue) | HTTP middleware supports constant custom headers and CORS. | ![](https://img.shields.io/github/v/tag/roadrunner-server/headers) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/headers) |
122+
| ![](https://img.shields.io/badge/-GZIP-blue) | HTTP middleware supports `Accept-Encoding`: GZIP. | ![](https://img.shields.io/github/v/tag/roadrunner-server/gzip) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/gzip) |
123+
| ![](https://img.shields.io/badge/-Static-blue) | HTTP middleware serves static files. | ![](https://img.shields.io/github/v/tag/roadrunner-server/static) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/static) |
124+
| ![](https://img.shields.io/badge/-Sendfile-blue) | HTTP middleware handles X-Sendfile headers. | ![](https://img.shields.io/github/v/tag/roadrunner-server/send) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/send) |
125+
| ![](https://img.shields.io/badge/-NewRelic-blue) | HTTP middleware supports NewRelic distributed traces and custom attributes. | ![](https://img.shields.io/github/v/tag/roadrunner-server/new_relic) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/new_relic) |
126+
| ![](https://img.shields.io/badge/-Cache-blue) | HTTP middleware supports RFC7234 cache. | ![](https://img.shields.io/github/v/tag/roadrunner-server/cache) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/cache) |
127+
| ![](https://img.shields.io/badge/-Jobs-blue) | Provides queues support for the RR2 via different drivers | ![](https://img.shields.io/github/v/tag/roadrunner-server/jobs) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/jobs) |
128+
| ![](https://img.shields.io/badge/-AMQP-blue) | Provides AMQP (0-9-1) protocol support via RabbitMQ | ![](https://img.shields.io/github/v/tag/roadrunner-server/amqp) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/amqp) |
129+
| ![](https://img.shields.io/badge/-Beanstalk-blue) | Provides [beanstalkd](https://github.com/beanstalkd/beanstalkd) queue support | ![](https://img.shields.io/github/v/tag/roadrunner-server/beanstalk) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/beanstalk) |
130+
| ![](https://img.shields.io/badge/-Boltdb-blue) | Provides support for the [BoltDB](https://github.com/etcd-io/bbolt) key/value store. Used in the `Jobs` and `KV` | ![](https://img.shields.io/github/v/tag/roadrunner-server/boltdb) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/boltdb) |
131+
| ![](https://img.shields.io/badge/-SQS-blue) | SQS driver for the jobs | ![](https://img.shields.io/github/v/tag/roadrunner-server/sqs) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/sqs) |
132+
| ![](https://img.shields.io/badge/-NATS-blue) | NATS jobs driver | ![](https://img.shields.io/github/v/tag/roadrunner-server/nats) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/nats) |
133+
| ![](https://img.shields.io/badge/-KV-blue) | Provides key-value support for the RR2 via different drivers | ![](https://img.shields.io/github/v/tag/roadrunner-server/kv) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/kv) |
134+
| ![](https://img.shields.io/badge/-Memcached-blue) | Memcached driver for the kv | ![](https://img.shields.io/github/v/tag/roadrunner-server/memcached) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/memcached) |
135+
| ![](https://img.shields.io/badge/-Memory-blue) | Memory driver for the jobs, kv, broadcast | ![](https://img.shields.io/github/v/tag/roadrunner-server/memory) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/memory) |
136+
| ![](https://img.shields.io/badge/-Redis-blue) | Redis driver for the kv, broadcast | ![](https://img.shields.io/github/v/tag/roadrunner-server/redis) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/redis) |
137+
| ![](https://img.shields.io/badge/-Config-blue) | Provides configuration parsing support to the all plugins | ![](https://img.shields.io/github/v/tag/roadrunner-server/config) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/config) |
138+
| ![](https://img.shields.io/badge/-GRPC-blue) | Provides GRPC support | ![](https://img.shields.io/github/v/tag/roadrunner-server/grpc) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/grpc) |
139+
| ![](https://img.shields.io/badge/-Informer-blue) | Provides statistic grabbing capabilities (workers,jobs stat) | ![](https://img.shields.io/github/v/tag/roadrunner-server/informer) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/informer) |
140+
| ![](https://img.shields.io/badge/-Broadcast-blue) | Provides broadcasting capabilities to the RR2 via different drivers | ![](https://img.shields.io/github/v/tag/roadrunner-server/broadcast) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/broadcast) |
141+
| ![](https://img.shields.io/badge/-Logger-blue) | Central logger plugin. Implemented via Uber.zap logger, but supports other loggers. | ![](https://img.shields.io/github/v/tag/roadrunner-server/logger) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/logger) |
142+
| ![](https://img.shields.io/badge/-Metrics-blue) | Provides support for the metrics via [Prometheus](https://prometheus.io/) | ![](https://img.shields.io/github/v/tag/roadrunner-server/metrics) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/metrics) |
143+
| ![](https://img.shields.io/badge/-Reload-blue) | Reloads workers on the file changes. Use only for the development | ![](https://img.shields.io/github/v/tag/roadrunner-server/reload) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/reload) |
144+
| ![](https://img.shields.io/badge/-Resetter-blue) | Provides support for the `./rr reset` command. Reloads workers pools | ![](https://img.shields.io/github/v/tag/roadrunner-server/resetter) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/resetter) |
145+
| ![](https://img.shields.io/badge/-RPC-blue) | Provides support for the RPC across all plugins. Collects `RPC() interface{}` methods and exposes them via RPC | ![](https://img.shields.io/github/v/tag/roadrunner-server/rpc) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/rpc) |
146+
| ![](https://img.shields.io/badge/-Server-blue) | Provides support for the command. Prepare PHP processes | ![](https://img.shields.io/github/v/tag/roadrunner-server/server) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/server) |
147+
| ![](https://img.shields.io/badge/-Service-blue) | Provides support for the external scripts, binaries which might be started like a service (behaves similar to the systemd services) | ![](https://img.shields.io/github/v/tag/roadrunner-server/service) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/service) |
148+
| ![](https://img.shields.io/badge/-Status-blue) | Provides support for the health and readiness checks | ![](https://img.shields.io/github/v/tag/roadrunner-server/status) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/status) |
149+
| ![](https://img.shields.io/badge/-Websockets-blue) | Provides support for the broadcasting events via websockets | ![](https://img.shields.io/github/v/tag/roadrunner-server/websockets) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/websockets) |
150+
| ![](https://img.shields.io/badge/-TCP-blue) | Provides support for the raw TCP payloads and TCP connections | ![](https://img.shields.io/github/v/tag/roadrunner-server/tcp) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/tcp) |
151+
| ![](https://img.shields.io/badge/-Fileserver-blue) | File server to handle static files | ![](https://img.shields.io/github/v/tag/roadrunner-server/fileserver) | ![](https://img.shields.io/github/go-mod/go-version/roadrunner-server/fileserver) |
152+
116153
Run:
117154
----
118155
To run application server:

0 commit comments

Comments
 (0)