diff --git a/doc/Install_evs.rst b/doc/Install_evs.rst deleted file mode 100644 index 4d2c4ad..0000000 --- a/doc/Install_evs.rst +++ /dev/null @@ -1,46 +0,0 @@ -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. - -* Install the required dependencies -:: - - python-redis - python-trollius - python-trollius-redis - -..note: We ship a systemd unit file for pagure_milter but we welcome patches - for scripts for other init systems. - - -* 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`` | ``/etc/systemd/system/pagure_ev.service`` | -+----------------------------------------+-----------------------------------------------------+ - -The first file is the script of the SSE server itself. - -The second file is the systemd service file. - - -* Finally, activate the service and ensure it's started upon boot: -:: - - systemctl enable redis - systemctl start redis - systemctl enable pagure_ev - systemctl start pagure_ev diff --git a/doc/install_evs.rst b/doc/install_evs.rst new file mode 100644 index 0000000..4d2c4ad --- /dev/null +++ b/doc/install_evs.rst @@ -0,0 +1,46 @@ +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. + +* Install the required dependencies +:: + + python-redis + python-trollius + python-trollius-redis + +..note: We ship a systemd unit file for pagure_milter but we welcome patches + for scripts for other init systems. + + +* 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`` | ``/etc/systemd/system/pagure_ev.service`` | ++----------------------------------------+-----------------------------------------------------+ + +The first file is the script of the SSE server itself. + +The second file is the systemd service file. + + +* Finally, activate the service and ensure it's started upon boot: +:: + + systemctl enable redis + systemctl start redis + systemctl enable pagure_ev + systemctl start pagure_ev