.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "POSTGRESQL-RELAY 8"
.TH POSTGRESQL-RELAY 8 "November 22, 2004" "November 22, 2004" "General Commands Manual"
.SH "NAME"
\&\fBpostgresql\-relay\fR \- multiplex all your databases to one point of origin
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBpostgresql-relay\fR [\fBoptions\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBpostgresql-relay\fR can be used to as a single point of origin for
all your databases. Instead of having to remember (or modify in
case of changes) all the names of your databases, on which machines
and on which ports they are running, you only need to remember one
machine and the name of the database. The \fBpostgresql-relay\fR will
then forward the connection to the proper database on the proper
port of the proper server. No more changes in the hundreds of clients
and scripts!
.PP
Options are:
.IP "\fB\-c configurationfile\fR" 8
.IX Item "-c configurationfile"
Use this configuration file instead of \fI/usr/local/etc/postgresql\-relay.conf\fR.
.IP "\fB\-f\fR" 8
.IX Item "-f"
Stay in the foreground, don't daemonize. The logging will be printed
to stdout too.
.IP "\fB\-q\fR" 8
.IX Item "-q"
Be quiet, don't log anything
.IP "\fB\-v\fR" 8
.IX Item "-v"
Be verbose, log a lot.
.SH "CONFIGURATION FILE"
.IX Header "CONFIGURATION FILE"
Each line in the configuration file has five fields, seperated by colons:
.Sp
The first field is the incoming port for clients. For the easiest
configuration on the client\-side, keep this all the same (say port
5432 as the standard postgresql port).
.Sp
The second field is the name of the database the client wants to
connect to. This doesn't have to be the name of the database on the
server connecting to.
.Sp
The third field is the name of the host the database is located on.
.Sp
The fourth field is the port the database is listening on.
.Sp
The fifth field is the name of the database to connect to.
.Sh "\s-1CONFIGURATION\s0 \s-1FILE\s0 \s-1EXAMPLES\s0"
.IX Subsection "CONFIGURATION FILE EXAMPLES"
Say you have two databases, one named mail on the local machine on
port 5444 and one named users on the machine foo on port 5445. The
configuration file would then be:
.Sp
.Vb 2
\& 5432:mail:localhost:5444:mail
\& 5432:users:foo:5445:users
.Ve
.Sp
With this configuration, Postgresql-relay will listen on port 5432
and forward connections to the mail and users databases.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Start the relay with a non-standard configuration file and keep it
in the foreground:
.Sp
.Vb 1
\& postgresql-relay -c /usr/local/etc/postgresql-relay.conf.test -f
.Ve
.Sp
Now, in a different terminal, connect to to mail database:
.Sp
.Vb 1
\& psql -h dbserver -p 5432 -U root mail
.Ve
.SH "FILES"
.IX Header "FILES"
postgresql\-relay.conf, most likely in /usr/local/etc.
.SH "SECURITY"
.IX Header "SECURITY"
Postgresql-relay supports tcpwrappers. For access to \fBpostgresql-relay\fR
the daemon is called \fIpostgresql\fR. For access to a database the
daemon is called \fIpostgresql-dbname\fR.
.Sp
In the following example, the localhost and the hosts in the 10/8
network have access to postgresql\-relay, while only the localhost
and the 10.10.10.0/8 network have access to the database 'fdc':
.Sp
.Vb 3
\& postgresql : 10.0.0.0/255.0.0.0 : allow
\& postgresql : 127.0.0.1 : allow
\& postgresql : ALL : deny
.Ve
.Sp
.Vb 3
\& postgresql-mail : 10.10.10.0/255.255.255.0 : deny 
\& postgresql-mail : 127.0.0.1 : allow
\& postgresql-mail : ALL : deny
.Ve
.SH "LOGGING"
.IX Header "LOGGING"
Logging goes to syslog, to the facility \fIdaemon\fR.
.SH "NOTES"
.IX Header "NOTES"
It would be best practise if the name of the machine on which
postgresql-relay is running would have an alias in \s-1DNS\s0, so that
even if the machine on which postgresql-relay is running changes,
the scripts don't have to be updated. A recommended name is \fBdbrelay\fR.
.SH "BUGS"
.IX Header "BUGS"
If the communication protocol version is unknown, it should fail
properly but this hasn't been tested.
.SH "AUTHOR"
.IX Header "AUTHOR"
Edwin Groothuis, edwin@mavetju.org (http://www.mavetju.org)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIpsql\fR\|(1)