Skip to content

Commit ce5ee21

Browse files
author
Ben Osheroff
committed
add configuration notes
1 parent 75fdff9 commit ce5ee21

File tree

1 file changed

+32
-6
lines changed

1 file changed

+32
-6
lines changed

Diff for: docs/docs/config.md

+32-6
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,38 @@ Maxwell can be configured by command line or a java "properties" file.
66

77
### Command line options
88

9-
option | description
10-
------------- | -----------
11-
--user | mysql username
12-
--password | mysql password
13-
--host | mysql host
14-
--port | mysql port
9+
option | description
10+
------------------------------- | -----------
11+
--user USER | mysql username
12+
--password PASSWORD | mysql password
13+
--host HOST | mysql host
14+
--port PORT | mysql port
15+
--producer stdout,kafka | where shall we send these rows, sir?
16+
--kafka.bootstrap.servers | list of kafka nodes, listed as HOST:PORT[,HOST:PORT]
17+
18+
### Configuration file options
19+
20+
If maxwell finds the file "config.properties" in $PWD it will use it.
21+
22+
option | description
23+
----------------------------- | -----------
24+
user=USER | mysql username
25+
password=PASSWORD | mysql password
26+
host=HOST | mysql host
27+
port=PORT | mysql port
28+
producer=stdout,kafka, | where shall we send these rows, sir?
29+
kafka.*=XXX | any options prefixed with 'kafka.' will be passed into the kafak proucer library
30+
31+
32+
### Kafka options
33+
34+
Any options in the configuration file prefixed with "kafka." have that prefix stripped off, and passed directly
35+
into the "new producer" configuration, as desribed here: [http://kafka.apache.org/documentation.html#newproducerconfigs](http://kafka.apache.org/documentation.html#newproducerconfigs)
36+
37+
Maxwell sets the following options by default, but you can override them in config.properties.
38+
39+
- (kafka.)acks = 1
40+
- (kafka.)compression.type = gzip
1541

1642

1743
<script>

0 commit comments

Comments
 (0)