crossroads

Git mirror of https://crossroads.e-tunity.com/
git clone git://git.finwo.net/app/crossroads
Log | Files | Refs | LICENSE

xr.1 (2091B)

      1 .TH "XR" "1" "Nov 6, 2008" "Crossroads" "Man Page"
      2 
      3 .SH "NAME"
      4 xr \- Crossroads Load Balancer & Fail Over Utility
      5 
      6 .SH "SYNOPSIS"
      7 \fBxr [--verbose] [--web-interface XRSERVER:PORT] --server
      8 tcp:XRSERVER:PORT --backend BACKEND:PORT [--backend BACKEND:PORT] ...\fR
      9 
     10 .SH "DESCRIPTION"
     11 This manual page briefly documents XR, the Crossroads Load Balancer &
     12 Fail Over Utility.
     13 
     14 XR is an open source load balancer and fail over utility for TCP based
     15 services. It is a dae mon running in user space, and features
     16 extensive configurability, polling of back ends using wake up calls,
     17 status reporting, many algorithms to select the 'right' back end for a
     18 reques t (and user-defined algorithms for very special cases), and
     19 much more.
     20 
     21 XR is service-independent: it is usable for any TCP service, such as
     22 HTTP(S), SSH, SMTP, dat abase connections. In the case of HTTP
     23 balancing, XR handles multiple host balancing, and can provide session
     24 stickiness for back end processes that need sessions, but aren't
     25 session-awa re of other back ends.
     26 
     27 XR furthermore features a management web interface and can be run as a
     28 stand-alone daemon, or via inetd.
     29 
     30 Execute 'xr -h' to get a complete list of available command-line parameters.
     31 
     32 .SH "EXAMPLE"
     33 xr --verbose --server tcp:0:80 --backend 10.1.1.1:80 --backend
     34 10.1.1.2:80 --backend 10.1.1. 3:80 --web-interface 0:8001
     35 
     36 This instructs XR to listen to port 80 and to dispatch traffic to the
     37 servers 10.1.1.1, 10.1.1.2 and 10.1.1.2, port 80. A web interface for
     38 the balancer is started on port 8001.
     39 
     40 Direct your browser to the server running XR. You will see the pages
     41 served by one of the three back ends. The console where XR is
     42 started, will show what's going on (due to the presence of
     43 --verbose).
     44 
     45 Direct your browser to the server running XR, but port 8001. You will
     46 see the web interface, which shows the status, and where you can
     47 alter some settings.
     48 
     49 .SH "SEE ALSO"
     50 xrctl(1)
     51 
     52 .SH "AUTHOR"
     53 XR was written by Karel Kubat <karel@kubat.nl>. Web page:
     54 http://crossroads.e-tunity.com
     55 
     56 .P
     57 This man page was written by Frederik Dannemare <frederik@dannemare.net>.