JOH README
Copyright (C) 2011 Sergey Poznyakoff
See the end of file for copying conditions.

* Introduction

This file contains brief information about configuring, testing
and running JOH.  It is *not* intended as a replacement for
documentation.  The JOH documentation is available in Texinfo format.
To read it without installing the package run `info -f doc/joh.info'.
After installation, the documentation can be accessed via
`info joh'. 

* Overview

JOH stands for Jabber Over HTTP transport.  It enables access to a Jabber
server from behind firewalls which do not allow outgoing sockets on port 5222.
Version 1.0 of the package implements HTTP polling (XEP-0025).  Support for
BOSH (XEP-0124) will be added later.

The system consists of two components:

** johd

Main daemon program, which keeps a table of current sessions and is responsible
for interaction with the XMPP and HTTP servers.

** joh.cgi

An auxiliary CGI interface for use in cases when it is impossible to have
johd listen for HTTP requests directly, because port 80 is already in use
by an HTTP server. 

Joh.cgi receives HTTP POST requests, parses and forwards them to johd for
further handling. When the latter responds, joh.cgi converts the reply to
HTTP and hands it back to the caller.

* Configuring and Installing

Normal procedures apply:

  ./configure
  make
  make install
  
See the INSTALL file for generic installation instructions. So far the only
JOH-specific option to configure is --with-tcp-wrappers, which is on by
default anyway.

The johd daemon is installed in sbindir (normally, $prefix/sbin). The
joh.cgi is installed in libexecdir (normally, $prefix/libexecdir). You
may wish to install it in your cgi-bin directory, e.g.:

  ./configure --libexecdir=/var/www/cgi-bin

* Bug reporting

Please report bugs and send suggestions to <gray+joh@gnu.org.ua>.


* Copyright information:

Copyright (C) 2011 Sergey Poznyakoff

   Permission is granted to anyone to make or distribute verbatim copies
   of this document as received, in any medium, provided that the
   copyright notice and this permission notice are preserved,
   thus giving the recipient permission to redistribute in turn.

   Permission is granted to distribute modified versions
   of this document, or of portions of it,
   under the above conditions, provided also that they
   carry prominent notices stating who last changed them.


Local Variables:
mode: outline
paragraph-separate: "[ 	]*$"
version-control: never
End:
