From 7c31e9544d325bfc869cba1d15cbc57f1d6a9aff Mon Sep 17 00:00:00 2001
From: "Chris St. Pierre" <chris.a.st.pierre@gmail.com>
Date: Thu, 19 Jul 2012 17:18:57 -0400
Subject: added CherryPy-based server core

---
 doc/server/backends.txt | 44 ++++++++++++++++++++++++++++++++++++++++++++
 doc/server/index.txt    |  1 +
 2 files changed, 45 insertions(+)
 create mode 100644 doc/server/backends.txt

(limited to 'doc/server')

diff --git a/doc/server/backends.txt b/doc/server/backends.txt
new file mode 100644
index 000000000..49bfe3b96
--- /dev/null
+++ b/doc/server/backends.txt
@@ -0,0 +1,44 @@
+.. -*- mode: rst -*-
+
+.. _server-backends:
+
+========
+Backends
+========
+
+.. versionadded:: 1.3.0
+
+Bcfg2 supports two different server backends: a builtin server
+based on the Python SimpleXMLRPCServer object, and a server that uses
+CherryPy (http://www.cherrypy.org).  Each one has advantages and
+disadvantages.
+
+The builtin server:
+
+* Is very stable and mature;
+* Supports certificate authentication;
+* Works on Python 2.4;
+* Is slow with larger numbers of clients.
+
+The CherryPy server:
+
+* Is very new and potentially buggy;
+* Does not support certificate authentication, only password
+  authentication;
+* Requires CherryPy 3.2, which requires Python 2.5;
+* Is faster with large numbers of clients.
+
+Basically, the builtin server should be used unless you have a
+particular need for performance, and can sacrifice certificate
+authentication.
+
+To select which backend to use, set the ``backend`` option in the
+``[server]`` section of ``/etc/bcfg2.conf``.  Options are:
+
+* ``cherrypy``
+* ``builtin``
+* ``best`` (the default; currently the same as ``builtin``)
+
+If the certificate authentication issues (a limitation in CherryPy
+itself) can be resolved and the CherryPy server proves to be stable,
+it will likely become the default (and ``best``) in a future release.
diff --git a/doc/server/index.txt b/doc/server/index.txt
index fb1c95444..6c2b7b889 100644
--- a/doc/server/index.txt
+++ b/doc/server/index.txt
@@ -29,3 +29,4 @@ clients.
    snapshots/index
    bcfg2-info
    selinux
+   backends
-- 
cgit v1.2.3-1-g7c22