From 499dad90eec78b29a4e3420485e9dcb64c796325 Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Aug 11 2016 08:44:49 +0000
Subject: Add a documentation on how to install pagure-ci


---

diff --git a/doc/index.rst b/doc/index.rst
index 268c3e3..3daea4c 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -34,6 +34,7 @@ Contents:
    install_milter
    install_evs
    install_webhooks
+   install_pagure_ci
    configuration
    development
    usage
diff --git a/doc/install_pagure_ci.rst b/doc/install_pagure_ci.rst
new file mode 100644
index 0000000..a1158e5
--- /dev/null
+++ b/doc/install_pagure_ci.rst
@@ -0,0 +1,61 @@
+Installing pagure-ci
+====================
+
+A CI stands for `Continuous Integration
+<https://en.wikipedia.org/wiki/Continuous_integration>`_. Pagure can be
+configured to integrate results coming from CI services, such as `Jenkins
+<https://en.wikipedia.org/wiki/Jenkins_(software)>`_ on pull-request opened
+against the project.
+
+
+.. note: Currently, pagure only supports `Jenkins` but we welcome help to
+  integrate pagure with other services such as `travis-ci
+  <https://en.wikipedia.org/wiki/Travis_CI>`_.
+
+
+Configure your system
+---------------------
+
+* Install the required dependencies
+
+::
+
+    python-jenkins
+    python-redis
+    python-trollius-redis
+    python-trollius
+
+.. note:: We ship a systemd unit file for pagure_ci but we welcome patches
+        for scripts for other init systems.
+
+
+* Install the files of pagure-ci as follow:
+
++--------------------------------------+---------------------------------------------------+
+|              Source                  |                   Destination                     |
++======================================+===================================================+
+| ``pagure-ci/pagure_ci_server.py``    | ``/usr/libexec/pagure-ci/pagure_ci_server.py``    |
++--------------------------------------+---------------------------------------------------+
+| ``pagure-ci/pagure_ci.service``      | ``/etc/systemd/system/pagure_ci.service``         |
++--------------------------------------+---------------------------------------------------+
+
+The first file is the pagure-ci service itself, triggering the build on the
+CI service when there is a new pull-request or a change to an existing one.
+
+The second file is the systemd service file.
+
+* Configure your pagure instance to support CI, add the following to your
+  configuration file
+
+::
+
+    PAGURE_CI_SERVICES = ['jenkins']
+
+* Activate the service and ensure it's started upon boot:
+
+::
+
+    systemctl enable redis
+    systemctl start redis
+    systemctl enable pagure_ci
+    systemctl start pagure_ci