Browse Source

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
Jakub Bielecki 1 month ago
parent
commit
986ea056a9
1 changed files with 8 additions and 2 deletions
  1. 8
    2
      README.rst

+ 8
- 2
README.rst View File

@@ -2,7 +2,13 @@
2 2
 zuul-preview
3 3
 ============
4 4
 
5
-A preview proxy server for zuul.
5
+A preview proxy server for Zuul.
6
+
7
+For example, when this http proxy is fed with a ``Host`` header in the form
8
+similar to ``site.167715b656ee4504baa940c5bd9f3821.openstack.preview.opendev.org``
9
+it proxies to the artifact 'site' of the build 167715b656ee4504baa940c5bd9f3821
10
+under tenant 'openstack'. The actual location is determined dynamically by querying
11
+a Zuul API configured by the environment variable ``$ZUUL_API_URL``.
6 12
 
7 13
 Building
8 14
 --------
@@ -20,4 +26,4 @@ Then you can build the code:
20 26
 
21 27
   autoreconf -fi
22 28
   ./configure
23
-  make
29
+  make

Loading…
Cancel
Save