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
This commit is contained in:
parent
4db7857bc5
commit
986ea056a9
10
README.rst
10
README.rst
|
@ -2,7 +2,13 @@
|
||||||
zuul-preview
|
zuul-preview
|
||||||
============
|
============
|
||||||
|
|
||||||
A preview proxy server for zuul.
|
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
|
Building
|
||||||
--------
|
--------
|
||||||
|
@ -20,4 +26,4 @@ Then you can build the code:
|
||||||
|
|
||||||
autoreconf -fi
|
autoreconf -fi
|
||||||
./configure
|
./configure
|
||||||
make
|
make
|
Loading…
Reference in New Issue