Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
al66 committed Jun 30, 2019
1 parent 3f6a008 commit 5b1b2b9
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Expand Up @@ -4,5 +4,51 @@

[Moleculer](https://github.com/moleculerjs/moleculer) service for persistent event queue with Kafka

## Installation
```
$ npm install imicros-events --save
```
## Dependencies
Requires a running [Kafka](https://kafka.apache.org/) broker - [docker example](#docker).

# Usage



# Docker
## Kafka/Zookeeper example
```
version: '2'
services:
zookeeper:
image: wurstmeister/zookeeper
container_name: zookeeper
ports:
- "2181:2181"
networks:
- kafka
kafka:
image: wurstmeister/kafka
container_name: kafka
ports:
- "9092:9092"
links:
- zookeeper
environment:
# KAFKA_ADVERTISED_HOST_NAME: ${HOST_IP}
KAFKA_ADVERTISED_HOST_NAME: 192.168.2.124
# KAFKA_ADVERTISED_HOST_NAME: ${DOCKER_KAFKA_HOST}
KAFKA_ADVERTISED_PORT: 9092
# KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://${HOST_IP}:${DOCKER_KAFKA_PORT}
KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://192.168.2.124:9092
KAFKA_CREATE_TOPICS: "events:1:1"
KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'true'
volumes:
- /var/run/docker.sock:/var/run/docker.sock
networks:
- kafka
networks:
kafka:
external: true
```

0 comments on commit 5b1b2b9

Please sign in to comment.