Update to README.rst with some additional information regarding phabricator hooks

pull/1/head
Ben Johnston 6 years ago
parent e445368ef9
commit 9f4ba7da6e
No known key found for this signature in database
GPG Key ID: 63E9F49BEDEC573D

@ -2,7 +2,9 @@
lugito lugito
====== ======
lugito is a Python package that provides a webserver for connecting updates from Phabricator to communication tools such as irc and other services such as launchpad. .. _Lubuntu Project: https://lubuntu.me/
lugito is a Python package that provides a webserver for connecting updates from Phabricator to communication tools such as irc and other services such as launchpad. Lugito was developed within `Lubuntu Project`_ for use as an irc bot.
Installation Installation
------------- -------------
@ -13,26 +15,28 @@ lugito can be installed via Pyp
* Free software: 3 Clause BSD license * Free software: 3 Clause BSD license
* Note the params in the phabricator.hooks are the webhook endpoints defined within Herald in Phabricator and the values are the corresponding HMAC values
Temp - Example .lugitorc Temp - Example .lugitorc
------------------------- -------------------------
.. code:: .. code::
[phabricator] [phabricator]
host = http://127.0.0.1:9091/api/ host = http://127.0.0.1:9091/api/
token = api-nojs2ip33hmp4zn6u6cf72w7d6yh token = api-nojs2ip33hmp4zn6u6cf72w7d6yh
[phabricator.hooks] [phabricator.hooks]
irc = cqg42zdcuqysff632kc6rnsu4m3hjg6c irc = cqg42zdcuqysff632kc6rnsu4m3hjg6c
commithook = znkyfflbcia5gviqx5ybad7s6uyfywxi commithook = znkyfflbcia5gviqx5ybad7s6uyfywxi
[connector.irc] [connector.irc]
host = irc.freenode.net host = irc.freenode.net
port = 6697 port = 6697
username = someusername username = someusername
password = somepassword password = somepassword
channel = #somechannel channel = #somechannel
[connector.launchpad] [connector.launchpad]
application = lugito application = lugito
staging = production staging = production
@ -42,7 +46,7 @@ Temp - Example .lugitorc
Bionic Bionic
Xenial Xenial
Trusty Trusty
[connector.launchpad.package_names] [connector.launchpad.package_names]
rDEFAULTSETTINGS = lubuntu-default-settings rDEFAULTSETTINGS = lubuntu-default-settings
rART = lubuntu-artwork rART = lubuntu-artwork

Loading…
Cancel
Save