install_webhooks.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. Installing pagure's web-hooks notification system
  2. =================================================
  3. Web-hooks are a notification system upon which a system makes a http POST
  4. request with some data upon doing an action. This allows notifying a system
  5. that an action has occured.
  6. If you want more information feel free to check out the corresponding page
  7. on wikipedia: `https://en.wikipedia.org/wiki/Webhook
  8. <https://en.wikipedia.org/wiki/Webhook>`_.
  9. Configure your system
  10. ---------------------
  11. * Install the required dependencies
  12. ::
  13. python-redis
  14. python-trollius
  15. python-trollius-redis
  16. .. note:: We ship a systemd unit file for pagure_webhook but we welcome patches
  17. for scripts for other init systems.
  18. * Install the files of the web-hook server as follow:
  19. +----------------------------------------------+----------------------------------------------------------+
  20. | Source | Destination |
  21. +==============================================+==========================================================+
  22. | ``webhook-server/pagure-webhook-server.py`` | ``/usr/libexec/pagure-webhook/pagure-webhook-server.py`` |
  23. +----------------------------------------------+----------------------------------------------------------+
  24. | ``webhook-server/pagure_webhook.service`` | ``/etc/systemd/system/pagure_webhook.service`` |
  25. +----------------------------------------------+----------------------------------------------------------+
  26. The first file is the script of the web-hook server itself.
  27. The second file is the systemd service file.
  28. * Activate the service and ensure it's started upon boot:
  29. ::
  30. systemctl enable redis
  31. systemctl start redis
  32. systemctl enable pagure_webhook
  33. systemctl start pagure_webhook