client_login_timeout: check wait_for_welcome
[pgbouncer.git] / README
blob2c77c36f1caf2170ff6ba27e531c6b48a6183961
2 PgBouncer
3 =========
5 Lightweight connection pooler for PostgreSQL.
7 Docs:   http://developer.skype.com/SkypeGarage/DbProjects/PgBouncer
8 Source: http://pgfoundry.org/projects/pgbouncer
10 Building
11 ---------
13 PgBouncer uses libevent for low-level socket handling.
14 Libevent needs to be at least version 1.3b.
16 When this is installed just run:
18         $ ./configure --prefix=/usr/local --with-libevent=/prefix
19         $ make
20         $ make install
22 If the OS does not have libevent available as package, it can be
23 downloaded from http://monkey.org/~provos/libevent/
25 Building from CVS
26 -----------------
28 Building PgBouncer from CVS requires that you generate the header
29 and config files before you can run configure:
31         $ make boot
32         $ ./configure ...
33         $ make
35 To have manpages, asciidoc 8.x and xmlto need to be installed,
36 as CVS does not contain generated pages.  Without those,
37 manpages are skipped when building/installing.
39 Building for WIN32
40 ------------------
42 At the moment only build env tested is MINGW32 / MSYS.  Cygwin
43 and Visual $ANYTHING are untested.  In addition to libevent you
44 need GNU regex library (http://gnuwin32.sourceforge.net/packages/regex.htm[]).
45 Then do the usual:
47         $ ./configure ...
48         $ make
50 If cross-compiling from Unix:
52         $ ./configure --host=i586-mingw32msvc ...
54 Running on WIN32
55 ----------------
57 Running from command-line goes as usual, except -d (daemonize),
58 -R (reboot) and -u (switch user) switches will not work.
60 To run pgbouncer as a service, you need to configure
61 `service_name` parameter to set name for service.  Then:
63         $ pgbouncer -regservice config.ini
65 To uninstall service:
67         $ pgbouncer -unregservice config.ini
69 To use Windows Event Log, set "syslog = 1" in config file.
70 But before you need to register pgbevent.dll:
72         $ regsvr32 pgbevent.dll
74 To unregister it, do `regsvr32 /u pgbevent.dll`.