Add real documentation to the README
This commit adds some real documentation to the README, including how events get published and configuration information.
This commit is contained in:
parent
97c78e78ff
commit
f2d79631da
55
README.rst
55
README.rst
|
@ -2,6 +2,59 @@
|
|||
germqtt
|
||||
=======
|
||||
|
||||
Publish a gerrit stream onto MQTT
|
||||
Germqtt, like its name implies, is a tool for publish a gerrit event stream
|
||||
into MQTT. It will publish all the capture events from the gerrit event stream
|
||||
and publish them to MQTT into topics split by project and event type. For
|
||||
example a commented added to a project name foo would be published as an event
|
||||
on the topic: base_topic/foo/commented-added
|
||||
|
||||
By default germqtt is setup as a daemon however if you need to run it
|
||||
interactively you can use the *--foreground* option to do this.
|
||||
|
||||
Configuration
|
||||
=============
|
||||
There are a few required pieces of information to make germqtt work properly.
|
||||
These settings are specified in the config file.
|
||||
|
||||
Gerrit
|
||||
------
|
||||
|
||||
You need to provide credentials and connection information for connecting to
|
||||
gerrit to get the event stream. Germqtt uses the gerritlib library to establish
|
||||
a connection to gerrit over ssh and listen to the event stream. All these
|
||||
options live in the *[gerrit]* section. The 3 required options for gerrit are:
|
||||
|
||||
* **username** - The username to login with
|
||||
* **hostname** - The hostname for your gerrit server
|
||||
* **key** - The path to your ssh key to use for connecting to gerrit
|
||||
|
||||
There is also an optional config option, *port*, which is used to specify the
|
||||
port to connect to gerrit with. By default this is set to 29418, which is the
|
||||
gerrit default. If your gerrit server uses a non-default port you'll need to set
|
||||
this option.
|
||||
|
||||
MQTT
|
||||
----
|
||||
|
||||
Just as with gerrit there are a few required options for talking to MQTT, which
|
||||
is the other axis of communication in germqtt. The options for configuring MQTT
|
||||
communication go in the *[mqtt]* section. The 2 required options are:
|
||||
|
||||
* **hostname** - The hostname for the MQTT broker
|
||||
* **topic** - The base topic name to use for the gerrit events
|
||||
|
||||
There are also a couple optional settings for communicating with mqtt that you
|
||||
can set:
|
||||
|
||||
* **port** - The port to communicate to the MQTT broker on. By default this
|
||||
is set to 1883, the default MQTT port. This only needs to be set
|
||||
if your broker uses a non-default port.
|
||||
* **keepalive** - Used to set the keepalive time for connections to the MQTT
|
||||
broker. By default this is set to 60 seconds.
|
||||
|
||||
Other Settings
|
||||
--------------
|
||||
|
||||
By default germqtt will use /var/run/germqtt.pid for it's PID file, if however
|
||||
you'd like to use a different file for storing the PID you can use the *pidfile*
|
||||
option in the *[default]* section of the configuration file.
|
||||
|
|
Loading…
Reference in New Issue