zuul-preview/README.rst
Jakub Bielecki 986ea056a9 add basic description into README.rst
No code changes, documentation only.

It's unknown what this project is about, so adding a basic example.
I've obtained it only by quickly reverse-engineering main.cc, so please
make sure I've got this correctly(/-ish).

Change-Id: I0976243d363ee6dcb55bd93132b731a65a9734f7
2019-03-11 12:41:10 +01:00

29 lines
704 B
ReStructuredText

============
zuul-preview
============
A preview proxy server for Zuul.
For example, when this http proxy is fed with a ``Host`` header in the form
similar to ``site.167715b656ee4504baa940c5bd9f3821.openstack.preview.opendev.org``
it proxies to the artifact 'site' of the build 167715b656ee4504baa940c5bd9f3821
under tenant 'openstack'. The actual location is determined dynamically by querying
a Zuul API configured by the environment variable ``$ZUUL_API_URL``.
Building
--------
First you need some dependencies:
.. code-block:: bash
python3 -m pip install bindep
apt-get install $(bindep -b compile)
Then you can build the code:
.. code-block:: bash
autoreconf -fi
./configure
make