From 9f4ba7da6e4a227b9141552cd8c475a227dd0366 Mon Sep 17 00:00:00 2001 From: Ben Johnston Date: Wed, 21 Nov 2018 09:45:40 +1100 Subject: [PATCH] Update to README.rst with some additional information regarding phabricator hooks --- README.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index c438d6f..dcfa970 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,9 @@ 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 ------------- @@ -13,26 +15,28 @@ lugito can be installed via Pyp * 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 ------------------------- -.. code:: +.. code:: [phabricator] host = http://127.0.0.1:9091/api/ token = api-nojs2ip33hmp4zn6u6cf72w7d6yh - + [phabricator.hooks] irc = cqg42zdcuqysff632kc6rnsu4m3hjg6c commithook = znkyfflbcia5gviqx5ybad7s6uyfywxi - + [connector.irc] host = irc.freenode.net port = 6697 username = someusername password = somepassword channel = #somechannel - + [connector.launchpad] application = lugito staging = production @@ -42,7 +46,7 @@ Temp - Example .lugitorc Bionic Xenial Trusty - + [connector.launchpad.package_names] rDEFAULTSETTINGS = lubuntu-default-settings rART = lubuntu-artwork