File: xr.1

package info (click to toggle)
crossroads 2.65-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 2,664 kB
  • ctags: 355
  • sloc: cpp: 4,212; perl: 1,658; xml: 269; makefile: 186; sh: 46
file content (57 lines) | stat: -rw-r--r-- 2,091 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
.TH "XR" "1" "Nov 6, 2008" "Crossroads" "Man Page"

.SH "NAME"
xr \- Crossroads Load Balancer & Fail Over Utility

.SH "SYNOPSIS"
\fBxr [--verbose] [--web-interface XRSERVER:PORT] --server
tcp:XRSERVER:PORT --backend BACKEND:PORT [--backend BACKEND:PORT] ...\fR

.SH "DESCRIPTION"
This manual page briefly documents XR, the Crossroads Load Balancer &
Fail Over Utility.

XR is an open source load balancer and fail over utility for TCP based
services. It is a dae mon running in user space, and features
extensive configurability, polling of back ends using wake up calls,
status reporting, many algorithms to select the 'right' back end for a
reques t (and user-defined algorithms for very special cases), and
much more.

XR is service-independent: it is usable for any TCP service, such as
HTTP(S), SSH, SMTP, dat abase connections. In the case of HTTP
balancing, XR handles multiple host balancing, and can provide session
stickiness for back end processes that need sessions, but aren't
session-awa re of other back ends.

XR furthermore features a management web interface and can be run as a
stand-alone daemon, or via inetd.

Execute 'xr -h' to get a complete list of available command-line parameters.

.SH "EXAMPLE"
xr --verbose --server tcp:0:80 --backend 10.1.1.1:80 --backend
10.1.1.2:80 --backend 10.1.1. 3:80 --web-interface 0:8001

This instructs XR to listen to port 80 and to dispatch traffic to the
servers 10.1.1.1, 10.1.1.2 and 10.1.1.2, port 80. A web interface for
the balancer is started on port 8001.

Direct your browser to the server running XR. You will see the pages
served by one of the three back ends. The console where XR is
started, will show what's going on (due to the presence of
--verbose).

Direct your browser to the server running XR, but port 8001. You will
see the web interface, which shows the status, and where you can
alter some settings.

.SH "SEE ALSO"
xrctl(1)

.SH "AUTHOR"
XR was written by Karel Kubat <karel@kubat.nl>. Web page:
http://crossroads.e-tunity.com

.P
This man page was written by Frederik Dannemare <frederik@dannemare.net>.