Add docs for web server component
Change-Id: I8e23494e86ad0c9aa2bd074c0e19813be774b4fe
diff --git a/doc/source/admin/components.rst b/doc/source/admin/components.rst
index a24b833..26a85b2 100644
--- a/doc/source/admin/components.rst
+++ b/doc/source/admin/components.rst
@@ -323,3 +323,41 @@
To enable or disable running Ansible in verbose mode (with the '-vvv'
argument to ansible-playbook) run ``zuul-executor verbose`` and
``zuul-executor unverbose``.
+
+Web Server
+----------
+
+The Zuul web server currently acts as a websocket interface to live log
+streaming. Eventually, it will serve as the single process handling all
+HTTP interactions with Zuul.
+
+Configuration
+~~~~~~~~~~~~~
+
+In addition to the ``gearman`` common configuration section, the following
+sections of **zuul.conf** are used by the web server:
+
+web
+"""
+
+**listen_address**
+ IP address or domain name on which to listen (default: 127.0.0.1).
+ ``listen_address=127.0.0.1``
+
+**log_config**
+ Path to log config file for the web server process.
+ ``log_config=/etc/zuul/logging.yaml``
+
+**pidfile**
+ Path to PID lock file for the web server process.
+ ``pidfile=/var/run/zuul-web/zuul-web.pid``
+
+**port**
+ Port to use for web server process.
+ ``port=9000``
+
+Operation
+~~~~~~~~~
+
+To start the web server, run ``zuul-web``. To stop it, kill the
+PID which was saved in the pidfile specified in the configuration.
diff --git a/doc/source/admin/quick-start.rst b/doc/source/admin/quick-start.rst
index 9993775..77dee4a 100644
--- a/doc/source/admin/quick-start.rst
+++ b/doc/source/admin/quick-start.rst
@@ -33,6 +33,9 @@
merger if dedicated mergers are not provided. One or more of
these must be run.
+ - **zuul-web**: A web server that currently provides websocket access to
+ live-streaming of logs.
+
- **gearman**: optional builtin gearman daemon provided by zuul-scheduler
External components: