[tor-commits] [flashproxy/master] - move doc to more relevant place, move AC_CONFIG_FILES to bottom as standard

[infinity0 at torproject.org]

commit d071b3362a305e1a3e33c24b69b76bf1bbaf9eb6
Author: Ximin Luo <infinity0 at gmx.com>
Date:   Wed Oct 9 15:13:41 2013 +0100

    - move doc to more relevant place, move AC_CONFIG_FILES to bottom as standard
---
 facilitator/README                    |   35 +++++++++++++++++++++++++++++++
 facilitator/configure.ac              |   10 ++++-----
 facilitator/doc/facilitator-howto.txt |   37 +--------------------------------
 3 files changed, 41 insertions(+), 41 deletions(-)

diff --git a/facilitator/README b/facilitator/README
index 81b44d5..49f17ce 100644
--- a/facilitator/README
+++ b/facilitator/README
@@ -8,3 +8,38 @@ integrate this package into its repositories.)
 
 For instructions on setting up and running the facilitator, see
 doc/facilitator-howto.txt.
+
+== Overview
+
+The facilitator consists of a backend server that is essentially a
+dynamic database of client addresses, as well as helper programs that
+receive client registrations from the Internet over various means and
+pass them to the backend. There are three supported helper rendezvous
+methods: HTTP, URL, and email.
+
+The HTTP rendezvous uses an HTTP server and a CGI program. The HTTP
+server is responsible for speaking TLS and invoking the CGI program. The
+CGI program receives client registrations and proxy requests for
+clients, parses them, and forwards them to the backend. We use Apache 2
+as the HTTP server. The CGI script is facilitator.cgi. The backend is
+facilitator.
+
+The email rendezvous uses the helper program facilitator-email-poller.
+Clients use the flashproxy-reg-email program to send an encrypted
+message to a Gmail address. The poller constantly checks for new
+messages and forwards them to facilitator-reg.
+
+facilitator-reg is a simple program that forwards its standard input to
+a locally running facilitator-reg-daemon process.
+
+facilitator-reg-daemon accepts connections containing encrypted client
+registrations and forwards them to the facilitator. It exists as a
+process of its own so that only one program requires access to the
+facilitator's private key.
+
+The URL rendezvous uses the helper program flashproxy-reg-email. The
+helper program doesn't actually make a registration; rather, it prints
+out a URL which, when retrieved, makes the registration.
+
+fac.py is a Python module containing code common to the various
+facilitator programs.
diff --git a/facilitator/configure.ac b/facilitator/configure.ac
index 3542238..4bab528 100644
--- a/facilitator/configure.ac
+++ b/facilitator/configure.ac
@@ -5,11 +5,6 @@ AM_INIT_AUTOMAKE([-Wall -Werror foreign])
 AC_ARG_VAR(fpfacilitatoruser, [the user/group for the facilitator to run as])
 fpfacilitatoruser="${fpfacilitatoruser:-flashproxy-fac}"
 
-AC_CONFIG_FILES([Makefile
-	init.d/facilitator
-	init.d/facilitator-email-poller
-	init.d/facilitator-reg-daemon])
-
 AC_PROG_LN_S
 AM_PATH_PYTHON
 
@@ -22,4 +17,9 @@ AC_ARG_ENABLE([initscripts],
 	[do_initscripts=yes], [do_initscripts=])
 AM_CONDITIONAL([DO_INITSCRIPTS], [test "x$do_initscripts" = xyes])
 
+AC_CONFIG_FILES([Makefile
+	init.d/facilitator
+	init.d/facilitator-email-poller
+	init.d/facilitator-reg-daemon])
+
 AC_OUTPUT
diff --git a/facilitator/doc/facilitator-howto.txt b/facilitator/doc/facilitator-howto.txt
index 3a853ef..7cd2f78 100644
--- a/facilitator/doc/facilitator-howto.txt
+++ b/facilitator/doc/facilitator-howto.txt
@@ -1,41 +1,6 @@
-This document describes how to run a flash proxy facilitator on Debian 7.
+This document describes how to configure a flash proxy facilitator on Debian 7.
 We will use the domain name fp-facilitator.example.com.
 
-== Overview
-
-The facilitator consists of a backend server that is essentially a
-dynamic database of client addresses, as well as helper programs that
-receive client registrations from the Internet over various means and
-pass them to the backend. There are three supported helper rendezvous
-methods: HTTP, URL, and email.
-
-The HTTP rendezvous uses an HTTP server and a CGI program. The HTTP
-server is responsible for speaking TLS and invoking the CGI program. The
-CGI program receives client registrations and proxy requests for
-clients, parses them, and forwards them to the backend. We use Apache 2
-as the HTTP server. The CGI script is facilitator.cgi. The backend is
-facilitator.
-
-The email rendezvous uses the helper program facilitator-email-poller.
-Clients use the flashproxy-reg-email program to send an encrypted
-message to a Gmail address. The poller constantly checks for new
-messages and forwards them to facilitator-reg.
-
-facilitator-reg is a simple program that forwards its standard input to
-a locally running facilitator-reg-daemon process.
-
-facilitator-reg-daemon accepts connections containing encrypted client
-registrations and forwards them to the facilitator. It exists as a
-process of its own so that only one program requires access to the
-facilitator's private key.
-
-The URL rendezvous uses the helper program flashproxy-reg-email. The
-helper program doesn't actually make a registration; rather, it prints
-out a URL which, when retrieved, makes the registration.
-
-fac.py is a Python module containing code common to the various
-facilitator programs.
-
 == Basic and security setup
 
 Install some essential packages and configure a firewall.