From df708b46d5b063be76a05827e848f06581c3a17f Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Jul 28 2015 12:47:53 +0000 Subject: Add documentation on how to install pagure's eventsource server --- diff --git a/doc/Install_evs.rst b/doc/Install_evs.rst new file mode 100644 index 0000000..bcce802 --- /dev/null +++ b/doc/Install_evs.rst @@ -0,0 +1,40 @@ +Installing pagure's EventSource server +====================================== + +Eventsource or Server Sent Events are messages sent from a server to a web +browser. It allows to refresh a page "live", ie, without the need to reload +it entirely. + + +Configure your system +--------------------- + +The eventsource server is easy to set-up. + +* Installed the required dependencies + +:: + + python-redis + python-trollius + python-trollius-redis + systemd + +..note: This last one is necessary if you want to use the service file provided. + Otherwise, you will have to write your own. + +* Install the files of the SSE server as follow: + ++----------------------------------------+-----------------------------------------------------+ +| Source | Destination | ++========================================+=====================================================+ +| ``ev-server/pagure-stream-server.py`` | ``/usr/libexec/pagure-ev/pagure-stream-server.py`` | ++----------------------------------------+-----------------------------------------------------+ +| ``ev-server/pagure_ev.service`` | ``/usr/lib/systemd/system/pagure_ev.service`` | ++----------------------------------------+-----------------------------------------------------+ + +* Finally, activate the service and ensure it's started upon boot: +:: + + systemctl enable pagure_ev + systemctl start pagure_ev