Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add Docker build and run information.
  • Loading branch information
Michael Pratt authored Nov 18, 2016
1 parent 1c140e1 commit 6f66943
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ After cloning the repository, building should just be a matter of running a stan
$ mvn clean package
```

## Running
## Running Stand Alone

The build process creates an executable JAR file.

Expand All @@ -29,3 +29,25 @@ Then open a browser and navigate to http://localhost:9000. The port can be overr
```
--server.port=<port>
```

## Running with Docker

The following maven command will generate a Docker image:

```
mvn clean package assembly:single docker:build
```

Note for Mac Users: You need to convert newline formatting of the kafdrop.sh file *before* running this command:

```
dos2unix src/main/docker/*
```

Once the build finishes you can launch the image as follows:

```
docker run -d -p 9000:9000 -e ZOOKEEPER_CONNECT=<host:port,host:port> kafdrop
```

And access the UI at http://localhost:9000.

0 comments on commit 6f66943

Please sign in to comment.