Appendix C: Configuration File Contents

This appendix gives brief information about the contents of the configuration file for those administrators interested in editing it directly.

Editing the Configuration File

For those RealServer administrators who prefer to modify features by editing the configuration file directly, this appendix shows sample configuration file contents with brief descriptions. Detailed descriptions can be found in the chapters that describe each subject.

The default name of the configuration file is rmserver.cfg, but if you have multiple Servers you may want to rename the files so as to easily identify which server you're working with.

To modify the configuration file with a text editor:

1. Please read Appendix B, "Configuration File Syntax", which explains the structure of this file.

2. Save a backup copy of the configuration file.

3. Open the configuration file, and make any changes you like.

   Be sure to use correct syntax, because RealServer looks for exact spellings and correct use of angle brackets. RealServer does not display messages related to syntax errors; instead, it will ignore those settings it does not understand. It may use minimal settings. See "Minimum Licensed Features".

4. Restart RealServer after changing any settings with a text editor.

RealSystem Administrator and the Configuration File

Information elsewhere in this manual on customizing RealServer features is based on the settings that appear in RealSystem Administrator. However, RealSystem Administrator mostly displays only those settings that will be changed in everyday use. Other items, such as the file system short name of the basic mount points, are not accessible through RealSystem Administrator. By viewing the configuration file and reading this section you will see the complete listing of settings for each feature.

	Tip
	A fast way to understand the structure of the configuration file is to first use RealSystem Administrator to make changes, and then examine the configuration file to see the effects. Noticing how lists are created and changed will be especially helpful. Note that you must exit RealSystem Administrator before opening the configuration file with a text editor or unexpected changes may result.

Some Observations About Variables

Most configuration file variable names closely match names in RealSystem Administrator. When there is a difference between the way it is configured in RealSystem Administrator and the actual variable name, the difference is noted here. RealSystem Administrator frequently adds spaces to the variable names (BasePath becomes Base Path, for instance), and those changes are not noted in this appendix.

Some variables, which are not part of lists, can appear anywhere in the configuration file, but are grouped here for clarity.

Variables that use true or false values (such as PlusOnly, the variable that determines whether RealPlayer Plus, rather than the free versions of RealPlayer, can play streams from your RealServer) may be represented in the configuration file with a 1 or the word True. In RealSystem Administrator, a choice of On, Yes, or Enabled usually corresponds to 1 or True in the configuration file, while Off, No, or Disabled usually corresponds to 0 or False. Within the configuration file, you may use either 1 or True to represent the positive condition, and 0 or False for the negative.

For example, <Var PlusOnly="True"/> and <Var PlusOnly="1"/> are equivalent statements.

RealServer Features in the Configuration File

Ad Streaming

Configuration elements of the ad streaming feature are not listed here, as the feature is designed to be configured only with RealSystem Administrator. Ad streaming elements appear within the FSMount section of the configuration file. Ad streaming is described in Chapter 20, "Streaming Targeted Ads".

Access Control

Restricting access to RealServer content via the requesting client's IP address is described in Chapter 14, "Limiting Access to RealServer". 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. RealServer searches the list of rules to find the first rule that matches the address. Because RealServer searches the list of rules in numerical order, make your broadest categories first.

Within each list, the following settings are used: Access, Transport, To, From, and a list named Ports.

Allowance

Settings in this section refer to the allowance plug-in. They are described in Chapter 14, "Limiting Access to RealServer".

If you establish values for both ClientConnections and MaxBandwidth, RealServer will limit access when the lower threshold is reached.

When set to On, ValidPlayerOnly sends a message to any clients other than RealNetworks RealPlayer 5 or RealNetworks RealPlayer 6 directing them to upgrade to the latest version of RealPlayer. If set to Off, all clients can receive all clips. In the free downloadable versions of RealServer, this is set to On and cannot be changed.

<Var ValidPlayersOnly="True"/>

<Var MinPlayerProtocol="0"/>

<Var PlusOnly="False"/>

Authentication and Commerce

Authentication is described in Chapter 15, "Authenticating RealServer Users".

There are four areas that apply to authentication in the configuration file, and each of these four areas is in a separate list. The four main areas refer to each other, but are kept separate for flexibility. Two separate secure paths might use the same realm (and therefore the same database) to perform the same type of authentication for content kept in different locations. This enables different types of content to share the same list of authorized users.

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 (see the "AuthenticationRealms PluginID Settings" table). When RealServer is installed on a Windows NT system, you can take advantage of NT authentication and direct RealServer to use the list of authorized users.

Commerce Rules List

The commerce rules list associates part of an URL with authentication. When RealServer looks through the URL to decide which plug-in should process the request, it compares each section of the URL with the ProtectedVirtualPath. Should this match, RealServer looks at the other information within the list to determine which realm protects the content, and which database lists the permissions (if any).

Each sublist within SecureContent associates the mount point with the information. The mount point for RealSystem Administrator does not need to go here.

Variables used with sublists are ProtectedVirtualPath, Realm, UseGUIDValidation, EvaluatePermissions, AllowDuplicateIDs, and DatabaseID. Use Realm or UseGUIDValidation, but not both.

Player Authentication

In player authentication, the client sends a special string to RealServer indicating that the client is registering. The GUIDRegistrationPrefixes list identifies the special string (the GUIDRegistrationPrefix variable) and the database in which to store the player identification. You must embed this string in the link on the Web page.

Two variables are required for each sublist: GUIDRegistrationPrefix and DatabaseID.

Databases List

The databases list is the master list of available databases for each type of authentication. Databases store usernames and passwords of authorized users.

Within the list, sublists associate database plug-ins with location information.

In the examples shown here, PluginID is always set to rn-db-flatfile. There is only one variable associated with rn-db-flatfile, but other values for PluginID require different variables. Refer to the "Databases PluginID Settings" table.

The table below shows the variables required for each data storage method.

Each data store method requires different variables. The table below shows the significance of each variable.

Secure Content

Within the FSMount list, one section refers to authentication. It uses three variables: ShortName, MountPoint, and BasePath.

Broadcast Redundancy

This feature is described in Chapter 4, "Sources of Content". The settings shown in the table below appear in their own section of the configuration file.

There are also elements in the FSMount section of the configuration file related to this feature.

Caching

This section enables media caches to request and cache streams on behalf of clients. Caching is described in Chapter 8, "Advanced Features".

To selectively block media caches from requesting your content, add the media cache's IP address to the AccessControl list. In addition to specifying the IP address, indicate the port number to which access should be denied (usually 7802).

To block all media cache requests, set TSEnable to False.

To disable logging of cache requests, set the TSLog variable to 0.

Encoders

Both encoding lists appear within the FSMount section.

Encoders

Receiving streams from both RealSystem Encoders and earlier versions are explained in Chapter 11, "Unicasting Live Presentations". These variables are used in this list: ShortName, MountPoint, Port, and EncoderRealm.

Unlike other plug-ins, encoder lists cannot have multiple mount points.

Pre-RealSystem G2 Encoders

The list for encoders such as RealEncoder and RealPublisher versions 5 and earlier uses these variables: ShortName, MountPoint, Port, Realm, and Password.

Unlike other plugins, encoder lists cannot have multiple mount points.

File Systems (FSMount)

The FSMount section 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.

All requests of the RealServer 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 SDK Developer's Guide provides developers with the public interfaces used to extend and customize RealSystem to stream new data-types, create new clients, or to customize RealServer by building a new plug-in.

Several features are listed within the FSMount list, but they are shown in their own sections in this appendix. Those features include:

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 RealServer uses this to identify the correct file to use. To add a plug-in to your RealServer, 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.

Plug-In Names

Local File System

The local file system, which handles requests for nearly all streamed media content, is described in Chapter 3, "Overview of RealServer". In RealSystem Administrator, this section is configured on the Mount Points page.

The local file system handles requests for static media clips. It uses the variables ShortName, MountPoint and BasePath.

If clips are stored on more than one disk drive, add multiple local file system lists, each with its own mount point. The list names need to be unique.

HTTP Support

Two lists refer to sending and receiving information via HTTP: HTTPDeliverable and HTTPPostable.

HTTPDeliverable

This feature indicates the mount points, virtual directories, or directories whose content can be streamed via HTTP. It is explained in Chapter 14, "Limiting Access to RealServer".

Each Path variable gives the name of a virtual directory whose content can be streamed via HTTP. Be sure that the following mount points are on this list:

• admin-refer to RealSystem Administrator, which is served via HTTP

• ramgen-clips streamed with Ramgen may be requested in HTTP format

• scalable-clients receive some data via HTTP

• viewsource-view source features use HTTP for browsing

  HTTP Deliverable List Configuration Elements

  Element	Description
  <List Name="HTTPDeliverable">
  <Var Path_0="/admin"/>	Each Path variable gives the name of a mount point, path, or virtual path whose content can be streamed via HTTP.
  <Var Path_01="/ramgen"/>
  <Var Path_02="/httpfs"/>
  <Var Path_03="/viewsource"/>
  </List>

HTTPPostable

Like the list described above, the HTTPPostable list enables virtual directories to receive data from clients.

Each Path variable gives the name of a virtual directory whose content can be streamed via HTTP.

The only item on this list is scalable, and that only needs to appear if the multicast feature is set to send client statistics (SendClientStatistics="True").

There is no way of configuring this list directly in RealSystem Administrator; however, if you use RealSystem Administrator to choose Send Client Statistics, RealSystem Administrator will create the list automatically.

</List>

ISP Hosting

The ISPHosting list contains two other lists: TranslationMounts (which contains one or more lists) and UserLists. Variables are MountPoint, UserPath, and File. ISP Hosting settings are described in Chapter 17, "ISP Hosting".

ISP Hosting scenarios frequently require special base paths, so you will need to create additional mount points in the FSMount list. Examples are shown in this section.

Four items control where RealServer looks for hosted media:

1. In the user list file, /path/ groups the users. In the configuration file, UserPath has the same value as /path/, or with a portion of it.

2. Within the TranslationMounts list (of the ISPHosting list), UserPath is associated with the MountPoint variable.

3. The MountPoint variable of the TranslationMounts list matches a MountPoint variable in the FSMount section of the configuration file.

4. The MountPoint variable of the FSMount list is associated with a BasePath variable. The directory shown by BasePath is where user directories are located.

Through this path of associated elements, the value for /path/ in the user list file is ultimately associated with a base path.

It is optional, but common, to create special mount points in the FSMount section.

How RealServer Looks for Users' Content (Account-Based Hosting)

RealServer uses a combination of the URL, user list file, and the configuration file to determine where to look for user files.

This section describes how RealServer processes all requests when ISP Hosting is in use:

1. When it receives a request for content, RealServer looks at the account name after the tilde (~).

2. It looks through the user list for a matching account information.

   If your user list contains individual account names, RealServer searches these to find a match. If it doesn't find an exact match, it uses the generic account information.

3. Once it finds a match (or the generic information), it looks at the /path/ value. The /path/ information matches the UserPath variable in the configuration file. This is not a physical path; it is used only for the next step, and serves as a way to group user account names logically.

4. Using the /path/ information, RealServer goes to the ISPHosting list of the configuration file, where it looks within the TranslationMounts list for a matching UserPath. Once it finds a match, RealServer records the MountPoint located within the same list. This translates the logical path to a file system.

5. Next, RealServer looks in the FSMount list for a file system whose mount point matches the MountPoint from the ISPHosting list. Once it finds the correct mount point, RealServer notes the associated BasePath.

6. The media will be in a directory relative to BasePath.

Typically, users' content is mapped to a special ISP hosting mount point and base path. User directories are located under the base path.

Example

In the following example, an ISP in the northwest United States has divided its users by geographical location.

Example-User List File

The user list file groups the users in the WA and OR groups, and instructs RealServer to look for all other users in the ID path.

Example-ISPHosting Section

The ISPHosting section of the configuration file maps the UserPaths to mount points. In this example, each list within the TranslationMounts section maps part of each user path to its own mount point.

<List Name="ISPHosting">
<List Name="TranslationMounts">
<List Name="Washington Users">
<Var MountPoint="/wa_isp/"/>
<Var UserPath="/wa/"/>
</List>
<List Name="Oregon Users">
<Var MountPoint="/or_isp/"/>
<Var UserPath="/or/"/>
</List>
<List Name="Idaho Users">
<Var MountPoint="/id_isp/"/>
<Var UserPath="/id/"/>
</List>
</List>
<List Name="UserLists">
<Var File="c:\users\userlist1.txt"/>
</List>
</List>

Example-FSMount Section

The FSMount section of this example uses the same file system, pn-local, for each group of ISP users.

<List Name="FSMount">
...other mount points...
  <List Name="ISP Content (Washington users)">
    <Var ShortName="pn-local"/>
    <Var MountPoint="/wa_isp/"/>
    <Var BasePath="c:\home\washington"/>
  </List>
  <List Name="ISP Content (Oregon users)">
    <Var ShortName="pn-local"/>
    <Var MountPoint="/or_isp/"/>
    <Var BasePath="c:\home\oregon"/>
  </List>
  <List Name="ISP Content (Idaho users)">
    <Var ShortName="pn-local"/>
    <Var MountPoint="/id_isp/"/>
    <Var BasePath="c:\home\idaho"/>
  </List>
...other mount points...
</List>

Example-User Directories

User directories are stored under directories according to the state where the accounts are based:

C:\home\washington\canderson
C:\home\washington\pbrown
C:\home\oregon\ladams
C:\home\oregon\schu
C:\home\idaho\alex
C:\home\idaho\sam
C:\home\idaho\tracy

	Note
	Notice that the actual directories where the users' content is stored is different from the /path/ shown in the user list file. The /path/ information is actually a method of grouping users.

How RealServer Looks for Users' Content (Dedicated Hosting)

On RealServers dedicated to ISP hosting, the process for locating files is slightly different:

1. When it receives a request for content, RealServer looks at the directories in the URL. It uses the number of directories indicated by number in the user list file.

2. Using the /path/ information in the user list, RealServer goes to the ISPHosting list of the configuration file, where it looks within the TranslationMounts list for a matching UserPath. Once it finds a match (it looks for the longest possible match), RealServer records the MountPoint located within the same list. This translates the logical path to a file system.

3. Next, RealServer looks in the FSMount list for a file system whose mount point matches the MountPoint from the ISPHosting list. Once it finds the correct mount point, RealServer notes the associated BasePath.

4. The media will be in a directory relative to BasePath.

Typically, users' content is mapped to a special ISP hosting mount point and base path. User directories are located under the base path.

IP Binding

The ability to reserve specific addresses for RealServer's use is explained in Chapter 8, "Advanced Features". This list uses variables numbered sequentially: Address_01, Address_02, and so on. Use one for each IP address you want to set aside for RealServer. Use the RealServer's IP address or DNS name for each variable; however, the IP address allows RealServer to be more efficient.

RealServer will bind to the specified addresses only; it will not bind to localhost.

If you don't use any values for the variables in the IPBindings list, RealServer binds to the host IP address and localhost. It does not bind to any others.

</List>

Distributed Licensing

This feature is best configured with RealSystem Administrator; consult "Distributed Licensing".

Live Archiving

The live archive feature is described in Chapter 11, "Unicasting Live Presentations".

For every virtual directory of live streams that you want to archive, create a list. The list must have the same name as the virtual directory. To archive all streams that arrive at the main content directory, name the list with an asterisk (*).

When live archiving is enabled, RealServer examines all arriving live streams, and compares the names of the streams with the list names in the configuration file. If it contains a list whose name matches the virtual path name of the incoming live stream, RealServer will archive the file. If no matching list name is found, RealServer does not archive the file. Files are archived in locations specified by TargetDirectory.

Each list must include either TargetDirectory (to indicate where to store the archived streams) or NoArchive (to indicate that the streams should not be archived); optional variables are BandwidthNegotiation, FileSize, and FileTime.

</List>

The table below shows sample values for FileTime.

Logging

Logging and reporting features are described in Chapter 19, "Reporting RealServer Activity". Variables which control the locations of the access and error log files are described in "Paths" of this chapter .

<Var StatsMask="0"/>

<Var DisableClientGUID="0"/>

<Var LogRollFrequency="4W"/>

<Var LogRollSize="5"/>

<Var ErrorLogRollFrequency="1W"/>

<Var ErrorLogRollSize="3"/>

Disable access log file rolling by changing the LogRollFrequency and LogRollSize variables to 0. Disable error log file rolling by changing the ErrorLogRollFrequency and ErrorLogRollSize variables to 0.

MIME Types

Setting up RealServer to send correct MIME type information with clips is described in Chapter 6, "Starting and Stopping RealServer".

Multicasting

Two methods of multicasting are available: back-channel and scalable. Multicasting methods are described in Chapter 13, "Multicasting Live Presentations". Both methods can send SAP information, described in the next section.

SAP Information

The SAP list gives information about the Session Announcement Protocol files that can be sent to programs configured to read them. See"Publicizing Your Multicasts" for information.

In addition to the information on this list, you will also indicate whether to send SAP files in each scalable multicast list, and in the back-channel multicast list. Three variables appear in the SAP list: ListenAnnouncement, SendAnnouncementEnabled, and HostAddress.

Back-Channel Multicasting

Back-channel multicasting is described in "Back-Channel Multicasting" .

Settings used with this list are Enabled, AnnounceSAP, AddressRange, DeliveryOnly, PNAPort, RTSPPort, Resend, and TTL.

Scalable Multicasting

Unlike back-channel multicasting settings, scalable multicasting settings are located within the FSMount list. Scalable multicasting is described in "Scalable Multicasting" .

Located within the FSMount list, scalable multicasting uses the following variables:

Optional variables include ReuseAddress, AlternateURL, ShiftToUnicast, SendClientStatistics, WebServerAddress, WebServerPort, and WebServerCGIPath.

Create one list within the Sources list for every virtual path you want to make available for scalable multicasting.

Be sure to add the mount point to the HTTPDeliverable list.

Passwords

MonitorPassword is described in Chapter 18, "Monitoring RealServer Activity".

Paths

LogPath and ErrorLogPath are described in Chapter 19, "Reporting RealServer Activity". PluginDirectory is described on Chapter 7, "Customizing RealServer Features". LicenseDirectory is given on Chapter 6, "Starting and Stopping RealServer".

Windows Variables

Path variables, along with typical paths used in Windows and Windows NT, are shown here.

UNIX Variables

One additional setting is found on RealServer running on a UNIX system: PidPath. See "Process ID (PID)".

Ports

Port settings for RTSPPort, PNAPort, and HTTPPort are described in Chapter 7, "Customizing RealServer Features". MonitorPort is described in Chapter 18, "Monitoring RealServer Activity".

<Var PNAPort="7070"/>

<Var HTTPPort="8080"/>

<Var MonitorPort="9090"/>

<Var AdminPort="7845"/>

Ramgen

Ramgen is described in"Ram Files and Ramgen" and in RealSystem Production Guide. There are only two variables associated with Ramgen: ShortName and MountPoint.

This list is located within the FSMount section.

</List>

RealSystem Administrator

Two file 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 RealServer's values and displays them at the appropriate points in RealSystem Administrator.

Three variables are used for the RealAdministrator list: ShortName, MountPoint, and BasePath.

Five variables are use in the RealAdministrator_Files list: ShortName, MountPoint, Authorized_User_Group, Authentication, and Realm.

This tool is described in Chapter 7, "Customizing RealServer Features".

Splitting

Chapter 12, "Splitting Live Presentations" describes this feature.

In addition to the special settings required on the transmitter and on the receiver, splitting information is located in the FSMount list.

All the settings shown are required; only MountPoint can be changed by the user.

Transmitter Settings

Settings necessary for the transmitter to send its live streams to receivers are shown below. The following variables are optional on the transmitter:

Receiver Settings

Settings necessary for the receiver are shown below. Optional settings are:

If pull splitting is in use, these settings are optional:

UNIX-Only Settings

These settings are also described in "UNIX-Only Features".

View Source

The view source feature is described in "Displaying Source Code for SMIL Files and Media Clips".

The following variables are in use for view source:

In addition, the view source feature adds settings to other lists within the configuration file. It adds a plug-in listing to the Real System Administrator SSI list. Also, it requires an entry in the HTTPDeliverable list.

Settings in the Content Browsing section refer to the content browsing feature of view source.

Variables are:

• Mount (Mount_1, Mount_2, and so on)

• Ext (Ext_1, Ext_2, and so on)

  View Source Content Browsing Elements

  <!-- C O N T E N T B R O W S I N G -->	Content browsing section of configuration file.
  <List Name="ContentBrowsing">
  <List Name="BrowsableMountPoints">	List of mount points for which content browsing is enabled.
  <Var Mount_1="/"/>	Create one Mount variable for each mount point that you want to be able to browse.
  </List>
  <List Name="IndexExtensions">	List of file extensions which will be included in content browsing.
  <Var Ext_1="*"/>	An asterisk (*) refers to all extensions. Otherwise, create one Ext variable for each extension. For example, <Var Ext_2=".smi"/>.
  </List>
  </List>

The following entries appear within the FSMount list.

Features Available Only Through Direct Editing

Some of the more specialized lists and variables are only configurable by editing the configuration file directly; they cannot be changed via RealSystem Administrator.

These elements are:

• Most settings that would affect the use of RealSystem Administrator, such as the file systems used by the various RealSystem Administrator components.

• Short names of plug-ins, which most users are unlikely to change.

• Platform-specific variables, such as those described in "UNIX-Only Settings" (Group and User).

• PidPath variable. See "UNIX Variables".

• HTTPPostable list, for specifying which directories can receive data. Described in "HTTP Support".

• LicenseDirectory variable, which tells RealServer where to look for the license key file. Described in "Paths".

• MinPlayerProtocol variable, for giving the minimum client version that can receive content. See "Allowance".

• MonitorPassword variable, the password used by RealSystem Administrator in connecting to the Java Monitor. Described in "Passwords".

• PluginDirectory variable; gives the location of the Plugin directory. See "Paths".

• Some splitting variables, specifically SAPTransmissionEnabled, RedundancySendInterval, SessionTimeout, and UseTCPForPullBackchannel. See "Splitting".

• SupportPluginDirectory variable; gives the location of the Lib directory. See "Paths".

Copyright © 2000 RealNetworks
For information on RealNetworks' technical support, click here.
Comments on this document? Click here.
This file last updated on 11/28/00 at 17:35:17.