Skip to content

Commit

Permalink
Add installation steps
Browse files Browse the repository at this point in the history
  • Loading branch information
mbhamra authored Sep 26, 2019
1 parent f648c9f commit a6060a7
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ Continue keep running consumers in background in php.

PHP daemon for kafka consumers

## What is Kafka Manager and use ?

We need to keep running consumers for long time. Continue keep running any php file is very big task. We need to create many files with same code for every topic consumer. To reduce same code redundancy we create a manager which manage topic consumers with same code base. So you can focus on your business logic.

By using of this kafka manager, all you need to do is write the code that actually does the work and not all the repetitive worker setup. Just need to create files in specific directory. All files located in specified directory called as worker to consume messages from specific topic.

## Pre Requisites

- PHP 5.6 (Tested with PHP 7)
Expand All @@ -11,11 +17,12 @@ PHP daemon for kafka consumers
- Install librdkafka (https://github.com/edenhill/librdkafka)
- Install rdkafka (https://arnaud.le-blanc.net/php-rdkafka/phpdoc/rdkafka.setup.html)

## What is Kafka Manager and use ?

We need to keep running consumers for long time. Continue keep running any php file is very big task. We need to create many files with same code for every topic consumer. To reduce same code redundancy we create a manager which manage topic consumers with same code base. So you can focus on your business logic.
## Installation Steps

By using of this kafka manager, all you need to do is write the code that actually does the work and not all the repetitive worker setup. Just need to create files in specific directory. All files located in specified directory called as worker to consume messages from specific topic.
Run following command with root user
```
sh install/install.sh
```

## How it works ?

Expand Down Expand Up @@ -75,4 +82,4 @@ Enjoy your code. :)

##

Thanks for using kafka manager and help us to make this perfect.
Thanks for using kafka manager and help us to make this perfect.

0 comments on commit a6060a7

Please sign in to comment.