Realproxyg 2 B 1
Realproxyg 2 B 1
Realproxyg 2 B 1
BETA ONE
Information in this document is subject to change without notice. Companies, names, and data used in
examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or
transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written
permission of RealNetworks, Inc.
© 1999 RealNetworks, Inc.
RealAudio, RealVideo, and RealPlayer are registered trademarks of RealNetworks, Inc.
The Real logo, RealServer, RealPlayer Plus, RealText, RealPix, RealAudio Encoder, RealVideo Encoder,
RealEncoder, RealPublisher, RealProducer, RealProducer Plus, RealProducer Pro, SureStream, RealBroadcast
Network, and RealSystem are trademarks of RealNetworks, Inc.
RealFlash is a trademark of Macromedia, Inc. and RealNetworks, Inc.
Macromedia is a registered trademark and Flash and Shockwave are trademarks of Macromedia, Inc.
STiNG is a trademark of Iterated Systems, Inc.
ACELP-NET codec used under license from Université de Sherbrooke. Sipro Lab Télécom, Inc. Copyright ©1994-
1997. All rights reserved.
DolbyNet is a trademark of Dolby Laboratories, Inc.
Dolby Digital AC-3 audio system manufactured under license from Dolby Laboratories.
Apple, Macintosh, and Power Macintosh are registered trademarks of Apple Computer, Inc.
Microsoft, MS-DOS, Windows, and Windows NT are registered trademarks and ActiveX is a trademark of
Microsoft Corporation.
Netscape and Netscape Navigator are registered trademarks of Netscape Communications Corporation.
Pentium is a registered trademark and MMX and the Intel Optimizer Logo are trademarks of Intel Corporation.
Sonic Foundry and Sound Forge are registered trademarks of Sonic Foundry, Inc.
Other product and corporate names may be trademarks or registered trademarks of other companies. They are
used for explanation only, with no intent to infringe.
RealNetworks, Inc.
1111 Third Avenue, Suite 2900
Seattle, WA 98101 USA
http://www.real.com
CONTENTS
Overview............................................................................... 9
How This Manual Is Organized .............................................. 9
Conventions in This Manual .................................................11
Additional RealSystem Resources..........................................12
Technical Support ................................................................12
1 OVERVIEW 15
How RealProxy Works ..........................................................15
Media Cache Software .....................................................17
Modes of Operation.............................................................18
Passthrough.....................................................................18
Cache Integration ............................................................19
Bitsave.............................................................................21
Pull Splitting ....................................................................22
Requirements for Each RealProxy Mode ............................22
Interaction with RealServer ...................................................22
Controlling Client Access..................................................23
Denying Client Access.......................................................23
Tracking Activity...............................................................23
Cache Requests................................................................23
When RealProxy Will Not Conserve Bandwidth......................24
Additional Features ..............................................................24
Administration.................................................................24
Setting Up Clients ............................................................25
Limiting Network Traffic...................................................25
Chaining One RealProxy to Another ..................................25
Monitoring RealProxy in Real Time....................................26
Tracking RealProxy Activity ...............................................26
Protocols.............................................................................26
iii
Contents RealProxy Administration Guide
5 ADVANCED FEATURES 51
Running Web Servers and RealProxy on the Same System ......51
Administering Both RealProxy and RealServer ........................52
Reserving IP Addresses for RealProxys Use ............................52
Features Specific to the Operating System .............................53
Windows NT ...................................................................53
UNIX...............................................................................54
6 MANAGING BANDWIDTH 55
Overview .............................................................................55
Maximum Clients.................................................................56
Maximum Bandwidth...........................................................56
Maximum Gateway Bandwidth .............................................57
Low Gateway Bandwidth......................................................57
Limiting Access to Multicast Reception .................................58
iv
Contents RealProxy Administration Guide
v
Contents RealProxy Administration Guide
Paths.............................................................................102
RealProxy ......................................................................103
RTSP Redirection ...........................................................105
MIME Types ..................................................................105
File Systems ...................................................................106
IP Binding......................................................................108
Allowance......................................................................109
HTTP Support ...............................................................110
Access Control...............................................................110
Splitting ........................................................................111
Multicasting ..................................................................112
Authentication...............................................................113
Passwords .....................................................................114
Logging .........................................................................114
vi
Contents RealProxy Administration Guide
vii
Contents RealProxy Administration Guide
viii
INTRODUCTION
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
Welcome to RealProxy, a network server that works with
RealServer to reduce streaming media bandwidth and improve the
viewing experience on your intranet or Internet gateway. This
manual will help you use and optimize RealProxy.
Overview
This manual is aimed at information services administrator who will be
setting up RealProxy.
Chapter 1: Overview
This chapter gives the big picture of how RealProxy streams media to a
clients, while conserving bandwidth used.
9
Introduction RealProxy Administration Guide
10
RealProxy Administration Guide Introduction
Appendixes
11
Introduction RealProxy Administration Guide
Technical Support
For technical support with RealSystem G2, please fill out the form at:
http://service.real.com/contact/email.htm
The information you provide in this form will help technical support
personnel to give you a prompt response. For general information about
RealNetworks technical support, visit:
http://service.real.com/help/call.html
12
RealProxy Administration Guide Introduction
13
Chapter 1: OVERVIEW 1
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
RealProxy manages clients requests for RealServer content.
RealProxy can also be integrated with third-party cache software,
enabling RealProxy to stream stored media closer to clients and to
conserve gateway bandwidth.
15
CHAPTER 1: Overview RealProxy Administration Guide
3. If the stream is live, and served from a RealServer that supports splitting,
RealProxy replicates the live stream for each client requesting the stream.
The origin RealServer sends only a single stream to RealProxy.
If the live stream is not available via splitting, RealProxy delivers the data
separately for each client.
Live Content
16
RealProxy Administration Guide CHAPTER 1: Overview
Once configured to work with a media cache, RealProxy sends the clients
request to the origin RealServer. After the request is approved and RealServer
begins streaming, RealProxy looks at the incoming stream to determine
17
CHAPTER 1: Overview RealProxy Administration Guide
Modes of Operation
RealProxy has four modes of operation:
Passthrough
Bitsave
Caching
Splitting
Passthrough
This is the RealProxys simplest method of operation. In passthrough mode,
no special features are activated, but all streaming media traffic passes
through one point. In addition to the usual accounting connection opened
between the client and the origin RealServer, RealProxy creates a data
connection for each client. No bandwidth conservation is appreciated.
18
RealProxy Administration Guide CHAPTER 1: Overview
Cache Integration
Cache software stores on-demand streams from RealServer. Since cached files
are stored in a proprietary format and cannot be accessed directly, RealProxy
interfaces with the cache to redistribute the stored media to clients.
When caching is enabled, the media cache software stores streamed data when
requested by the first client. When a second client makes a request for a
stream, RealProxy checks with the cache to see if a stored version is already
present. To ensure that the stored version is the most up-to-date version
available, RealProxy checks with the origin RealServer to see if a newer version
exists. After determining that the stored copy is the latest version, RealProxy
streams the stored copy to the second client.
Only on-demand files streamed by RealServer G2 can be cached. Live material
is handled as in the most efficient mode suitablebitsave or passthrough (and
sent via multicast, if available on the network).
19
CHAPTER 1: Overview RealProxy Administration Guide
20
RealProxy Administration Guide CHAPTER 1: Overview
You wont be able to take advantage of your media cache if clients are
requesting streams from an origin RealServer which has been configured to
prevent caching. Clients will still receive the streams, but the media cache
wont be permitted to store them. When RealServer is installed, all its streams
are cacheable by default.
Even if a RealServer manager opts to prevent caching of some content (such as
advertisements), he or she will probably permit it for most items. Since
RealServers can reach more clients if caching is allowed, managers are
encouraged to leave all content cacheable.
For specific instructions on configuring a third-party media cache, refer to the
documentation included with that software.
Bitsave
Bitsave mode is for use with live material. The first time a client requests a
particular stream, RealProxy contacts the origin RealServer on the clients
behalf and then sends the stream to the client. The second client to request a
live stream will receive it directly from RealProxy, and RealProxy will not have
to obtain another stream from the origin RealServer. The origin RealServer
has only to serve a single stream to every client that uses a particular
RealProxy.
The advantage to the client is that the material is delivered from a local
source. As long as the quality of reception between RealProxy and the origin
RealServer remains good, the client will receive a high-quality live stream, as
well.
21
CHAPTER 1: Overview RealProxy Administration Guide
Pull Splitting
If you have your own RealServer that broadcasts within your network, you can
configure RealProxy to act as a splitter. RealProxy can then share the
streaming load with the source RealServer.
22
RealProxy Administration Guide CHAPTER 1: Overview
Tracking Activity
To the origin RealServer, requests made via RealProxy appear identical to
requests made by any other client, and information about quality of service is
logged in the log file, just as it is for any other type of connection. Information
about quality of service comes from the accounting connection between the
RealServer and the client.
Cache Requests
RealProxy only streams media from the cache after opening an accounting
connection to the origin RealServer. If the accounting connection cannot be
23
CHAPTER 1: Overview RealProxy Administration Guide
Additional Features
RealProxy contains additional features that make it easy to configure,
administer, and maintain.
Administration
RealSystem Administrator is a web-based console for customizing RealProxy
features. You can access via a browser anywhere on your network, using either
Netscape Navigator version 4.06 or higher, or Internet Explorer version 4.0 or
higher.
Changes you make using RealSystem Administrator are stored in the
RealProxy configuration file. This text file is based on Extensible Markup
Language (XML) and can be edited directly. Because the structure of this file is
complex, RealSystem Administrator is the recommended tool for making
changes.
24
RealProxy Administration Guide CHAPTER 1: Overview
Setting Up Clients
Once you have configured RealProxy, you will need to arrange for clients (such
as RealPlayer) to send their requests to RealProxy.
There are two ways you can do this:
Configure clients to directly contact RealProxy with their streaming
media requests. You can send instructions for doing this to users.
Configure RealProxy to intercept client requests. This does not require any
special client configuration, but it does require the use of software or
hardware which routes TCP traffic by destination port (such as a layer-4
switch).
For information on setting up either method, see Chapter 4: Connecting
Clients to RealProxy.
25
CHAPTER 1: Overview RealProxy Administration Guide
Protocols
RealProxy handles client requests and proxies RealServer streams by using the
Real Time Streaming Protocol (RTSP), the Internet standard control protocol
for streaming multimedia, and PNA, the RealNetworks legacy protocol.
RealProxy does not handle HTTP requests made between clients and origin
RealServer.
Supported Protocols and Data Packet Formats
Control Protocol Control Data Packet Data Packet Supported by
Transport Format Transport RealProxy?
RTSP TCP RDT IP multicast, Yes
(RealNetworks) UDP, TCP
RTSP TCP RTP IP multicast, Yes
UDP, TCP
PNA TCP RDT UDP, TCP Yes
(RealNetworks) (RealNetworks)
(Table Page 1 of 2)
26
RealProxy Administration Guide CHAPTER 1: Overview
27
CHAPTER 1: Overview RealProxy Administration Guide
28
Chapter 2: STARTING AND STOPPING REALPROXY 2
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
This chapter gives information on starting and stopping RealProxy
on both Windows and UNIX platforms, setting up MIME types, and
explains the RealProxy license method.
Windows
Instructions in this section describe how to start and stop RealProxy running
under Windows.
On the Start menu, click Programs, then click RealProxy, and finally click
RealProxy G2. This starts the rmserver.exe program. If this is the first time you
have run RealProxy, it loads the default configuration file.
Additional Information
The configuration file is described in Chapter 3:
Configuring RealProxy Features.
29
CHAPTER 2: Starting and Stopping RealProxy RealProxy Administration Guide
Move to the RealProxy Bin directory and type the following at a command line:
rmserver ..\rmserver.cfg
To limit the amount of memory that RealServer G2 uses, start RealServer with
the -m parameter:
rmserver ..\rmserver.cfg -m 32
30
RealProxy Administration Guide CHAPTER 2: Starting and Stopping RealProxy
Note
You must supply the path to the configuration file. If
RealProxy cannot find the configuration file, it may not
start.
Tip
You can now start RealProxy using this configuration by
typing the following at a command line:
rmserver.exe registry:Proxy1
The next time you start RealProxy from the Services dialog box, it will use
the settings specified in parameters , and will be configured to start
automatically.
For example, the following command:
rmserver.exe -install:NewYorkProxy "Proxy1"
installs RealProxy with the service name NewYorkProxy and uses the
settings in the Proxy1 key.
➤ To remove any RealProxy from the services list:
31
CHAPTER 2: Starting and Stopping RealProxy RealProxy Administration Guide
where ServiceName is the optional name of the service. If you omitted a service
name when you installed the service, you can omit it here, and RealProxy will
use RMProxy.
UNIX
Instructions in this section describe how to start and stop RealProxy running
under UNIX.
32
RealProxy Administration Guide CHAPTER 2: Starting and Stopping RealProxy
If you do not start from the bin directory, RealProxy cannot understand the
relative paths in the configuration file.
You can run RealProxy in the background by typing the following from the bin
directory:
rmserver ../rmserver.cfg &
If you have other configuration files, you can substitute their names for
rmserver.cfg and RealProxy will use the settings in the file you name.
To limit the amount of memory that RealServer G2 uses, start RealServer with
the -m parameter:
rmserver ../rmserver.cfg -m 32
33
CHAPTER 2: Starting and Stopping RealProxy RealProxy Administration Guide
where pidfile is the name of the RealProxy PID file, as shown in the PIDPath
variable. The usual name for this file is rmserver.pid .
When you install RealProxy, the MIME Types section is present in the
configuration file. You need only examine this list if something happened in
the meantime and you think the list might be incomplete. You can examine
the MIME types section using the following instructions.
Additional Information
See Configuring RealProxy Features for instructions
on using RealSystem Administrator.
34
RealProxy Administration Guide CHAPTER 2: Starting and Stopping RealProxy
You should only modify the list if you will be streaming a data type via
HTTP that is not on the list.
To add another MIME type, click Add. Type the name and extension
in the respective boxes, and click Submit.
To edit anexisting MIME type, select it from the Names list, and click
Edit. Change the name or extension and click Add.
Toremove a MIME type, select it from the Names list, and click
Remove. Click OK.
35
CHAPTER 2: Starting and Stopping RealProxy RealProxy Administration Guide
License Information
Information about the license for your RealProxy is stored in a file in a license
directory. License files are written in XML format.
You can read the file with RealSystem Administrator by clicking About in the
left-hand frame. A second browser window appears, displaying the values for
your license file. If you have multiple license files, RealProxy will show the
values for all of them at once.
You can also read the file with any text editor.
If the license file is invalid, RealProxy will report an error message, add the
error to the error log file, and will not start.
If your RealProxy suddenly allows fewer connections or otherwise appears to
be using minimum settings, either your license has expired or RealProxy is
unable to start using the settings youve selected.
The LicenseDirectory variable in the configuration file tells RealProxy where to
look for license information.
Additional Information
To learn about the configuration file, see
Configuration File on page 41.
36
RealProxy Administration Guide CHAPTER 2: Starting and Stopping RealProxy
37
Chapter 3: CONFIGURING REALPROXY FEATURES 3
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
All RealProxy settings are customized through the RealSystem
Administrator. This chapter describes how to use RealSystem
Administrator as well as the basic settings used by all RealProxys.
39
CHAPTER 3: Configuring RealProxy Features RealProxy Administration Guide
3. You are prompted for your user name and password; these will match the
values you entered during setup. Click OK.
RealSystem Administrator appears.
40
RealProxy Administration Guide CHAPTER 3: Configuring RealProxy Features
Configuration File
Changes made with RealSystem Administrator are stored in the configuration
file. It is a text file formatted with tags which are based on XML (Extensible
Markup Language). This language introduces great flexibility to the
configuration file format and allows third-parties to use this file and add to
its functionality. Syntax of this file is given in Appendix A: Configuration File
Syntax.
Be sure that your configuration file is stored where only authorized users can
make changes to it.
41
CHAPTER 3: Configuring RealProxy Features RealProxy Administration Guide
Tip
Keep a backup copy of the configuration file. You may
need it if you make changes to this file that you later
want to undo or if you accidentally delete the working
copy.
Warning
Exit RealSystem Administrator before opening the
configuration file with a text editor or unexpected
changes may result.
42
RealProxy Administration Guide CHAPTER 3: Configuring RealProxy Features
Common Settings
Regardless of which features are in use, certain powerful settings apply to
every RealProxy. They are described in this section.
Port Variables
Port settings tell RealProxy where to listen for requests.
If your RealProxy and Web server are on the same machine, you may need to
modify the HTTP Port setting. See Running Web Servers and RealProxy on
the Same System on page 51 for additional information.
➤ To add port settings:
2. Tell RealProxy where to listen for material requested via PNA (these begin
with pnm:// ) by typing the correct value in the PNA Port box. The default
value is 1090.
3. Tell RealProxy where to listen for RTSP requests (these begin with rtsp:// )
by typing the correct value in the RTSP Port box. At installation, the value
is 1091.
4. Tell RealProxy where to listen for RealSystem Administrator connection
requests by typing any unique port number in the Admin Port box.
Note
To use a port lower than 1024 on a UNIX system, you
must be logged on as super-user.
43
CHAPTER 3: Configuring RealProxy Features RealProxy Administration Guide
Passthrough Mode
Passthrough mode is always enabled. It cant be turned on or off.
Bitsave Mode
In bitsave mode, RealProxy redistributes the incoming live streams with all the
clients who request it, rather than requesting additional streams on their
behalf.
Currently, this can only be configured by editing the file directly.
➤ To set up bitsave mode by editing the conf iguration f ile:
Cache Mode
Refer to the documentation included with your caching software for
instructions.
Pull Splitting
Pull splitting is enabled by default.
Multicasting
44
Chapter 4: CONNECTING CLIENTS TO REALPROXY 4
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
This chapter describes how to make clients send their requests to
RealProxy.
Overview
Even after RealProxy is installed, clients will not automatically contact it. So
that clients (such as RealPlayer) route their requests to your RealProxy, you
must either configure the clients individually, or configure a third-party
router to automatically redirect streaming media requests to RealProxy.
45
CHAPTER 4: Connecting Clients to RealProxy RealProxy Administration Guide
After it receives the redirected request, RealProxy contacts the client, and tells
it to contact RealProxy directly.
Now that the client knows the correct address and port number to use, it re-
submits its streaming media request. Having received the request directly from
the client, RealProxy now handles the requests in the usual manner.
For each presentation that the client requests (whether an individual clip or a
SMIL presentation), this process will be repeated.
46
RealProxy Administration Guide CHAPTER 4: Connecting Clients to RealProxy
4. In the box next to it, type the IP address or DNS of the RealProxy
computer.
5. In the Port box, type the number of the RealProxy port number to which
this client should send its PNA requests (usually 1090 ). The number you
type here must match the number in the PNA Port box on the Ports page
in RealSystem Administrator (or the Port variable in the Proxy list in the
configuration file).
6. Select the Use RTSP proxy box.
7. In the box next to it, type the IP address or DNS of the RealProxy
computer.
8. In the Port box, type the number of the RealProxy port number to which
this client should send its RTSP requests (usually 1091). The number you
type here must match the number in the RTSP Port box on the Ports page
in RealSystem Administrator (or the Port variable in the Proxy list in the
configuration file).
9. Click OK.
47
CHAPTER 4: Connecting Clients to RealProxy RealProxy Administration Guide
Warning
If you are running RealProxy on a UNIX system, the
RTSP redirection feature may not start correctly. It uses
a port number lower than 1024and on UNIX systems,
you must be logged on as super-user for lower port
numbers to be recognized.
48
RealProxy Administration Guide CHAPTER 4: Connecting Clients to RealProxy
6. Type the port number to which clients should send their PNA requests
(usually 1091) in the PNA Redirect Port box.
7. Type the IP address of RealProxy to which clients should send their PNA
requests in the PNA Redirector Address box.
8. Click Apply.
49
CHAPTER 4: Connecting Clients to RealProxy RealProxy Administration Guide
50
Chapter 5: ADVANCED FEATURES 5
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
This chapter covers features which are specific to the operating
system, as well as reserving IP addresses for RealProxys use, and
running RealProxy on the same system as a Web server.
51
CHAPTER 5: Advanced Features RealProxy Administration Guide
8080 . Most Web servers use port 80. Be sure that you include the port number
in the URL.
52
RealProxy Administration Guide CHAPTER 5: Advanced Features
Additional Information
Instructions on customizing RealProxy can be found in
Chapter 3: Configuring RealProxy Features on page 39.
Warning
Use either 0.0.0.0 or other addresses, but not both. If
you use both, RealProxy will not start.
5. Click Add.
If you leave the IP Address box blank, RealProxy binds to the host IP address
and localhost. It does not bind to any others.
Windows NT
This section describes features unique to RealProxy running on a Windows
NT system.
53
CHAPTER 5: Advanced Features RealProxy Administration Guide
UNIX
This section describes features unique to RealProxy running on a UNIX
system.
Process ID (PID)
RealProxy creates a text file that stores the current value of the process ID of
the main RealProxy file, rmserver. The file is stored in the directory indicated
by the PIDPath variable, and is named rmserver.pid at installation. If PIDPath is
omitted from the configuration file, RealProxy stores the information in the
directory specified by the LogPath variable.
SIGHUP
When you make changes to RealProxy using RealSystem Administrator, those
changes are saved and RealProxy is restarted immediately. If you make changes
to the configuration file manually, you will need to restart RealProxy yourself.
This is possible for RealProxy running on a UNIX platform with the SIGHUP
command. Use the following command at a command prompt:
kill -HUP processID
54
Chapter 6: MANAGING BANDWIDTH 6
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
RealProxy has several methods of managing the bandwidth that it
uses. Whether you use just one method, or you use several in
conjunction, you control the amount of traffic on your network.
Overview
When you install RealProxy, the values for each of these settings is configured
to use the maximum available number.
Techniques for managing the bandwidth you use include:
Maximum Proxy Connections limit the number of clients that can
connect at one time
Maximum Proxy Bandwidth limits the bandwidth in use between
RealProxy and clients
Maximum Gateway Bandwidth limits the bandwidth in use between
RealProxy and RealServers
Low Bit Rate Gatewaydeliver appropriate bit rate in SureStream file if
connection between RealProxy and Internet is small
Require Multicast Delivery require clients to connect in Multicast mode
If you establish values for all these features, RealProxy will limit access when
the lower threshold is reached. If a client tries to make a request after a limit
has been reached, the client receives an error message.
In addition, you can require that the only certain client versions can connect
to your RealProxy.
For information on restricting which clients can connect to RealProxy based
on their IP addresses, see Chapter 7: Limiting Access to RealProxy.
55
CHAPTER 6: Managing Bandwidth RealProxy Administration Guide
Maximum Clients
By using the Maximum Proxy Connections setting (the MaxProxyConnections
variable in the configuration file), you can limit the number of clients who
connect simultaneously. Once this limit is reached, clients that attempt to
connect receive an error message, and will not be able to connect until other
clients disconnect.
➤ To limit access by limiting connections:
Maximum Bandwidth
The Maximum Proxy Bandwidth setting (MaxBandwidth in the configuration
file) limits the amount of bandwidth RealProxy can use to any number of
kilobits per second (Kbps).
➤ To limit client bandwidth:
56
RealProxy Administration Guide CHAPTER 6: Managing Bandwidth
57
CHAPTER 6: Managing Bandwidth RealProxy Administration Guide
58
RealProxy Administration Guide CHAPTER 6: Managing Bandwidth
3. Click Apply.
➤ To limit access by player protocol number:
This variable was used in earlier versions of RealProxy and is included here for
backwards compatibility. It must be added to the configuration file directly by
using a text editor. It denies access to players whose version number is less
than the number specified. Use one of the following values for Minimum Player
Version :
0 All clients are permitted to connect to RealProxy
4 RealAudio Player 1.0 and later can connect
7 RealAudio Player 2.0 and later can connect
8 RealAudio Player 3.0 and later can connect
10 RealPlayer 4.0 and later can connect
59
CHAPTER 6: Managing Bandwidth RealProxy Administration Guide
60
Chapter 7: LIMITING ACCESS TO REALPROXY 7
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
RealProxy allows you to restrict access to certain clients based on
their IP addresses.
Overview
You can block or permit access to specific RealProxy ports based on the IP
address of the client and the port to which they are sending their requests.
Clients whose IP addresses are configured with deny receive an error
message indicating that the URL is not valid or that the connection has timed
out.
For example, you can restrict which clients can send requests to your
RealProxy by restricting access to the RTSP Proxy port (usually 1091).
Information about each IP address or range of addresses you want to allow or
restrict is stored in a rule. A rule is a set of instructions to RealServer about the
address range and behavior to allow. Rules are identified by numbers which
you assign.
Before using this feature, you must make decisions about the types of rules
you will create.
Each rule contains the following information:
Access Rule NumberIdentification number for this rule.
AccessWhether the client will be allowed or denied access.
ToRealProxys address.
FromClients address, or a range of addresses. This can also be an
encoders IP address.
61
CHAPTER 7: Limiting Access to RealProxy RealProxy Administration Guide
Warning
If you are using Specific Address Denial and you omit
this step, you will deny access for everyone except those
clients mentioned in the first set of rules.
If you are using Specific Address Permission, this set of rules is optional.
62
RealProxy Administration Guide CHAPTER 7: Limiting Access to RealProxy
3. Finally, the last rule allows you to access to the RealSystem Administrator
port.
Note
Even if you are only interested in restricting access for a
single clients requests, you must still create all the rules
necessary for your method.
63
CHAPTER 7: Limiting Access to RealProxy RealProxy Administration Guide
64
RealProxy Administration Guide CHAPTER 7: Limiting Access to RealProxy
know the Admin Port number (chosen randomly at installation) and who have
a user name and password specifically for RealSystem Administrator.
Warning
If you omit this initial step, you will not be able to
connect to RealSystem Administrator when you restart
RealProxy, regardless of whether you have username-
and-password permission.
Additional Information
To learn how to give access to RealSystem Administrator
based on user name, see RealSystem Administrator
User Authentication on page 129.
65
CHAPTER 7: Limiting Access to RealProxy RealProxy Administration Guide
9. In the Restricted Ports box, type the Admin Port number you noted in
Step 2.
10. Click OK. You are returned to the Access Control page of RealSystem
Administrator.
11. Click Apply.
You will now be able to access RealSystem Administrator, no matter what
rules you create in the next section.
Warning
Be sure to first follow the steps in Creating General
Access Rules, or you will not be able to access
RealSystem Administrator after you restart RealProxy.
If this rule will refer to G2 encoders that will be sending content to your
RealProxy, click Broadcasting > G2 Encoder. Make a note of the value for
Port (usually 4040 ).
If this rule will refer to pre-G2 encoders that will be sending content to
your RealProxy, click Broadcasting > Pre-G2 Encoder. Make a note of the
value for Port (usually 5050 ).
2. In RealSystem Administrator, click Security. Click Access Control. (Picture
to be supplied later)
66
RealProxy Administration Guide CHAPTER 7: Limiting Access to RealProxy
Warning
You must type a number in this box. RealProxy will
ignore any rule that is not numbered.
Tip
Technically, you can type any number in this box. But
because rules are sorted numerically, and because the
rule that allows access to RealSystem Administrator
must be the last rule on the list, use a three-digit
number here so the RealSystem Administrator rule
(given as rule 1000 in Creating General Access Rules)
can be the last rule on the list.
67
CHAPTER 7: Limiting Access to RealProxy RealProxy Administration Guide
Tip
To refer to any IP address on the RealProxy machine,
type Any.
7. In the From box, type the IP address of the client machine, followed by the
subnet mask. The subnet mask indicates whether the restriction refers to a
single IP address an entire range of addresses.
There are two ways of showing the subnet mask:
Place a slash mark after the IP address, and give the number of bits for
the mask.
Place a colon after the IP address, and give the full subnet mask.
For example, the following are equivalent and acceptable in the From box:
172.16.3.0:255.255.255.0 and 172.16.3.0/24 . Both examples specify the
range of addresses from 172.16.3.0 to 172.16.3.254.
To specify the netmask for single IP address, type either :255.255.255.255
or /32 after the IP address.
To specify the subnet for a range of IP addresses, type either a colon after
the IP address followed by the full subnet mask, or type a slash mark after
the IP address, and give the number of bits for the subnet mask (24 , 16 , or
8 ).
Tip
To refer to all clients, regardless of IP address, type the
word Any in the From box, and omit the subnet mask.
8. Finally, list the RealProxy port numbers to which you want to restrict
access. In the Restricted Ports box, type the port numbers, separated by
commas.
Youll probably want to use the numbers for RTSP Port (1091) and PNA
Proxy Port (1090).
To restrict access to all RealProxy content, the port numbers should
match the other port numbers youve instructed RealProxy to listen to;
look at the port numbers for RTSP port, PNA port, HTTP port, and the
port value used by the encoder.
9. Click OK. You are returned to the Access Control page of RealSystem
Administrator.
68
RealProxy Administration Guide CHAPTER 7: Limiting Access to RealProxy
69
CHAPTER 7: Limiting Access to RealProxy RealProxy Administration Guide
70
Chapter 8: CHAINING ONE REALPROXY TO
ANOTHER
8
This manual describes a pre-release product. As such, some features may not be fully
implemented; any information here is subject to change.
Chaining is a way of connecting several RealProxies on a network so
that all client requests for streamed media go through a single
point.
Overview
By redirecting the requests handled by multiple RealProxies to a single
RealProxy, you can funnel all client requests for streaming media to one point.
A RealProxy that has been configured to send its requests to another
RealProxy is called a child RealProxy; the RealProxy that receives the request
is the parent RealProxy.
71
CHAPTER 8: Chaining One RealProxy to Another RealProxy Administration Guide
In the example above, a client directs its request to a child RealProxy. That
RealProxy, in turn, sends the request to the parent RealProxy. It is the parent
RealProxy that sends the clients request to the origin RealServer. Once the
RealServer has received the request, it establishes the accounting connection
in the usual manner.
Setting Up Chaining
Configure a RealProxy to be a child RealProxy; you do not need to configure
the parent RealProxy, since it will receive the connections automatically.
You can set up this feature for both RTSP client requests and PNA client
requests.
➤ To set up chaining:
2. Indicate which the parent RealProxy to which this RealProxy should send
requests by typing the parent RealProxy address in the RTSP Parent Proxy
Address box.
If you want to forward PNA requests also, type the parent RealProxy
address in the PNA Parent Proxy Address box.
3. Type the port number of the parent RealProxy in the RTSP Parent Proxy
Port box.
Note
The port number you type needs to match the parent
RealProxys value for RTSP Proxy Port, usually 1091. (In
72
RealProxy Administration Guide CHAPTER 8: Chaining One RealProxy to Another
If you will be forwarding PNA requests, type the parent RealProxy port
number in the PNA Parent Proxy Port box. This number needs to match
the parent RealProxys value for PNA Proxy Port, usually 1090 . (In the
configuration file, match the value for PNAPort in the Proxy list.)
4. Click Add.
73
CHAPTER 8: Chaining One RealProxy to Another RealProxy Administration Guide
74
Chapter 9: MULTICASTING LIVE STREAMS 9
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
Multicasting helps you conserve bandwidth. It requires a multicast-
enabled network.
Overview
Multicasting is a way of sending a single live stream to multiple clients, rather
than sending a stream to every single client.
Multicasting
75
CHAPTER 9: Multicasting Live Streams RealProxy Administration Guide
Unicasting
Multicast Methods
This method of multicasting uses the RTSP protocol to send control
information over a TCP channel. RealProxy maintains a control connection
for each client. The data channel is multicast to all clients.
RTSP multicast provides the following features:
Authenticationuser name and password for secure content is sent
securely.
Connection statisticsRealProxy can receive client connection
information.
SureStreamthese multiply-encoded files are supported.
Note
RTSP multicasting works only with RealSystem G2
clients.
Setting Up Multicasting
Before you set up either type of multicasting, you need to do two things:
Configure the network for multicasting.
76
RealProxy Administration Guide CHAPTER 9: Multicasting Live Streams
77
CHAPTER 9: Multicasting Live Streams RealProxy Administration Guide
78
RealProxy Administration Guide CHAPTER 9: Multicasting Live Streams
2. In the RTSP Port box, type the port number to which RealProxy will direct
its RTSP multicast streams. The value in this box refers to the clients port
number. A typical value is 554 .
3. Specify the range of addresses to which you want to multicast streams by
filling in the Address Range box. RealProxy uses the first available address
in this range. If your multicast streams are referenced in SMIL files, you
will need one address for each stream.
Refer to Determining Required Addresses and Port Numbers on page 78
to calculate the exact number of addresses youll need.
4. In the IP Address section, click Add.
5. In the new window that appears, type a description for this list in the Rule
Number box.
6. In the IP Address box, type an address to the domain address of the client
computer or network to which RealProxy will permit multicast
transmissions.
7. In the Netmask box, type a netmask that limits the range to a particular
subnet.
8. Click Add.
79
CHAPTER 9: Multicasting Live Streams RealProxy Administration Guide
9. To require that the client addresses you just listed use multicast only, and
not unicast, select Yes from the Delivery Only list. To remove this
restriction and permit unicast for clients unable to connect via multicast,
set it to No .
10. Indicate how far multicast packets can travel over a network by typing a
value in the Time to Live box. Each time a multicast data packet passes
through a multicast-enabled router, its Time to Live is decreased by 1.
When the value is decremented to 0, the router discards the data packet.
The value for Time to Live can range from 0 to 255 . The larger the Time to
Live, the greater the distance a data packet will travel.
The default value of 16 is enough to keep multicast packets within a
typical internal network.
Time to Live (TTL) Values
TTL Value Packet Range
0 Local host
1 Local network (subnet)
32 Site
64 Region
128 Continent
255 World
11. To allow missing packets to be resent to clients that request them, select
True from the Resend list. This setting is optional. It adds some overhead
to the traffic on your network; however, clients receive better quality
multicasts.
12. Indicate which clients will be able to view your multicast presentations by
configuring the User List.
To require that clients with IP addresses in the User List must connect in
multicast mode, set Deliver Only to Yes . This setting means that clients
that are not configured for multicast will not be able to receive the
multicast, and will receive an error message instead. Use this feature when
you want to restrict the multicast to a limited number of clients, or if you
are multicasting a high-bandwidth presentation and do not want unicast
to be an option.
a. In the User List area, select Yes from the Delivery Only list.
80
RealProxy Administration Guide CHAPTER 9: Multicasting Live Streams
81
CHAPTER 9: Multicasting Live Streams RealProxy Administration Guide
82
Chapter 10: MONITORING REALPROXY ACTIVITY 10
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
To manage current activity on your RealProxy, youll want to track
how many clients are being served. RealProxy includes a monitoring
page within RealSystem Administrator. To generate reports of
historical activity, see Chapter 11: Tracking RealProxy Activity.
83
CHAPTER 10: Monitoring RealProxy Activity RealProxy Administration Guide
84
Chapter 11: TRACKING REALPROXY ACTIVITY 11
This manual describes a pre-release product. As such, some features may not be fully
implemented; any information here is subject to change.
RealProxy can create reports of historical data that let you see trends
and gather information. Track which visitors requested what data
and how well the data was delivered. This information is stored in
the proxy log. Any error messages are recorded in the error log.
Proxy Log
The RealProxy proxy log records the IP addresses of the clients that have
connected, the clips they listened to, the times of day they connected, and
much more. New information is always appended to the end of the proxy log.
Once you know the values of Logging Style, view the proxy log by opening
(Windows) or proxy (UNIX) file in a word processor or text editor.
proxy.log
85
CHAPTER 11: Tracking RealProxy Activity RealProxy Administration Guide
Note
Although in the rest of this manual, square brackets
indicate optional material, the square brackets shown in
the proxy log actually appear within proxy log records.
The following table lists the format for each proxy log record:
Proxy Log Format
Proxy Log Field Description
client_IP_address IP address of client, such as 123.45.123.45
-- Two hyphens for compatibility with standard Web server log
formats.
timestamp Time that client accessed the file in the format:
dd/Mmm/yyyy:hh:mm:ss TZ
where TZ is the time zone expressed as the number of hours
relative to the Coordinated Universal Time (Greenwich, England)
and is relative to the server. For example:
[31/Oct/1996:13:44:32 -0800]
GET filename File name (and path) requested by the client. If the client requests
a file that doesnt exist, UNKNOWN appears in place of a file name.
(Table Page 1 of 5)
86
RealProxy Administration Guide CHAPTER 11: Tracking RealProxy Activity
87
CHAPTER 11: Tracking RealProxy Activity RealProxy Administration Guide
88
RealProxy Administration Guide CHAPTER 11: Tracking RealProxy Activity
89
CHAPTER 11: Tracking RealProxy Activity RealProxy Administration Guide
LoggingStyle Results
The format of the proxy log under each of the different Logging Style values is
shown in the table below:
Logging Style Effect on Proxy Log
Logging Style
value Individual record format
0 client_IP_address - - [timestamp] "GET filename protocol/version"
HTTP_status_code bytes_sent [client_info] [client_id]
[proxy_info]
1 client_IP_address - - [timestamp] "GET filename protocol/version"
HTTP_status_code bytes_sent [client_info] [client_id] file_size
file_time sent_time resends failed_resends [proxy_info]
2 client_IP_address - - [timestamp] "GET filename protocol/version"
HTTP_status_code bytes_sent [client_info] [client_id] file_size
file_time sent_time resends failed_resends [proxy_info]
3 client_IP_address - - [timestamp] "GET filename protocol/version"
HTTP_status_code bytes_sent [client_info] [client_id] file_size
file_time sent_time resends failed_resends [stream_components]
start_time server_address [proxy_info]
(Table Page 1 of 2)
90
RealProxy Administration Guide CHAPTER 11: Tracking RealProxy Activity
91
CHAPTER 11: Tracking RealProxy Activity RealProxy Administration Guide
92
RealProxy Administration Guide CHAPTER 11: Tracking RealProxy Activity
93
CHAPTER 11: Tracking RealProxy Activity RealProxy Administration Guide
If you have values in all three boxes, RealProxy will use the size or time
period that is reached first.
4. When youre done, click Apply.
Rolled log files are named with the following format:
name.log.datestamp
where:
name Name of the regular log file. The name for proxy logs is taken
from the LogPath setting (usually rmaccess ).
log The log file extension.
datestamp The date stamp, in the following format:
YYYYMMDDHHMMSS
where:
YYYY Year.
MM Two digits of the month.
DD Date, in two digits. January would be 01.
HH Hour
MM Minutes
SS Seconds
Error Log
The error log contains both information and error messages about server
operation. By looking for patterns of errors, you can troubleshoot and correct
possible problems on your site.
View the text of the error log using a word processor or text editor.
The error log is an excellent tool for troubleshooting any problems that may
arise with your RealProxy. An entry is made to the error log only when an error
occurs. If no errors occur, this file will not exist.
Error messages relating to RealProxy activity appear in the error log. The error
log is created when the first error occurs.
94
RealProxy Administration Guide CHAPTER 11: Tracking RealProxy Activity
For a list of error messages that can appear in this file and what to do about
them, visit the RealNetworks technical support page at http://
service.real.com. If you have an entry that refers to a fatal error, contact the
RealNetworks Technical Support Department for assistance.
➤ To customize where RealProxy creates the error log:
1. In RealSystem Administrator, click General Setup. Click Logging.
2. In the Error Log Path box, type the path and name you want to use for the
error log. The default location is the Logs directory of the main RealProxy
directory, and the default file name is rmerror.log .
3. When you have finished making changes, click Apply.
95
CHAPTER 11: Tracking RealProxy Activity RealProxy Administration Guide
96
Appendix A: CONFIGURATION FILE SYNTAX A
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
This appendix describes the structure of the configuration file.
Comment Tags
Comment tags are used in the configuration file to identify the functions of
tags, but the comments arent required. XML comment tags are just like those
in HTML: they begin with <!-- and end with --> . RealProxy ignores these tags;
they are for your benefit.
For example, this comment tag lets the administrator know that the
parameters after it refer to the path settings:
<!-- P A T H S -->
97
APPENDIX A: Configuration File Syntax RealProxy Administration Guide
Tip
To disable a feature, convert the features tag or tags to a
comment. Rather than converting each tag to a
comment, edit only the features first opening tag and
last closing tag.
List Tags
The list tag uses the following syntax:
<List Name=name>
...
</List>
where name is the list title. Using the correct capitalization for name is
important.
Other lists or variables follow the list. The </List> tag signifies the end of the
list. If other lists are inside the original list, they must also have closing </List>
tags. The MIMETypes list is an example of a list that contains other lists.
Tip
Indenting list items is not required, but is recommended
for clarity.
Variable Tags
Variable tags use the following syntax:
<Var name=value/>
where name is the variable title, and value is a string or a number, depending on
the variable. Capitalization for both name and value is important.
Unlike lists, variables do not have a closing tag; instead, a forward slash mark
(/ ) appears before the closing angle bracket (> ).
Tip
If youve restarted RealProxy and its not responding to
a change youve made to a variable, make sure the
variable has a closing forward slash mark, and that there
is no space between them.
98
RealProxy Administration Guide APPENDIX A: Configuration File Syntax
99
Appendix B: CONFIGURATION FILE CONTENTS B
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
This appendix gives brief information about the contents of the
configuration file for those administrators interested in editing it
directly.
Warning
Exit RealSystem Administrator before opening the
configuration file with a text editor or unexpected
changes may result.
101
APPENDIX B: Configuration File Contents RealProxy Administration Guide
Ports
Port settings are described in Chapter 3: Configuring RealProxy Features.
MonitorPort is described in Chapter 10: Monitoring RealProxy Activity.
<Var MonitorPort="9090"/> The port which monitors (such as G2 Java
Monitor) connect to RealProxy.
<Var AdminPort="7845"/> Port number for RealSystem Administrator
connection.
Paths
LogPath and ErrorLogPath are described in Chapter 11: Tracking RealProxy
Activity. PIDPath is described in Chapter 5: Advanced Features. PluginDirectory
is described on Chapter 3: Configuring RealProxy Features. LicenseDirectory is
given on Chapter 2: Starting and Stopping RealProxy.
Windows Variables
Path variables, along with typical paths used in Windows NT and Windows
NT, are shown here.
<Var LogPath="C:\Program Files LogPath indicates where and with what
\Real\RealServer\Logs\proxy.log"/> name the proxy log will be stored. If omitted,
RealProxy places proxy.log in the Logs
directory.
<Var ErrorLogPath="C:\Program Files ErrorLogPath gives the path and name of the
\Real\RealProxy\Logs\proxyerr.log"/> error log file. If this setting is omitted,
RealProxy places proxyerr.log in the Logs
directory.
<Var PluginDirectory="C:\Program Files Shows where the plug-in files are stored.
Real\RealProxy\Plugins"/>
102
RealProxy Administration Guide APPENDIX B: Configuration File Contents
UNIX
One additional setting is found on RealProxy running on a UNIX system:
PIDPath .
RealProxy
Three sections refer specifically to RealProxy.
If you establish values for MaxProxyConnections, MaxProxyBandwidth ,
MaxGatewayBandwidth , and LowBitRateGateway, RealProxy will limit access when
the lowest threshold is reached.
<!-- P R O X Y S E R V E R-->
<List Name="Proxy">
<Var RTSPPort=1091/> Port number where RealProxy listens for
RTSP requests.
<Var PNAPort=1090/> Port number where RealProxy listens for
PNA requests.
103
APPENDIX B: Configuration File Contents RealProxy Administration Guide
104
RealProxy Administration Guide APPENDIX B: Configuration File Contents
</List>
RTSP Redirection
The RTSPRedirector list is used to instruct clients to contact RealProxy directly.
It requires that you use a third-party hardware or software router to redirect
the client requests to RealProxy. See Configuring RealProxy to Listen for Re-
Routed Client Messages on page 47 for more information.
<List Name="RTSPRedirector">
<Var Port="554"/> Port number where the redirect plugin
should listen for RTSP redirections from the
router.
<Var RedirectToAddress= RealProxy address to which the clients
"RedirectIPGoesHere"/> should directly address their requests.
<Var RedirectToPort="1091"/> RealProxy port number to which the clients
should directly address their requests.
</List>
<List Name="PNARedirector">
<Var Port="7070"/> Port number where the redirect plugin
should listen for PNA redirections from the
router.
<Var RedirectToAddress= RealProxy address to which the clients
"RedirectIPGoesHere"/> should directly address their requests.
<Var RedirectToPort="1090"/> RealProxy port number to which the clients
should directly address their requests.
</List>
MIME Types
Setting up RealProxy to send correct MIME type information with clips is
described in Chapter 2: Starting and Stopping RealProxy.
<List Name="MimeTypes">
<List Name="audio/x-pn-realaudio">
105
APPENDIX B: Configuration File Contents RealProxy Administration Guide
<Var Extension_01="ra"/>
<Var Extension_02="ram"/>
</List>
<List Name="application/x-pn-realmedia">
<Var Extension_01="rm"/>
</List>
<List Name="application/x-pn-realmedia">
<Var Extension_01="rt"/>
</List>
<List Name="application/x-pn-realmedia">
<Var Extension_01="rp"/>
</List>
<List Name="application/x-pn-realmedia">
<Var Extension_01="smi"/>
</List>
<List Name="application/sdp">
<Var Extension_01=smi/>
</List>
<List Name="text/html">
<Var Extension_01="html"/>
<Var Extension_02="htm"/>
</List>
<List Name="image/gif">
<Var Extension_01="gif"/>
</List>
<List Name="image/jpg">
<Var Extension_01="jpg"/>
<Var Extension_02="jpeg"/>
</List>
</List>
File Systems
The FSMount section of the configuration file gives the names of all the
configurable file system plug-ins in use. The plug-ins themselves are stored in
a directory indicated by the PluginDirectory variable.
106
RealProxy Administration Guide APPENDIX B: Configuration File Contents
All requests of the RealProxy are processed by plug-ins. Plug-ins control which
features are available. The modular plug-in design means that new features
can be programmed and easily substituted for the existing plug-ins. New plug-
ins may require different list arrangements and variables; check with the
developer of the plug-in for this information.
Additional Information
RealSystem G2 SDK Developer's Guide provides developers
with the public interfaces used to extend and customize
RealSystem G2 to stream new datatypes, create new
clients, or to customize RealProxy by building a new
plug-in.
ShortName Variable
Each list within FSMount gives a short name for the plug-in. The short name is
also stored within the plug-in file itself, and RealProxy uses this to identify the
correct file to use. To add a plug-in to your RealProxy, you must know the
name to use in the FSMount section; this name is supplied by the developer of
the plug-in. The short name is referenced with the ShortName variable in each
file systems list.
RealNetworks Plug-in Names
ShortName Windows Filename UNIX Filename Description
pn-local smpl3260.dll smplfsys.so.6.0 Local File System
pn-admin admi3260.dll adminfs.so.6.0 Admin File System
pn-splitter pull3260.dll pullplin.so.6.0 Pull Splitting File System
RealSystem Administrator
Two files systems work together to operate RealSystem Administrator: the
local file system and the administration file system.
The administration file system accepts the initial URL for RealSystem
Administrator. It requests the HTML files from the local file system. Once the
local file system delivers the HTML files, the administration file system looks
up your RealProxys values and displays them at the appropriate points in
RealSystem Administrator.
Three variables are used for the RealAdministrator list: ShortName , MountPoint ,
and BasePath .
107
APPENDIX B: Configuration File Contents RealProxy Administration Guide
<List Name="RealAdministrator">
<Var ShortName="pn-local"/> RealSystem Administrator uses the local file
system.
<Var MountPoint="/localadmin/"/> Mount point, used when
RealAdministrator_Files list requests files
from this plugin. The default value is
/localadmin/ . If you change this, be sure to
change the RealAdministrator_Files lists
BaseMountPoint to match.
<Var BasePath="C:\Program Files Location of the RealSystem Administrator
\Real\RealProxy files.
\RealAdministrator"/>
</List>
IP Binding
The ability to reserve specific addresses for RealProxys use is explained in
Chapter 5: Advanced Features. This list uses variables numbered sequentially:
108
RealProxy Administration Guide APPENDIX B: Configuration File Contents
Address_01, Address_02 , and so on. Use one for each IP address you want to set
aside for RealProxy. Use the RealProxys IP address or DNS name for each
variable; however, the IP address allows RealProxy to be more efficient.
RealProxy will bind to the specified addresses only; it will not bind to
localhost.
If you dont use any values for the variables in the IPBinding list, RealProxy
binds to the host IP address and localhost. It does not bind to any others.
<List Name="IPBinding">
<Var Address_01="0.0.0.0"/> Each variable gives an address to reserve for
use by RealProxy. To reserve all addresses,
set the address variable to 0.0.0.0 and
remove all other address variables from the
list.
</List>
Allowance
Settings in this section refer to the allowance plug-in. They are described in
Chapter 7: Limiting Access to RealProxy.
When set to On , ValidPlayerOnly sends a message to any clients other than
RealNetworks RealPlayer version 5.0 or RealNetworks RealPlayer G2 directing
them to upgrade to the latest version of RealPlayer. If set to Off , all clients can
receive all clips.
<Var ValidPlayersOnly="True"/> Allows only RealPlayer version 5.0 and
RealPlayer G2 to access content. Any other
clients attempting to view or listen to
content display a message directing them to
upgrade to the latest version of RealPlayer. If
ValidPlayerOnly is set to Off , all clients can
receive all clips. In Basic Server and Basic
Server Plus, this is set to On and cannot be
changed.
<Var MinPlayerVersion=2/> Sets the minimum RealPlayer version that
can access the content. To limit to version
2.0 and later, set MinPlayerVersion to 2 , and
so on. To allow only RealPlayer G2, set it to
6.
109
APPENDIX B: Configuration File Contents RealProxy Administration Guide
HTTP Support
This feature, which indicates the virtual directories whose content can be
streamed via HTTP, is explained in Chapter 7: Limiting Access to RealProxy.
Each Path variable gives the name of a virtual directory whose content can be
streamed via HTTP.
Be sure that Admin is on this list; Admin refers to RealSystem Administrator,
which is served via HTTP. And push splitting uses HTTP for the initial
connection conversation; add the push splitting mount point to this list,
usually farm .
<List Name="HTTPDeliverable">
<Var Path_01="/admin"/> Each Path variable gives the name of a
<Var Path_02="/localadminfs"/> mount point, directory or virtual directory
whose content can be streamed via HTTP.
<Var Path_03="/ramgen"/>
</List>
Access Control
Restricting access to RealProxy content via the requesting clients IP address is
described in Chapter 7: Limiting Access to RealProxy. For every address or
address range to which you want to restrict access, create a list with a unique
number. The number can be any length, but a number of more than one digit
is recommended in case more lists are added later; with multiple digits, the
new lists can be inserted between existing lists.
Each list is called a rule. Rules are processed in numerical order. RealProxy
searches the list of rules to find the first rule that matches the address.
Because RealProxy searches the list of rules in numerical order, make your
broadest categories first.
110
RealProxy Administration Guide APPENDIX B: Configuration File Contents
Within each list, the following settings are used: Access , Transport , To , From , and
a list named Ports .
<List Name="AccessControl">
<List Name="100">
<Var Access="Allow"/> Whether access is allowed or denied: set to
Allow or Deny.
<Var Transport="TCP"/> Transmission method being accessed. TCP is
the only option for this list.
<Var To="127.0.0.1"/> Address of the host RealProxy or network
card of hosting machine. Use specific
address or Any.
<Var From="any"/> Address of the client computer whose access
you are limiting. Use specific address or Any.
To specify a range of IP addresses, either
place a colon after the IP address and give
the full subnet mask, or place a slash mark
after the IP address and give the number of
bytes for the subnet mask. For example, the
following are equivalent values to use in the
From variable: 172.16.3.0:255.255.255.0
and 172.16.3.0/24 . Both examples specify
the range of addresses from 172.16.3.0 to
172.16.3.254.
<List Name="Ports"> List of ports to which access is restricted.
<Var Port_01="554"/> The port number should match the port
<Var Port_02="4040"/> numbers which RealProxy is using for other
features, such as RTSPPort .
<Var Port_03="5050"/>
<Var Port_04="7070"/>
<Var Port_05="8080"/>
<Var Port_06="9090"/>
</List>
</List>
</List>
Splitting
Only three variables appear in the pull splitting section: ShortName ,
MountPoint , and Port . The source RealProxy and the source splitter have the
same information in their Splitter_DoubleURL sections, but each system is
111
APPENDIX B: Configuration File Contents RealProxy Administration Guide
interested in different information: the RealProxy looks at the Port value, and
the splitter looks at the mount point.
Warning
If you change these settings, RealProxy will not be able
to operate in bitsave mode.
<List Name="Splitter_DoubleURL">
<Var ShortName="pn-splitter"/> Short name of the pull splitting plugin.
Default is pn-splitter.
<Var MountPoint="/split/"/> Mount point. Used in URLs that reference
pull splitting streams. Default is /split/.
<Var Port="3030"/> Port number to which the source RealProxy
will listen for pull splitting requests.
</List>
Multicasting
Back-channel multicasting is described in Chapter 9: Multicasting Live
Streams.
Settings used with this list are AddressRange, DeliveryOnly, RTSPPort , Resend ,
and TTL .
<List Name="Multicast">
<Var AddressRange=""/> Range of addresses to which you want to
send streams, in the form of address -address .
RealProxy uses the first available address in
this range. If you are using other types of
multicast, be sure that the address ranges are
different and do not overlap. If your
multicast streams are referenced in SMIL
files, you will need one address for each
stream.
<List Name="ControlList"> The ControlList list gives the addresses of
clients allowed to receive multicast
transmissions.
<Var Allow= Address and netmask, separated by a colon,
"164.16.2.24:255.0.0.0"/> of clients allowed to receive multicast
</List> transmissions. Uses same format as From
variable in AccessControl list.
112
RealProxy Administration Guide APPENDIX B: Configuration File Contents
Authentication
Authentication is used to verify the identity of users who access RealSystem
Administrator. It ensures that only the people youve authorized can make
changes to RealProxy.
Additional Information
RealProxy uses a subset of the authentication features
available to RealServer. For more information on
authentication, refer to RealServer Administration Guide.
Authentication Realms
A realm is a way of associating a group of users and the protocol used to verify
their credentials.
Each sublist of AuthenticationRealms gives properties for a different realm.
Every realm has a name (identified by the Realm variable), and a list that
identifies what type of authentication is used in that realm. Depending on
which authentication type you choose, different variables are required within
the sublist.
<List Name="AuthenticationRealms">
<List Name="SecureAdmin"> A realm.
<Var Realm="AdminRealm"/> Name of this realm.
<List Name=BasicAuthenticator/>
<Var PluginID=rn-auth-basic/> Security type.
<Var DatabaseID=Admin_Basic/>
113
APPENDIX B: Configuration File Contents RealProxy Administration Guide
</List>
</List>
</List>
Databases List
The databases list stores usernames and passwords of authorized users.
Within the list, sublists associate database plugins with location information.
The options available to each sublist are PluginID, Path, DBName ,
DBLoginPassword , and DBLoginPassword . The last two are only required if the
PathToDBPlugin is set to ppvm3260 or ppvo3260 .
<List Name="Databases">
<List Name="Admin_Basic">
<Var PluginID="rn-db-flatfile"/> Name of plugin that will interact with the
database.
<Var Path="C:\Program Files Location where the database files are stored
\Real\RealProxy\adm_b_db"/> or will be stored.
</List>
Passwords
MonitorPassword is described in Chapter 10: Monitoring RealProxy Activity.
<Var MonitorPassword="letmein"/> Password used by G2 Java Monitor in
connecting to RealProxy.
Logging
Logging and reporting features are described in Chapter 11: Tracking
RealProxy Activity. Variables which control the locations of the access and
error log files are described in Paths on page 102 of this chapter.
Disable log file rolling by changing the LogRollFrequency and LogRollSize
variables to 0 .
114
RealProxy Administration Guide APPENDIX B: Configuration File Contents
115
APPENDIX B: Configuration File Contents RealProxy Administration Guide
116
Appendix C: FILES INCLUDED WITH REALPROXY C
This manual describes a pre-release product. As such, some features may not be
fully implemented; any information here is subject to change.
This appendix lists the files used by RealProxy.
RealProxy Directories
Directory Description
adm_b_db For authenticating RealSystem Administrator users,
this directory stores names of authenticated users.
Bin Utility programs are stored here. (More information is
shown below.)
Content Sample media presentations are stored in this
directory; you can view them from RealSystem
Administrator by clicking Samples.
Lib Support libraries.
License Contains license file(s). (More information is shown
below.)
Logs Reports of RealProxy will go in this directory. (More
information is shown below.)
Plugins Plugins, which perform RealProxy functions, are stored
here.
RealAdministrator HTML and other files required by RealSystem
Administrator.
The table below shows the files stored in the main RealProxy directory.
Main Directory
Windows UNIX Description
rmserver.cfg rmserver.cfg The configuration settings for RealProxy.
readme.txt readme.txt Last minute updates and changes.
117
APPENDIX C: Files Included with RealProxy RealProxy Administration Guide
Bin Directory
Windows UNIX Description
mkpnpass.exe mkpnpass Password tool (used for changing passwords
of RealSystem Administrator users)
rmserver.exe rmserver RealProxy executable
Lib Directory
Windows UNIX Description
proxylib.lib proxylib.lib RealProxy Support Library
encn3260.dll encn.so.6.0 Broadcasting Support Library
License Directory
Windows UNIX Description
proxy.key proxy.key License file.
Logs Directory
Windows UNIX Description
proxy.log proxy.log Proxy access log
log.txt log.txt Log text file
proxyerr.log proxyerr.log Error Log
Plugins Directory
Windows UNIX Description
admi3260.dll adminfs.so.6.0 RealNetworks Admin File System
allo3260.dll allow.so.6.0 RealNetworks Basic Allowance Plugin
audp3260.dll audplin.so.6.0 RealNetworks Renderer Plugin
auth3260.dll authmgr.so.6.0 RealNetworks Authentication Manager
(Table Page 1 of 3)
118
RealProxy Administration Guide APPENDIX C: Files Included with RealProxy
Plugins Directory
Windows UNIX Description
basc3260.dll bascauth.so.6.0 RealNetworks Basic Authenticator
dbmg3260.dll dbmgr.so.6.0 RealNetworks Database Manager
dbwr3260.dll dbwrap.so.6.0 RealNetworks 5.0 Database Wrapper
farm3260.dll farmplin.so.6.0 RealNetworks Farm Split Broadcast Plugin
ntau3260.dll ntau.so.6.0 RealNetworks NTLM Authenticator
ntlo3260.dll ntlo.so.6.0 RealNetworks NT Logger
perf3260.dll perf.so.6.0 RealNetworks RMA Performance Monitor
plog3260.dll plog.so.6.0 RealNetworks Proxy Logging Plugin
plus3260.dll plusplin.so.6.0 RealNetworks PlusURL File Format Plugin
ppvb3260.dll ppvbasic.so.6.0 RealNetworks FlatFile Database Plugin
ppvmsql.so.6.0 RealNetworks mSQL Database Plugin
pxcb3260.dll pxcbmp.so.6.0 RealNetworks RealPix BMP Codec Plugin
pxcg3260.dll pxcgif.so.6.0 RealNetworks RealPix GIF Codec Plugin
pxcj3260.dll pxcjpeg.so.6.0 RealNetworks RealPix JPEG Codec Plugin
pxcs3260.dll RealNetworks RealPix STNG Codec Plugin
pxff3260.dll pxff.so.6.0 RealNetworks RealPix Format Plugin
pxfx3260.dll pxexfx.so.6.0 RealNetworks RealPix External Effect Sam
pxgf3260.dll pxgf.so.6.0 RealNetworks GIF File Format Plugin
pxjf3260.dll pxjf.so.6.0 RealNetworks JPEG File Format Plugin
redi3260.dll redipln.so.6.0 Real Networks RTSP Redirector Plugin
rmff3260.dll rmffplin.so.6.0 RealNetworks RealMedia File Format Plugi
rn5a3260.dll rn5auth.so.6.0 RealNetworks RN5 Authenticator
rprx3260.dll rprxypln.so.6.0 RealNetworks RTSP Proxy Plugin
rtff3260.dll rtffplin.so.6.0 RealNetworks RealText File Format Plugin
sdpp3260.dll sdpplin.so.6.0 RealNetworks SDP Stream Description Plug
smlf3260.dll smlffpln.so.6.0 RealNetworks SMIL File Format Plugin
smon3260.dll smonplin.so.6.0 RealNetworks System Monitor
smpl3260.dll smplfsys.so.6.0 RealNetworks Local File System
splt3260.dll spltplin.so.6.0 RealNetworks Splitter Broadcast Plugin
swff3260.dll swff.so.6.0 Shockwave Flash Format Plugin
vidp3260.dll vidplin.so.6.0 RealNetworks Renderer Plugin
(Table Page 2 of 3)
119
APPENDIX C: Files Included with RealProxy RealProxy Administration Guide
Plugins Directory
Windows UNIX Description
vivf3260.dll vivff.so.6.0 VivoActive File Format Plugin
exca3260.dll excache.so.6.0 Example cache plugin
miip3260.dll miiplin.so.6.0 Media Import plugin
sbmo3260.dll sbmonpln.so.6.0 Splitter Monitor plugin
(Table Page 3 of 3)
120
INDEX
121
Index RealProxy Administration Guide
122
RealProxy Administration Guide Index
123
Index RealProxy Administration Guide
U unicasting, 76
UNIX
PID, 54
SIGHUP, 54
special features, 54
starting RealProxy, 33
stopping RealProxy, 34
W Web server
and RealProxy, 43, 51
log format, 86
MIME types on, 34
Windows NT
Performance Monitor, 54
running multiple instances of RealProxy,
32
special features, 53
stopping RealProxy, 32
X XML
configuration file, 41, 97
license files, 36
XML declaration tag, 97
124