ADOBE FLASH MEDIA SERVER 3.

5 Configuration and Administration Guide
® ®

Last updated 3/2/2010

© 2009 Adobe Systems Incorporated. All rights reserved.
Copyright

Adobe® Flash® Media Server 3.5 Configuration and Administration Guide If this guide is distributed with software that includes an end user agreement, this guide, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Adobe Systems Incorporated. Please note that the content in this guide is protected under copyright law even if it is not distributed with software that includes an end user license agreement. The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this guide. Please remember that existing artwork or images that you may want to include in your project may be protected under copyright law. The unauthorized incorporation of such material into your new work could be a violation of the rights of the copyright owner. Please be sure to obtain any permission required from the copyright owner. Any references to company names in sample templates are for demonstration purposes only and are not intended to refer to any actual organization. Adobe, the Adobe logo, Adobe AIR, ActionScript, and Flash are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Java is a trademark or registered trademark of Sun Microsystems, Inc. in the United States and other countries. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Red Hat is a trademark or registered trademark of Red Hat, Inc. in the United States and other countries. UNIX is a registered trademark of The Open Group in the US and other countries. Windows is either a registered trademark or a trademark of Microsoft Corporation in the United States and/or other countries. Mac, Macintosh, and Mac OS are trademarks of Apple Inc., registered in the United States and other countries. All other trademarks are the property of their respective owners. This work is licensed under the Creative Commons Attribution Non-Commercial 3.0 License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/3.0/us/ Portions include software under the following terms: Sorenson Spark™ video compression and decompression technology licensed from Sorenson Media, Inc. Speech compression and decompression technology licensed from Nellymoser, Inc. (www.nellymoser.com) Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA. Notice to U.S. Government End Users. The Software and Documentation are “Commercial Items,” as that term is defined at 48 C.F.R. §2.101, consisting of “Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §§227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions herein. Unpublished-rights reserved under the copyright laws of the United States. Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For U.S. Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60, 60-250, and 60-741. The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference.

Last updated 3/2/2010

iii

Contents
Chapter 1: Deploying the server Deploying servers in a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Deploying edge servers ................................................................................................ 1

Chapter 2: Configuring the server Provisioning the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Working with configuration files Configuring performance features Configuring security features Configuring content storage ....................................................................................... 9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Performing general configuration tasks Configuring Apache HTTP Server

Chapter 3: Using the Administration Console Connecting to the Administration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Inspecting applications Manage administrators Managing the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Chapter 4: Monitoring and Managing Log Files Working with log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Access logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Application logs Diagnostic logs

Chapter 5: Administering the server Start and stop the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Checking server status Checking video files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Clearing the edge server cache Managing the server on Linux

Chapter 6: Using the Administration API Working with the Administration API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Chapter 7: XML configuration files reference Adaptor.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Application.xml file Logger.xml file Server.xml file Users.xml file Vhost.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE iv
Contents

Chapter 8: Diagnostic Log Messages Message IDs in diagnostic logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Note: For cross-platform compatibility. then for HTTP tunnelling to work. see the following articles: • www. Clustering multiple servers behind a load balancer Add all the servers in the cluster to the pool (server farm) in the load balancer. By default.28 or later in Windows only. To run the server as an edge server. Cookies can be enabled in the load balancer or in the Adaptor. which eliminates single points of failure. Flash Media Development Server. Ensure that you deploy all servers on computers that meet the minimum system requirements. Deploying multiple servers enables you to scale an application for more clients and creates redundancy. 2 Configure a load balancer to see the servers hosting Flash Media Interactive Server or Flash Media Streaming Server.Last updated 3/2/2010 1 Chapter 1: Deploying the server Deploying servers in a cluster Workflow for deploying servers in a cluster You can deploy multiple servers behind a load balancer to distribute the client load over multiple servers. or Flash Media Streaming Server) in a cluster.com/go/learn_fms_scalable_en Deploying edge servers Workflow for deploying edge servers Note: Flash Media Streaming Server cannot be configured as an edge server.0. The load balancer distributes traffic among all the servers in the pool.adobe. use lowercase names for all folders and applications.com/go/learn_fms_clustering_en • www. 1 Install Adobe® Flash® Media Server and verify the installation on each computer. For more information. cookies are currently supported only on Adobe® Flash® Player 9. You can deploy any version of the server (Flash Media Interactive Server. Typically you would run Flash Media Interactive Server as an origin server on one computer and run Flash Media Interactive Server as an edge server on another computer. Note: For tunnelling connections. you should enable cookies when you deploy servers behind a load balancer. . Configure the load balancer to distribute the load in round-robin mode and to monitor over TCP port 1935.adobe. If the server does not have an externally visible IP address. the server runs as an origin server.com/go/learn_fms_redundancy_en • www.xml configuration file in the Adaptor/HTTPTunnel/SetCookie element.adobe. you must configure an XML file. The load balancer checks the cookie and sends requests with this cookie to the same server.

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 2
Deploying the server

It is also possible to run one server in hybrid mode—that is, to configure some virtual hosts to run as edge servers and other virtual hosts to run as origin servers. This scenario is good for development but not for production.
1. Install Flash Media Interactive Server and verify the installation on each computer.

Deploy all edge and origin servers on computers that meet the minimum system requirements. For information about installing and verifying installation, see the Installation Guide. Note: For cross-platform compatibility, use lowercase names for all folders and applications.
2. Configure an edge server and restart.

On the edge server, edit the Vhost.xml file of the virtual host you want to run as an edge server.
3. Verify that the edge server can communicate with the origin server.

The easiest way to verify is to create an explicit connection. Create a SWF file with an explicit connection to the edge server and run the vod or live service.
4. If you’re installing multiple edge servers, copy the Vhost.xml file to the same directory on each edge server. 5. Verify that each edge server can communicate with the origin server. 6. Place the origin server and those edge servers nearest to it on the same subnet. 7. If you’re deploying more than one edge server, configure a load balancer.

Place the load balancer between the clients and the edges. Configure the load balancer to access the pool of edge servers in round-robin mode and to monitor over TCP port 1935. Use the virtual IP (VIP) address of the pool as the IP address in the RouteEntry element of each edge server’s Vhost.xml file. For detailed information on how to configure the RouteEntry element, see the comments in the RouteEntry element of the default Vhost.xml file, or see RouteEntry.

Configure edge servers
To configure the server to run as an edge server, edit the Vhost.xml configuration file of the virtual host you want to run as an edge server. The Vhost.xml file defines how the edge server connects clients to the origin server. Note: You can also configure some virtual hosts to run applications locally (as origins), while others run applications remotely (as edges); this is called mixed mode or hybrid mode. Configure a virtual host to run as an edge server 1 Open the Vhost.xml file of the virtual host you want to configure and locate the following code (comments have been removed):

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 3
Deploying the server

<VirtualHost> ... <Proxy> <Mode>local</Mode> <Anonymous>false</Anonymous> <CacheDir enabled="false" useAppName="true"></CacheDir> <LocalAddress></LocalAddress> <RouteTable protocol=""> <RouteEntry></RouteEntry> </RouteTable> <EdgeAutoDiscovery> <Enabled>false</Enabled> <AllowOverride>true</AllowOverride> <WaitTime>1000</WaitTime> </EdgeAutoDiscovery> </Proxy> </VirtualHost>

Note: The default VHost.xml file is located in the RootInstall/conf/_defaultRoot_/_defaultVHost_ directory.
2 Edit the following XML elements, as needed.
Element
Mode

Required/optional Required

Description Enter local to configure the server to run as an origin server. Enter remote to configure the server to run as an edge server. A Boolean value specifying whether the edge server connection is implicit (true) or explicit (false). The default value is false. Enables or disables the caching of streams to disk, in addition to caching in memory, on an edge server and allows you to specify the cache location. There are two attributes: enabled and appname. To enable caching, set the enabled attribute to "true". When enabled, the server places streams in the RootInstall/cache/appName directory by default. Use the useAppName attribute to specify whether to use the application name as the name of the cache for the application. Vod applications get significant performance gains when caching is enabled.

Anonymous

Optional

CacheDir

Optional

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 4
Deploying the server

Element
LocalAddress

Required/optional Optional

Description Specifies the local IP address to which to bind a proxy's outgoing connection (the proxy’s loopback address). This element allows the administrator to control network traffic by isolating incoming and outgoing traffic to separate network interfaces. Specifies, in each RouteEntry element, how to route connections from the origin to the edge. There is one attribute, protocol, that indicates the protocol of the outgoing connection. Set this attribute to either "rtmp" or "rtmps". To override the RouteTable protocol for a specific RouteEntry element, add a protocol attribute to the RouteEntry element you want to change. Each RouteEntry element maps a host/port pair to a different host/port pair. In the following example, connections to host1:port1 are routed to host2:port2:
host1:port1;host2:port2

RouteTable

Optional; create a routing table when it is not necessary or desirable for application developers to see the origin server URL or when you want to use implicit connections. Optional

RouteEntry

Typically, host1:port1 is your edge server and host2:port2 is your origin server. The following example routes connections destined for host "edge" on port 1935 to host "origin" on port 80:
<RouteEntry>edge:1935;origin:80</RouteEntry>

You can specify a wildcard character (*) for any host or port. The following example routes connections destined for any host on any port to host "origin" on port 1935:
<RouteEntry>*:*;origin:1935</RouteEntry>

You can also specify a wildcard for the host/port to which connections are being routed. The following example routes connections destined for any host on any port to the same host on port 80:
<RouteEntry>*:*;*:80</RouteEntry>

To reject connections, you can specify that a host/port combination be routed to null:
<RouteEntry>edge:80;null</RouteEntry>

The RouteEntry element has a protocol attribute. This attribute overrides the RouteTable protocol for a specific RouteEntry element. For example, RouteTable may have one RouteEntry element that specifies an encrypted outgoing RTMPS connection and another RouteEntry tag that specifies the regular RTMP connection. If a protocol is not specified, the outgoing connection uses the same protocol as the incoming connection.

3 Validate the XML and save the Vhost.xml file. 4 Restart the server.

More Help topics
“Adaptors and virtual hosts” on page 6

Connect to an edge server
There are two types of edge server connections: explicit and implicit (also called anonymous).

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 5
Deploying the server

An explicit edge server prefixes its address to the origin server’s URL in the client NetConnection.connect() call. For example, for applications running on fms.foo.com, instead of clients connecting to an application with a connection string such as rtmp://fms.foo.com/app/inst, clients are directed through the edge, which prefixes its protocol and hostname to the origin URL, as in the following:
rtmp://fmsedge.foo.com/?rtmp://fms.foo.com/app/inst

An implicit edge server does not change or modify the origin server’s URL in the client NetConnection.connect() call. The identity (the IP address and port number) of the implicit edge is hidden from the application developer. Create an explicit connection ❖ Use the following syntax in a client-side NetConnection.connect() call to make an explicit connection to an edge server:
rtmp://edge/?rtmp://origin/app

A question mark (?) separates the edge’s prefix from the main URL. The prefix contains only the protocol, hostname, and optionally the port number. The prefix must always end with a trailing slash. Create an implicit connection 1 In the Vhost.xml configuration file, set the Proxy/Anonymous element to true. Note: Restart the server after changing the Vhost.xml file.
2 In the Vhost.xml file, create a routing table in the RouteTable element; for more information, see the comments

about RouteEntry tags in the Vhost.xml file installed with Flash Media Server.
3 Use the following syntax in a client-side NetConnection.connect() call to make an implicit connection to an

edge server:
rtmp://edge/app/appinstance

Connect edge servers in a chain ❖ You can chain together any number of edges when you make connections to the origin server. Use the following syntax to chain two explicit edges to direct connection requests to the origin server:
rtmp://edge1/?rtmp://edge2/?rtmp://origin/app/inst

As the connection moves through each edge in the chain, the server consumes the first token in the string. For example, after making the connection to edge1, the connection string changes to:
rtmp://edge2/?rtmp://origin/app/inst

Note: You can specify the RTMPT protocol only for the edges, not for the origin. When you use URL decoration to chain edges, Flash Player 7 and earlier versions may have problems with shared objects because of the embedded question mark (?) character in the URL. Call the following function to encode or escape the question marks from the URL before passing the URL to the shared object:
function escapeURI(uri) { index = uri.indexOf('?'); if (index == -1) return uri; prefix = uri.substring(0, index); uri = uri.substring(index); return prefix += escape(uri); }

There are also configuration files for information about administrators and logging: Users.xml Default structure of the server’s configuration (conf) directory . You can add adaptors and virtual hosts to organize the server for hosting multiple applications and sites.xml. Each virtual host hosts one or more applications. Each application has one or more instances. The most important configuration parameters have been pulled out to the fms.example. if a virtual host needs its own IP address to configure SSL.xml _defaultVHost_ Application.xml. For this reason.xml.xml Vhost. Note: For information about registering applications with the server and storing media.ini file. If you’re hosting multiple websites on a server.xml Logger.xml. Provisioning allows multiple administrators to configure their own sections on one server. virtual host. Vhost. use adaptors to organize virtual hosts by IP address or port number. and application. Configuration folder structure Each of these levels—server. The server is at the top level and contains one or more adaptors. adaptor. adaptor. but not to a virtual host.xml Users. Adaptor. you can provision it so that each customer has their own section. see “Configuring content storage” on page 33. which enables you to use one file to configure the server. The server is divided into hierarchical levels: server. depending on your needs.test. You can also configure one virtual host to run as an edge server and one to run as an origin server. You can assign an IP address or a port number to an adaptor.com and www. application. For example. conf Server. virtual host (also called vhost). You can provision Flash Media Server in several ways. Each adaptor contains one or more virtual hosts.ini _defaultRoot_ Adaptor. and Application. This is called running the server in hybrid mode. you could use two virtual hosts to host www. For example.Last updated 3/2/2010 6 Chapter 2: Configuring the server Provisioning the server Adaptors and virtual hosts Provisioning a server divides the server into separate sections. If you use your server for hosting.xml. use virtual hosts to give customers their own root folders.xml and Logger. and application instances—has distinct configuration settings stored in XML files in the RootInstall/conf directory: Server. assign it to its own adaptor.xml fms.com on the same server.

The control channel (ctl_channel) attribute and the HostPort value specify the ports to which an IP address should bind. • The default adaptor’s root directory is RootInstall/conf/_defaultRoot_. 6 To log in to the Administration Console on the new adaptor. The server must have a Server.xml file in the conf directory.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml file in its root directory. as in the following example: <HostPort name="edge1" ctl_channel=":19350">xx. • The server has one initialization file. 4 In the Adaptor.xx:1935</HostPort> <HostPort name="edge2" ctl_channel=":19351">yy. for example. • You may place an Application.yy.yy:1935</HostPort> 5 Restart the server. Add an adaptor 1 Create a new directory with the name of the adaptor in the RootInstall/conf folder. The following rules define the conf directory structure: • The root configuration folder is RootInstall/conf. You cannot remove or modify the name of this directory. Each adaptor directory must contain a _defaultVHost_ directory and an Adaptor.xml file that serves as a default to all applications in that virtual host and a Users. You cannot remove or modify the name of this directory.xml file.ini. • The default virtual host’s root directory is RootInstall/conf/_defaultRoot_/_defaultVHost_. adaptor2/admin.xx. Each adaptor must have a default virtual host.xml or fms. the adaptor can listen on all available interfaces. Ensure that the control channels on which separate adaptors listen are different from each other. You cannot remove or modify the name of this directory. use the syntax adaptorname/username in the Username box. For more information. • Virtual host directories may also contain an Application. see “Connecting to the Administration Console” on page 40. . create or paste a copy of the _defaultVHost_ directory and an Adaptor.5 CONFIGURATION AND ADMINISTRATION GUIDE 7 Configuring the server Edit any of these XML files in a text or XML editor and restart the server for the changes to take effect. see “Working with configuration files” on page 9.xml file.xml file that contains information about administrators of that virtual host.ini.xml file in an application’s registered directory to create an application-specific configuration. 2 In the adaptor2 directory. see the Developer Guide. fms. unless they use different IP addresses. The server uses the control channel (ctl_channel) attribute internally to communicate between server processes (adding a HostPort element creates a new FMSEdge process). including the administrator user name and password and the settings you chose during installation. For more information about registered application directories. in the RootInstall/conf directory. for example.xml file in its root directory.xml file and a Vhost. If you modify Users. either internally or externally. add a HostPort element to listen on a new port for this adaptor: <HostPort name="edge2" ctl_channel=":19351">:1936</HostPort> The name attribute must be unique on the server. or they cannot interoperate. a Logger. Each virtual host must have a Vhost. you also must restart Flash Media Administration Server. Each adaptor must have an Adaptor. For information about logging in to the Administration Console.xml file.xml file. If an IP address is not specified. In addition.xml file.xml file in the adaptor directory.xx.yy. RootInstall/conf/adaptor2. the control channels of two adaptors must be different. This file contains commonly used settings. If a host has multiple IP addresses. The server uses the HostPort value to listen for clients—no two adaptors can listen on the same port. and a Users. create or paste a copy of an Application. multiple adaptors can listen on port 1935. 3 In the _defaultVHost_ directory.

2 Copy an Application. RootInstall/conf/_defaultRoot_/www.example. for example: <AppsDir>C:\www. For information about logging in to the Administration Console. 6 Log in to the Administration Console.xml file. specify an application directory in the AppsDir element.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml _defaultVHost_ Application.5 CONFIGURATION AND ADMINISTRATION GUIDE 8 Configuring the server Administrators are defined in the UserList section of the Users.xml adaptor2 Adaptor.xml file. conf Server. Note: You can call the startVHost() Administration API or log in to the Administration Console without restarting the server. www.example. 5 Restart the server. you are considered a virtual host administrator and don’t have privileges to manage the server or users. If you log in to an adaptor other than the default adaptor. 7 Connect to the new virtual host by specifying the virtual host name.xml fms.xml Users.xml The conf directory with an additional adaptor called adaptor2 Add a virtual host 1 Create a folder with the name of the virtual host in an adaptor folder. . a Vhost. and a Users. Administrators are either server-level users (similar to a root user) or virtual host-level users.xml Users.xml file.xml file.xml Vhost. for example.xml _defaultVHost_ Application.ini _defaultRoot_ Adaptor.xml Vhost.xml file is required only if you are defining administrators for this virtual host.xml Logger. 8 Connect a test application to the new virtual host to make sure it works. but it causes namespace conflicts and is not recommended.com<\AppsDir> Note: It is possible to use the same applications directory for multiple virtual hosts.com.xml Users. (The Users. for example.com. in the Server name field.xml file. 4 Validate the XML and save the Vhost.xml file to the new virtual host folder.example. see “Connecting to the Administration Console” on page 40.) 3 In the Vhost.

com Application.xml file. locations.Last updated 3/2/2010 FLASH MEDIA SERVER 3. • You cannot override the subtags of the LoadOnStartup tag. If you modify Users. see “Configuration folder structure” on page 6. look at the vod and live applications included with Flash Media Server.example. you also must restart Flash Media Administration Server.xml Users. modify and save it.5 CONFIGURATION AND ADMINISTRATION GUIDE 9 Configuring the server conf Server. . as in the following: <LoadOnStartup override="no">false</LoadOnStartup> The following rules apply: • When the override="no". and hierarchy. open it in a text editor.example.xml Logger.ini _defaultRoot_ Adaptor.xml file.xml file You can place an Application.xml file override the values in the vhost-level Application. • You can override the LoadOnStartup tag. To see an example.xml file.xml.xml files cannot override that tag’s setting. and restart the server. Each folder contains an Application.xml Vhost.xml settings from being overridden by the applicationlevel Application.xml Users.com Overriding values in the Application.xml The conf directory with an additional virtual host called www. You can also prevent settings in the vhost-level Application. Values set in the application-level Application.xml file in an application’s folder.xml _defaultVHost_ Application.xml. To edit a configuration file. Add an override attribute to any tag and set it to "no". application-specific Application. Navigate to rootinstall\applications\vod and rootinstall\applications\live. Working with configuration files Editing configuration files Note: For information about configuration file names.xml www.xml fms.xml Vhost.xml Users. The values in these files override the values in the vhost-level file rootinstall\conf\_defaultRoot_\_defaultVHost_\Application.

You can also create additional map files and reference them from the substitution.ini in a text editor. you can use symbols as values for XML elements in configuration files.ini file and the substitution.xml file).Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml.xml file: 1 Create a new XML file and save it in the RootInstall/conf folder as substitution. 3 If the substitution. Edit the fms. the server looks for the Symbols tag and processes the child tags in the order in which they appear. Using symbols in configuration files To simplify configuration.5 CONFIGURATION AND ADMINISTRATION GUIDE 10 Configuring the server It’s a good idea to check that the XML is valid after editing an XML configuration file. 4 The server processes the additional map files in the order in which they appear (in KeyValueFile elements in the substitution. The ROOT symbol is mapped to the location of the FMSMaster. ROOT and CONF.xml file maps the symbol TESTUSERNAME to the value janedoe: <Root> <Symbols> <TESTUSERNAME>janedoe</TESTUSERNAME> </Symbols> </Root> .xml file exists. 2 The fms.ini file is evaluated.xml file in the RootInstall/conf directory. The server builds the symbol map in the following order: 1 The predefined symbols ROOT and CONF are evaluated. Create a substitution. that are always available. this substitution. 5 Symbols defined in external map files are processed in the order in which they appear in each file.xml in the RootInstall/conf folder that maps the symbols to strings that the server substitutes when it reads the configuration files.ini file.exe file and the CONF symbol is mapped to the location of the Server. 2 Enter the following XML structure: <Root> <Symbols> <SymbolName>StringToMapTo</SymbolName> </Symbols> </Root> Add a SymbolName element for each symbol you want to create. 3 For example.ADMIN_PASSWORD parameter. Create a file named substitution. 4 Save the file and restart the server. After you’ve set up a map file. 3 Enter a new value for the SERVER. 2 Save a copy to another location as a backup. future updates are faster: you can edit the map file instead of editing each configuration file. When the server starts.xml file. it looks for the fms. The installer defines a few mappings during the installation process and stores them in the fms. 5 Open the Administration Console and log in with your new password.xml file.ini file 1 Open RootInstall/conf/fms. The server has two predefined symbols.

use the name of the environment variable within percent (%) characters. To do this.ADMIN_USERNAME}"> and replace the symbol SERVER.ADMIN_USERNAME with the symbol TESTUSERNAME.xml file. 6 Restart the Administration Server.xml file.5 CONFIGURATION AND ADMINISTRATION GUIDE 11 Configuring the server 4 Open the RootInstall/conf/Users.txt: <Root> <KeyValueFile>C:\testfiles\mySymbols. . For example. When the server reads the XML file. the following references the file C:\testfiles\mySymbols.xml file. The % characters indicate to the server that the symbol refers to an environment variable and not to a user-defined string. If you change any other XML configuration file. Do not place comments on the same line as a symbol definition. but no white space within double quotation marks. However. For example. The syntax for specifying an environment variable as a symbol is ${%ENV_VAR_NAME%}. it would not be surrounded by quotation marks. you must restart the server. 5 Locate the line <User name="${SERVER. you don’t have to define it in the substitution.xml. the server maps the following symbol to the COMPUTERNAME variable: ${%COMPUTERNAME%} When you use an environment variable. it substitutes the value from the substitution. you can also create additional map files. The first equal sign (=) in a line is considered the delimiter that separates the symbol and the value.xml file as follows: <User name="janedoe"> Note: Because this symbol is used as an attribute. Each element can hold the location of one external file. Creating additional map files You can specify all of your text substitution mappings under the Symbols tag in substitution. where each pair appears on a separate line and takes the following form: symbol=value The following example shows three symbol-value pairs: USER_NAME=foo USER_PSWD = bar HELLO= "world and worlds" Place comments on separate lines that begin with a number sign (#). you must restart the Administration Server. If the symbol were used as a regular value. Using environment variables To refer to an environment variable in one of the XML configuration files.Last updated 3/2/2010 FLASH MEDIA SERVER 3. create one or more KeyValueFile elements in the substitution.txt</KeyValueFile> </Root> These external files are not in XML format. They simply contain a collection of symbol-value pairs.xml file in a text editor. Note: If you change the Users. it is surrounded by quotation marks. The server trims leading or trailing white space from both the symbol and the value.

segments of the stream are stored in a cache on the server. 3 Restart the server. The size of the cache limits the number of unique streams the server can publish. see “Monitoring and Managing Log Files” on page 55. Each time a stream attempts to access a segment. inserts it into the cache. Adobe recommends that you ensure that your total system memory usage does not exceed the process limit of your OS. the server places segments in the cache. The default value is 500.FLVCACHE_MAXSIZE. starting with the least recently used. Note: Cache settings have no effect on live streams. While a large cache size is useful. increase the value of SERVER. and returns a reference to that segment to the stream. the server removes unused segments. . decrease the value of SERVER. Consider memory limits and desired memory and stream performance when utilizing the memory cache. the server notifies the client that the stream is not available and makes an entry in the core log file. the server retrieves the segment from its source. For more information about the core log file. After removing all unused segments. To increase the probability that a requested stream will be located in the recorded media cache.FLVCACHE_MAXSIZE parameter. in megabytes.5 CONFIGURATION AND ADMINISTRATION GUIDE 12 Configuring the server Configuring performance features Configure the server for live video delivery To configure the server to deliver live media.FLVCACHE_MAXSIZE. the server checks the cache. As long as the cache has not reached capacity. complete the following task: ❖ “Combine audio samples” on page 13 Configure the server for vod delivery To configure the server to deliver recorded media. if there still isn’t enough room for a new segment. If you have cache-full events in the core log file. 1 Open the RootInstall/conf/fms. If the segment is available. If the segment is not available. complete the following tasks: 1 “Configure the recorded media cache” on page 12 2 “Configure the size of stream chunks” on page 13 Configure the recorded media cache When a stream is requested from the server. as live streams do not need or utilize the cache. When the cache is full. To decrease the amount of memory the server process uses. increase the size of the cache or limit the number of streams playing.Last updated 3/2/2010 FLASH MEDIA SERVER 3. This value shares memory with the running process and has a limit of 2 GB in Windows and 3 GB in Linux.ini file. the server gives the stream a reference to the segment for playback. 2 Edit the SERVER. This is the maximum size of the cache.

To increase live streaming capacity. To increase live streaming capacity. 1 Open the Application. set this value to 1. <AggregateMessages enabled="true"></AggregateMessages> <Client> 3 Make sure that the enabled attribute is set to true (the default).. audio samples are not combined. Large values reduce CPU usage because there are fewer writes. You can configure applications to deliver aggregate messages to clients running on Flash Player 9. see “Application. APP. However. set this value to 8. Send aggregate messages Sending aggregate messages reduces CPU usage and increases server capacity. The default value is 60. audio samples are combined.ini file. For more information. Important: Do not combine audio samples if you are also using the live aggregation message feature.5 CONFIGURATION AND ADMINISTRATION GUIDE 13 Configuring the server Configure the size of stream chunks Streams break into chunks as they are written to the network. 4 Validate the XML and save the Application.0 and above. 1 Open the RootInstall/conf/fms. The larger the content size and the higher the bandwidth of the receiving connection.xml file. combine audio samples. 2 Edit the following parameters: • • • • APP.xml file. set the OutChunkSize element to a value between 128 and 65536 bytes. 1 Open the Application.COMBINESAMPLES_LOCPU: If the CPU is lower than this value.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 2 In the Client element. the more benefit is gained from larger chunk sizes. To increase live streaming capacity.0. Combine audio samples To handle more connections while broadcasting a live stream. the server breaks up aggregate messages into individual messages before delivering them to clients.xml file” on page 93. audio samples are not combined.60. . To increase live streaming capacity. When this setting is disabled.SUBSCRIBERS: If there are more than this number of subscribers to a stream. 5 Restart the server. You can specify the size of a chunk.COMBINESAMPLES_HICPU: If the CPU is higher than this value. 2 Locate the following XML code: <Client> . 3 Restart the server.xml file.COMBINESAMPLES_MAXSAMPLES: Combine this many samples into one message. large values can delay other content on lower bandwidth connections. set this value to 1. The default value is 4. The default value is 80.. The default value is 8. APP. set this value to 1. The default value is 4096 bytes. APP. 3 Restart the server.

xml.xml. The values defined in the Server. the server can close the idle clients.Idle followed by NetConnection.g. <Protocol> <RTMP> <Edge> <MaxConnectionRate>100</MaxConnectionRate> Element MaxConnectionRate Description The maximum number of incoming connections per second the server accepts. If the element is set to 10 connections per second. Elements in the Server. A client is active when it is sending (e.xml file. each listener has a limit of 10 connections per second. Impact Connections requested at a rate above this value remain in the TCP/IP socket queue and are silently discarded by the operating system whenever the queue becomes too long.xml file override the values defined in the Vhost. To close idle connections. by default).xml configuration file: <Root> <Server> . enable the feature in the Server. Once you enable the feature in the Server.xml file: .xml files. The server closes the client connection to the server and writes an x-status code of 432 in the access log. When a client has been idle longer than the maximum idle time (10 minutes.5. Enable closing idle connections 1 Locate the following code in the Server. the server imposes a maximum total combined rate of 30 connections per second. A value of 0 or -1 disables this feature.. Each port the server is configured to listen on represents a listener. 2 Validate the XML and save the XML file. The values defined in the Application. 1 Locate the following code in the Server. per listener.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The value of this element is a global setting for all listeners.xml files and Application.xml file. subscribing to) data.. unless the values are defined in the Vhost.. and Application.xml file (the Vhost.xml configuration file apply to all clients connected to the server. such as 12.xml file.xml file.Closed.xml values override the Server. Listeners are defined in the HostPort element in the Adaptor. You can set a fractional maximum connection rate.xml configuration files specify how often the server should check for idle clients. the server sends a status message to the NetConnection object (the client) with the code property set to NetConnection.. If there are three listeners and the MaxConnectionRate is set to 10.Connect.Connect. The server also writes a message such as “Client x has been idle for y seconds” in the core and event logs. publishing) or receiving (e. you can disable the feature for individual virtual hosts or individual applications in the Vhost.5 CONFIGURATION AND ADMINISTRATION GUIDE 14 Configuring the server Limit connection requests A high connection rate to the server can negatively impact the experience of users already connected to the server. 3 Restart the server. Close idle connections Sometimes users abandon their connections to an application. To reclaim these resources for new and active clients. Vhost.xml values).g.

even if you specify true in the Vhost.xml file. A low value may cause unneeded disconnections. the default idle time is used. . The default idle time is 600 seconds (10 minutes).xml. in seconds. at which the server checks for active client connections. Configure settings for virtual hosts You can disable this feature for a virtual host or specify a different maximum idle time for a virtual host in the Vhost. Impact CheckInterval A client is disconnected the first time the server checks for idle connections if the client has exceeded the MaxIdleTime value. the feature is disabled for all virtual hosts.xml. before a client is disconnected. MaxIdleTime 3 Restart the server. The value of the MaxIdleTime element in the Vhost. If no value is set for this element.xml file. For example. When you configure this element. file. Specifies the interval. If this element is 0 or less. in seconds.xml file.xml file overrides the value of the MaxIdleTime element in the Server. If this element is disabled in Server. 1 Locate the following code in the Vhost. Specifies the maximum idle time allowed.xml file and remove the comments: <VirtualHost> <AutoCloseIdleClients enable="false"> <MaxIdleTime>600</MaxIdleTime> </AutoCloseIdleClients> </VirtualHost> 2 Edit the following elements. Element AutoCloseIdleClients Description Disable this feature for an individual virtual host by setting the enable attribute to false. If the enable attribute is omitted or not set to true.Last updated 3/2/2010 FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 15 Configuring the server <AutoCloseIdleClients enable="false"> <CheckInterval>60</CheckInterval> <MaxIdleTime>600</MaxIdleTime> </AutoCloseIdleClients> 2 Edit the following elements. before a client is disconnected. The default interval is 60 seconds. The default value is false. You can set a different value for each virtual host. MaxIdleTime Specifies the maximum idle time allowed. A shorter interval results in more reliable disconnection times but can also result in decreased server performance. in seconds. The default idle time is 600 seconds (10 minutes). Element AutoCloseIdleClients Description Set the enable attribute to true to close idle clients. the feature is disabled. a user might leave the window to idle out. if you have an application allowing users to watch short video clips. the server uses the value set in the Server. consider the type of applications running on the server.

There can be only one master process running at a time. file.exe (Windows) or fmsmaster (Linux). before a client is disconnected. you might want to change how applications are assigned to server processes. even if you specify true in the Application. and you probably won’t need more than 20. If no value is set for this element. The following is the XML structure: . Settings in an Application. In some scenarios. If this element is disabled in Server. Note: The number of core processes you can run is limited by system memory. RootInstall/conf/_defaultRoot_/_defaultVHost_/Application. The default idle time is 600 seconds (10 minutes). Do not run more than 100. the server uses the value in the Server.exe (Windows) and fmscore (Linux). MaxIdleTime 3 Restart the server. the feature is disabled for all applications.xml file.Last updated 3/2/2010 FLASH MEDIA SERVER 3. RootInstall/applications/myApp/Application.xml file. the server uses the value set in the Vhost. If no value is set for this element in the Vhost. see Tech Note kb403044.xml configuration file. Configure how applications are assigned to server processes Note: This section is only applicable to Flash Media Interactive Server and Flash Media Development Server. If you are configuring the number of core processes and using the reloadApp() Administration API or HTTP command.xml) apply only to that application. Flash Media Streaming Server doesn’t support multiple processes.xml file and remove the comments: <VirtualHost> <AutoCloseIdleClients enable="false"> <MaxIdleTime>600</MaxIdleTime> </AutoCloseIdleClients> </VirtualHost> 2 Edit the following elements. You can configure how applications are assigned to server processes in the Process section of the Application.xml file overrides the value of the MaxIdleTime element in the Server. Settings in an Application. You can set a different value for each application.xml file in a virtual host folder (for example. The master process is a monitor that starts core processes when necessary. 1 Locate the following code in the Application. Specifies the maximum idle time allowed. Element AutoCloseIdleClients Description Disable this feature for an individual application by setting the enable attribute to false. When you start the server.xml file in an application’s folder (for example. Application instances run in processes called FMSCore.xml file. in seconds. you are starting a process called FMSMaster. but there can be many core processes running at a time.xml file.xml) apply to all the applications running in that virtual host.xml. The value of the MaxIdleTime element in the Vhost.xml.xml file.5 CONFIGURATION AND ADMINISTRATION GUIDE 16 Configuring the server Configure settings for applications You can disable this feature for an application or specify a different maximum idle time for an application in the Application.

Running every instance in its own process can create many processes. which means that the default behavior is to distribute application instances to three core processes. Note: There is no limit to the value of the numprocs attribute.. This provides the best application isolation and uses the most system resources. All instances of a single application run together in a process. Each application instance runs in its own process. you could either distribute those instances to one core process (<Scope>app</Scope>) or three core processes (<Scope>inst</Scope>). if the value of Scope is adaptor.. the value of Distribute can be vhosts. Value adaptor vhost app inst Description All application instances in an adaptor run together in a process. insts. the server uses the value immediately lower than the one specified in the Scope tag. Scopes have an enclosing relationship with a strict ordering: adaptors contain virtual hosts. . The default value of numprocs is 3. Enter one of the following values for the Scope element. the value of Distribute can be insts or clients. a number between 3 and 11 is realistic for most cases. Adobe recommends using prime number values because they result in a more even distribution of connections to processes. Distribute a process scope among multiple core processes The four process scopes don’t provide a good distribution for all scenarios. </Application> Configure a process scope ❖ The Scope tag specifies at which level application instances are assigned to core processes. In other words. This is the default value. 3 Enter one of the following values for the Distribute element. or clients. For example. which contain applications.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Depending on available RAM. 1 Set the scope value. If the value of Scope is app.5 CONFIGURATION AND ADMINISTRATION GUIDE 17 Configuring the server <Application> <Process> <Scope>vhost</Scope> <Distribute numprocs="3"></Distribute> <LifeTime> <RollOver></RollOver> <MaxCores></MaxCores> </LifeTime> <MaxFailures>2</MaxFailures> <RecoveryTime>300</RecoveryTime> </Process> . but you should never need more than 40. apps. You can set the Distribute numprocs attribute to a value greater than 1 to distribute instances across that number of processes. which contain clients. which contain instances. 2 Set the numprocs value to a value higher than 1. An application instance can run by itself in a process or it can run in a process with other instances. The value of the Distribute tag must be a scope that is lower in order than the value in the Scope tag. All application instances in a virtual host run together in a process. you could set Scope to app and Distribute numprocs to 3 to distribute the application instances among three core processes. if you have one application and want to run 25 instances of that application. In this scenario. By default.

5 CONFIGURATION AND ADMINISTRATION GUIDE 18 Configuring the server Value vhosts apps insts Description All instances of applications in a virtual host run together in a process. The duration of the first process is determined by the clock time. Process 3 starts E. any new connections roll over to a new core process. if a shared chat application were set to client. Most vod (video on demand) applications are stateless because each client plays content independently of all other clients. as shown in the diagram.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Each client connection runs in its own process.. The following diagram depicts the way in which the server rolls over processes. indicating that every hour a new process should start. This feature is disabled by default. when process 1 starts. This is the default value.. . All instances of an application run together in a process. the rollover time is set to 3600 seconds (1 hour). Each application instance runs in its own process. The duration of process 1 is partially determined by the current time when process 1 starts. A B C D E 12:00 12:20 1:00 2:00 3:00 4:00 5:00 A. Process 2 starts D. In the XML. so the duration of process 1 is only 40 minutes (because it is 40 minutes until the beginning of the hour in real time). you must also set the Distribute numprocs attribute to a value greater than 1. the messages wouldn't reach everyone in the chat because they’d be split into separate processes. and so on. For example. the current time is 12:20. Client connections B. and the maximum core processes value is set to 3. To disable this feature. Process 1 starts C. set RollOver to 0. Process 4 starts. clients Configure the number of core processes and how long each process runs ❖ Specify the number of core processes in the MaxCores tag (the maximum number of core processes that can exist concurrently) and the number of seconds that a core process can run in the RollOver tag. Use this value for stateless applications only. Process 1 ends. Stateless applications don’t require clients to interact with other clients and don’t have clients accessing live streams. When a core process reaches the limit. it accepts new client connections to the application until process 2 starts. Note that the duration of process 1 might or might not be the full duration specified by the rollover value. If you choose this value. process 2 then accepts new client connections until process 3 starts. because rollover values are calibrated to the real clock time. because the maximum core processes limit was reached When each process starts. Chat and gaming applications are not stateless because all clients share the application state. For example. indicating that the maximum number of processes at any given time is 3: <Process> <Scope>app</Scope> <LifeTime> <RollOver>3600</RollOver> <MaxCores>3</MaxCores> </LifeTime> . when process 1 starts. subsequent processes have a duration equal to the specified rollover time. it accepts new connections until the next process starts: that is.

Use this feature to guard against a behavior in which a faulty core process can use the entire CPU by being repeatedly launched very quickly.ALLOW parameter to a comma-delimited list of domains that are allowed to connect to the server.ini file. Check for process failures 1 Enter a value in the MaxFailures tag to specify the maximum number of process failures allowed before a core process is disabled. To do this. connections are allowed from all domains. 2 Once disabled. you can restrict which domains are allowed to connect to a virtual host. The default value is 2. 2 Set the VHOST.ALLOW = example. This ensures that an application instance is not split across multiple processes. set the Distribute numprocs attribute to a value greater than 1. To allow localhost connections. a master process will not launch a core process until a minimum recovery time elapses. old core processes continue to serve earlier connections.Last updated 3/2/2010 FLASH MEDIA SERVER 3. then set the Distribute tag to clients or set the Scope tag to inst. example2. Enter a value in the RecoveryTime tag to specify the minimum recovery time for contained elements. Verifying SWF files prevents third parties from creating their own applications that attempt to stream your resources. For more information. This feature is disabled by default. only the domains listed are accepted. VHOST. set MaxCores to 0. To disable this feature. If a value is set.com and example2. Note: An application is considered stateless if you configure it to distribute clients over multiple processes. such as vod applications. Verify SWF files You can configure the server to verify client SWF files before allowing them to connect to an application. set the tag to 0 to disable checking for process failures.xml file” on page 178. By default. 3 Restart the server. In stateless applications. see “Vhost. you must set an identical RollOver value for each VHost.5 CONFIGURATION AND ADMINISTRATION GUIDE 19 Configuring the server Note: If you have multiple VHosts with Process/Scope set to adaptor. Note: Applications that are loaded using the Administration API (including applications loaded using the Administration Console) are not checked for process failures.com allows connections from the example. 1 Open the RootInstall/conf/fms. The default value is all.com. Configuring security features Restrict which domains can connect to a virtual host If desired. you can specify a value in the MaxCores tag to limit the maximum number of core processes that can run simultaneously. the server ignores any value you assign to MaxCores and sets it to 1. In this case. .com domains. For example. specify localhost. If the application is not stateless. but clients are disconnected periodically.

adding the path <SWFFolder>C:\Program Files\Adobe\Flash Media Server 3. To verify SWF files.xml file. The SWFFolder tag defines the location. the server looks for verifying SWF files in that file path. and Flash Media Development Server. Configure the Server. on Windows.xml to the plug-in. it is allowed to connect to the application. Configure the Application.xml file in the Vhost folder. or in the File plug-in. if it exists. 2 The Vhost-level Application.xml configuration file.5 CONFIGURATION AND ADMINISTRATION GUIDE 20 Configuring the server Note: Verification of SWF files requires Flash Player 9. This tag specifies a location for global SWF files. the server verifies it. You can verify SWF files at the following server scopes: • Individual applications.xml file defines the location of verifying SWF files in the SWFFolder tag. If you installed Apache with Flash Media Server. Note: SWF files connecting to Flash Media Administration Server cannot be verified.xml file.xml or Server. in order: 1 The application-specific Application.0. When the client SWF file connects to the server. This feature is supported in versions 3. Flash Media Interactive Server. The server passes any values present in Application. This Application. the server looks for verifying SWF files in that file path. the server calls the File plug-in.115. By default. Locating SWF files for verification The server looks for verifying SWF files in the following locations. When verification is enabled.xml file. you can add a path to the folder from which you serve SWF files. For example. If a client SWF file fails verification. the Server. 3 The server checks the SWFFolder tag in the Server. which means SWF files that are common to all applications. • All applications in a virtual host. copy the SWF file you compiled into the AIR package to the server or external content repository.xml file: . The server does not send a NetStream status message to the client. Configure SWF verification for applications 1 Locate the following section of the Application. 4 If a File plug-in is enabled for retrieval of SWF files. If the SWF file is verified. • Administrative applications that have access to all server levels. the server looks in the default location: /applications/application_name/SWFs. The plug-in developer overrides these values with paths to the external content repository. the SWF file that contains the NetConnection object to connect to the server is the one that the server attempts to verify. The Application. Configure the application-specific Application. If SWFFolder contains a file path.5\webroot</SWFFolder> prevents you from needing to maintain two copies of each SWF file.0 and later of Flash Media Streaming Server. the server looks in RootInstall/applications/application_name/SWFs folder for the verifying SWF file.xml file. If SWFFolder is empty. If SWFFolder is empty. you must set <SWFVerification enable = "true"> in the Application. the server disconnects the NetConnection object and logs an event to the access log.xml file defines the location of verifying SWF files for all applications on the virtual host.xml file and an Application.0 or later or Adobe® AIR™.xml file. If SWFFolder contains a file path.xml file. For client applications that comprise multiple SWF files or SWF files that dynamically load other SWF files. the server verifies that the client SWF file requesting a connection to the server matches the verifying SWF file. You can override this default in the SWFFolder tag of the Application.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Note: If you’re deploying an Adobe AIR application.xml file. the server looks in the default location: /applications/application_name/SWFs. The verifying SWF file is a copy of the client SWF file that you place on the server or in an external content repository. SWF verification is disabled by default.

A single folder or a semicolon-delimited list of folders that contain copies of client SWF files. The parent folder is specified in the SWFFolder element. enter the path to the folder from which you are serving SWF files. For example. The maximum amount of time that a client can use to provide its first verification to the server. verifying SWF files should be placed in the applications/myApplication/SWFs folder. The default value is 0. if you’re serving SWF files from the webroot directory on Windows. This is a reserved field that works with Flash Player.Last updated 3/2/2010 FLASH MEDIA SERVER 3. <SWFVerification enabled="false"> <SWFFolder></SWFFolder> <MinGoodVersion></MinGoodVersion> <DirLevelSWFScan>1</DirLevelSWFScan> <MaxInitDelay>5</MaxInitDelay> <FirstHashTimeout>5</FirstHashTimeout> <FinalHashTimeout>60</FinalHashTimeout> <UserAgentExceptions> <Exception to="" from=""/> </UserAgentExceptions> <Cache> <TTL></TTL> <UpdateInterval></UpdateInterval> </Cache> </SWFVerification> </Application> 2 Edit the following elements. If you are using the File plug-in to verify SWF files in an external content repository. in seconds. The default value is 5 seconds. Specifying zero scans the parent folder and no subfolders. The default value is the application's folder appended with /SWFs. which means that the server scans only one subfolder level. enter the path C:\Program Files\Adobe\Flash Media Server 3. Element SWFVerification Attribute enabled Description Set the enabled attribute to "true" or "false" to turn this feature on or off. for an application called myApplication. For example. leave this field blank. The default value is 1. These SWF files are used to verify connecting SWF files. MaxInitDelay None FirstHashTimeout None FinalHashTimeout None UserAgentExceptions None. SWFFolder None. They are the verifying SWF files. DirLevelSWFScan None. . If you installed Apache with Flash Media Server. MinGoodVersion None. Specifies the minimum version of this feature to accept. Specifies the number of levels of subfolders within a parent folder to scan for SWF files. The maximum amount of time that a client can use to provide its final verification to the server. Specifying a negative value scans all subfolder levels.. if there isn’t a value set for this element. Container.. which allows this and all future versions. Specifying a positive value scans that number of subfolder levels.5\webroot. Adobe recommends keeping the default value. The maximum amount of time to process SWF files. The default value is "false".5 CONFIGURATION AND ADMINISTRATION GUIDE 21 Configuring the server <Application> .

. You can also configure other values for these SWF files. This is a string comparison. Create verification exceptions ❖ Add Exception elements to the UserAgentExceptions section of the Application.xml file. The maximum time in minutes to wait for the server to scan the SWFs folders for updates when there is a miss in the cache. Note: Multiple SWF files may exist in either directory. If a SWF file is removed from the server. users can connect to the application until the cache expires. The default value is 1440 minutes (24 hours).5 CONFIGURATION AND ADMINISTRATION GUIDE 22 Configuring the server Element Exception Attribute from to Description A user agent to except from verification. the verification values stay in the cache for 24 hours. applications/myMediaApp/SWFs/chat02.xml file and “Create verification exceptions” later in this topic. Note: In addition to configuring the SWFFolder tag in the Server.5"/> </UserAgentExceptions> </SWFVerification> Configure SWF verification globally You can configure verification for a group of SWF files on the server that are common to all applications. create instance folders in the SWFs directory. which means a SWF file copied to the SWFs folder is picked up by the server within 5 minutes. Use the from and to attributes to indicate the lowest and highest versions to except. <UserAgentExceptions> <Exception to="FME/0. for example. UpdateInterval None. with editing to make all numeric fields equal in length.. The default value is 5 minutes. applications/myMediaApp/SWFs/chat01.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Adobe® Flash® Media Live Encoder—do not support the form of SWF verification used by the server.xml file Root/Server/SWFVerification/SWFFolder tag. see the comments in the Application. SWF files in the SWFs directory can verify all instances of the application.xml file. enable verification in the Vhost-level or application-specific Application.xml file. For example. and so on. ❖ In the Server. to bypass SWF verification.. 2 To verify SWF files for application instances.0" from="FME/2. See “Configure SWF Verification for Applications” in this topic. as in the following: <SWFVerification enabled="true"> . for an application called myMediaApp. in minutes. Container. create the folder applications/myMediaApp/SWFs. SWF files in the SWFs folder verify connections to any instance of the myMediaApp application. create a folder called SWFs in the application’s folder on the server. Cache TTL None. Create folders for the verifying SWF files 1 If the SWFFolder value is the default. specify folders that hold the verifying SWF files. None. SWF files within an instance folder can verify only that instance. A SWF file can be renamed and still used for verification as long as it’s a copy of the client SWF file. You can add one or more exceptions to the SWF verification rules that allow specified user agents. The time to live for the SWF file. For more information. such as Flash Media Live Encoder. Certain applications—for example.

com/myMediaApplication"). 3 Alternatively. you can disable RTMPE at the adaptor level.connect() URL. nc. 2 Locate the following XML: . RTMPE requires about 15% more processing power than RTMP. edit the CrossDomainPath element to specify a cross-domain file.com. The crossdomain XML file lets you specify a list of domains from which clients can access the edge server or Administration Server. To request an encrypted or encrypted tunnelling channel.5 CONFIGURATION AND ADMINISTRATION GUIDE 23 Configuring the server Restrict access to the server with a cross-domain file You can restrict access to an edge server or the Administration Server with a cross-domain XML file.mydomain.1. 80 (RTMPE)..xml file. Limit access to Flash Media Administration Server By default. In some scenarios. 1 Open RootInstall/conf/Server. RTMPS can be used instead. in the NetConnection. 1 Open the Adaptor. If you don’t control the applications that connect to Flash Media Server and you don’t want them to use RTMPE. For example: <Allow>x. a client can connect to Flash Media Administration Server from any domain or IP address. 443 (RTMPE). If an application specifies RTMPE without explicitly specifying a port. save it. <Allow>all</Allow> . 80 (RTMPTE). respectively. and full or partial IP addresses.com. 4 Validate the XML. foo. you might want to disable RTMPE (encrypted Real-Time Messaging Protocol). </AdminServer> 2 Edit the Allow element to specify which connections to Flash Media Administration Server the server responds to.xml file for the adaptor you want to disable (located in RootInstall/conf). for the Administration Server): <Server> .connect("rtmpe://www. <CrossDomainPath></CrossDomainPath> 2 Specify the location of the cross-domain file in the CrossDomainPathElement. applications specify rtmpe or rtmpte.foo.xml and locate the following code: <AdminServer> . and restart the server.Last updated 3/2/2010 FLASH MEDIA SERVER 3. and restart the server. 1 Open RootInstall/conf/Server. Note: RTMPE cannot currently be used between servers or from edge to origin. for example: <CrossDomainPath>http://store..xml</CrossDomainPath> 3 Validate the Server. RTMPE is enabled in the server’s Adaptor. save the Server.com/crossdomain. for example.xml file. in the following order: 1935 (RTMPE). which lets you specify a list of domains from which a client can access the server.example. 10..60</Allow>.133. 10.xml and locate the CrossDomainPath element in the Server element (or the AdminServer element.xml file. This is specified as a comma-delimited list of host names.. If desired. Disable RTMPE By default. you can change this in the AdminServer section of the Server. which can be a security risk. as well as the keyword all. domain names.xml file. there is a minor impact on performance. Because RTMPE uses encrypted channels... In these cases. Flash Player scans ports just like it does with RTMP.60.

Flash Media Server returns data to the client over port 443.ini file. Note: All server editions support a version of RTMP called RTMPE.connect() entry in the ActionScript® 3.proxyType = "best".connect() method. Traffic with an “rtmp://” string uses port 1935. If SSL is configured. use RTMPS only for applications that require a higher level of security or that handle sensitive or critical data. for example. . For more information. place a minus (“-”) sign in front of the port number. Data passed over the secure connection is encrypted to avoid eavesdropping by unauthorized third parties.-443 When Flash Player encounters an “rtmps://fmsdomain/application” string. nc. To configure the default secure port. it scans the following ports in order: 1935. 80. -1935.proxyType property to "best" before connecting. To specify that a port is secure.allow these protocols on this adaptor --> <RTMPE enabled="true"></RTMPE> </RTMP 3 Set the RTMPE enabled attribute to "false". nc. as follows: ADAPTOR. clients must do the following: 1 Set the NetConnection. “rtmps://host:1935/app”.0 Language Reference. specify that a port is secure. see the NetConnection.This is enabled by default.RTMPE is the encrypted RTMP protocol covering both RTMPE and RTMPTE --> <!-. An incoming connection is a connection between Flash Player and the server. for example. See also “XML configuration files reference” on page 80 Configure SSL Secure Sockets Layer (SSL) is a protocol for enabling secure communications over TCP/IP. To connect to Flash Media Server over an SSL connection. To configure SSL. An outgoing connection is a connection between two servers. 4 Restart the server. RTMPS adheres to SSL standards for secure network connections and enables connections through a TCP socket on a secure port. By default.HOSTPORT parameter in the RootInstall/conf/fms.com/vod/instance1"). which is an 128-bit encrypted protocol. The default secure port for RTMPS is 443. RTMPE is more lightweight than SSL and is enabled by default. Flash Media Server provides native support for both incoming and outgoing SSL connections.0 Language Reference or in the ActionScript 2.Last updated 3/2/2010 FLASH MEDIA SERVER 3.HOSTPORT = :1935. If you configure any port other than 443 as secure.5 CONFIGURATION AND ADMINISTRATION GUIDE 24 Configuring the server <RTMP> <!-. the following client code connects securely: var nc:NetConnection = new NetConnection(). the client must specify the port in the URI.adobe. 443. setting enabled to "false will not --> <!-. enter -443 in the ADAPTOR. it communicates with Flash Media Server over port 443. 2 Specify the RTMPS protocol in the call to the NetConnection. 80 (RTMP tunneling).connect("rtmps://fmsexamples. Because secure connections require extra processing power and may affect the server’s performance. when Flash Player connects to Flash Media Server.

The location of the private key file for the certificate.. If the key file is encrypted. </Adaptor> 2 Edit the following elements..... This can be either "PEM" or "ASN1". The default value is "PEM". The type attribute specifies the type of encoding used for the certificate key file. Secure incoming connections Specify the location of the SSL certificate and the certificate’s private key.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml file for the adaptor you want to configure and locate the following code: <Adaptor> . -----END CERTIFICATE----- The first BEGIN CERTIFICATE/END CERTIFICATE pair is your certificate. it must include the intermediate certificate as part of the certificate that the server returns to the client. -----END CERTIFICATE---------BEGIN CERTIFICATE----. Your certificate file (if signed by an intermediate CA) should look something like the following: -----BEGIN CERTIFICATE----. SSLCertificateKeyFile type="PEM" . If a certificate is signed by an intermediate Certificate Authority (CA). the pass phrase must be specified in the SSLPassPhrase tag. Specify an absolute path or a path relative to the adaptor folder.5 CONFIGURATION AND ADMINISTRATION GUIDE 25 Configuring the server Certificates You can get an SSL certificate from a certificate authority or create a certificate yourself. Specify an absolute path or a path relative to the adaptor folder. 1 Open the Adaptor.. You can add additional sections as needed. The next BEGIN CERTIFICATE/END CERTIFICATE pair is the intermediate CA that signed your certificate. The private key and the certificate can be combined into one file... Element SSLCertificateFile Description The location of the certificate file to send to the client. <SSL> <SSLServerCtx> <SSLCertificateFile></SSLCertificateFile> <SSLCertificateKeyFile type="PEM"></SSLCertificateKeyFile> <SSLPassPhrase></SSLPassPhrase> <SSLCipherSuite>ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH</SSLCipherSuite> <SSLSessionTimeout>5</SSLSessionTimeout> </SSLServerCtx> </SSL> . and configure the adaptor to listen on a secure port.

1 Locate the following code in the Adaptor.-443 This configuration tells the server to listen on ports 1935 and 443.HOSTPORT}</HostPort> </HostPortList> .. add the following HostPort tag in addition to the default HostPort tag: <HostPort name="edge2" ctl_channel=":19351">:1936. digest type.. leave this tag empty. The SSL ciphers: a colon-delimited list of components. Do not change the default settings unless you are very familiar with SSL ciphers. as follows: ADAPTOR. the edge uses the default SSL configuration.ini file.5 CONFIGURATION AND ADMINISTRATION GUIDE 26 Configuring the server Element SSLPassPhrase Description The pass phrase to use for decrypting the private key file. if you’re hosting multiple customers. Each domain name must have its own certificate. </Adaptor> 2 Create new HostPort elements with unique name and ctl_channel attributes and unique port values for RTMP and SSL. If a client reconnects to a session before SessionTimeout is reached. <Ho4stPortList> <HostPort name="edge1" ctl_channel=":19350">${ADAPTOR. A component can be a key exchange algorithm.HOSTPORT parameter in the RootInstall/conf/fms. 5 Check the RootInstall/logs/edge. encryption method. The default value is 5. An RTMPS connection to port 1935 fails: the client attempts to perform a SSL handshake that the server fails to complete.log file to verify that no errors have been reported. The possible values are listed here: “SSLCipherSuite” on page 91.xml file: <Adaptor> . Any value less than 1 is read as 1. An RTMPS connection to port 443 succeeds: the client performs a SSL handshake that the server completes. each virtual host has its own domain name.00. If you don’t specify an Edge element. For example. An RTMP connection to port 443 also fails: the server tries to perform a SSL handshake that the client fails to complete. The amount of time in minutes a session remains valid. and that 443 is a secure port that receives only RTMPS connections. enter an Edge element under the SSL element with an identical name attribute. 4 Restart the server. Configure incoming connections when multiple virtual hosts are assigned to one adaptor You can configure the server to return a certificate based on which port a client connects to. authentication method. SSLCipherSuite SessionTimeout 3 To configure a secure port for an adaptor.-444</HostPort> 3 For each HostPort element.. This lets you assign multiple virtual hosts to one adaptor and return a different certificate for each virtual host.Last updated 3/2/2010 FLASH MEDIA SERVER 3..HOSTPORT = :1935. If the private key file is not encrypted. or one of a selected number of aliases for common groupings. specify a minus sign before the port number in the ADAPTOR. . the cipher suite list isn’t sent during the SSL handshake. Note: Generally.

. Secure outgoing connections 1 Open the Server. The edge2 server returns cert.Last updated 3/2/2010 FLASH MEDIA SERVER 3. edge2 will use the default configuration specified in the SSLServerCtx section that is directly under the SSL container tag.5 CONFIGURATION AND ADMINISTRATION GUIDE 27 Configuring the server This sample code demonstrates how to configure edge1 to return cert2.pem</SSLCertificateKeyFile> <SSLPassPhrase></SSLPassPhrase> <SSLCipherSuite>ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH</SSLCipherSuite> <SSLSessionTimeout>5</SSLSessionTimeout> </SSLServerCtx> <Edge name="edge1"> <SSLServerCtx> <SSLCertificateFile>cert2.pem when a client connects to it on port 443. 5 Restart the server.pem</SSLCertificateFile> <SSLCertificateKeyFile>private.xml file and locate the following code: <Root> <Server> <SSL> <SSLEngine></SSLEngine> <SSLRandomSeed></SSLRandomSeed> <SSLClientCtx> <SSLVerifyCertificate>true</SSLVerifyCertificate> <SSLCACertificatePath></SSLCACertificatePath> <SSLCACertificateFile></SSLCACertificateFile> <SSLVerifyDepth>9</SSLVerifyDepth> <SSLCipherSuite>ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH</SSLCipherSuite> </SSLClientCtx> </SSL> </Server> </Root> 2 Edit the following elements.pem when a client connects to it on port 444. <SSL> <SSLServerCtx> <SSLCertificateFile>cert. Since there is no Edge tag for edge2.pem</SSLCertificateKeyFile> <SSLPassPhrase></SSLPassPhrase> <SSLCipherSuite>ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH</SSLCipherSuite> <SSLSessionTimeout>5</SSLSessionTimeout> </SSLServerCtx> </Edge> </SSL> 4 Validate the XML and save the file.pem</SSLCertificateFile> <SSLCertificateKeyFile>private2.

SSLCipherSuite Configure adaptors to manage outgoing SSL connections independently The SSL section in the Server. authentication method. You don’t need to copy the SSLRandomSeed tag. A component can be a key exchange algorithm. if this tag is empty.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The possible values are listed here: “SSLCipherSuite” on page 169. A Boolean value specifying whether to verify the certificate returned by the server being connected to (true) or not (false). You can import the Windows certificate store to the certs directory by running FMSMaster -console -initialize from a command line. Configure virtual hosts to manage outgoing SSL connections independently For example. use a certificate in a different folder for one virtual host. Disabling certificate verification can result in a security hazard. A folder containing certificates.0. Do not change the default settings unless you are very familiar with SSL ciphers.xml file: . you might want to use a different certificate for each virtual host. In Linux. digest type. The server may take longer to start up if you specify a large number. SSLCACertificatePath SSLCACertificateFile SSLVerifyDepth Specifies the name of a file containing one or more certificates in PEM format. certificate verification fails. as this tag is a server-level setting that cannot be overridden in Adaptor.xml files and enter the new values. encryption method. If a self-signed root certificate cannot be found within this depth. Each file in the folder must contain only a single certificate. or one of a selected number of aliases for common groupings. The default value is true. In this case. However. Entropy is a measure of randomness. 1 Uncomment the SSL section under the Proxy tag in the appropriate Vhost. On a Windows 32-bit operating system. You cannot specify anything less than 8 bytes. and the file name must be hash and the extension ". the server looks for certificates in the RootInstall\certs directory.0". SSLSessionCacheGC SSLVerifyCertificate How often to flush expired sessions from the server-side session cache. you must specify the location of the certificates. you can disable certificate checking in one virtual host. ❖ Copy the SSL section in the Server.xml file configures all adaptors to use the same settings. for example. and implement a different set of ciphers in a third virtual host.xml file to the Adaptor. The default value is 9. assign one virtual host to each adaptor and configure your adaptors individually to override the settings in the Server.xml. Specifies the maximum depth of an acceptable certificate. and the default value is 16. The SSL ciphers: a colon-delimited list of components. Do not disable verification unless you are certain you understand the ramifications. in minutes.xml file. The more entropy. e98140a6. the more random numbers the PRNG will contain.5 CONFIGURATION AND ADMINISTRATION GUIDE 28 Configuring the server Element SSLRandomSeed Description The number of bytes of entropy to use for seeding the pseudo-random number generator (PRNG).

the server uses the default settings. You must enable checkpoint events at the server level in the Server.xml file in a text editor. play-continue. like this: <Checkpoints enable="true">. you don't need to configure Flash Media Server for SSL. Configure the hardware to forward data to Flash Media Server on port 1935.xml and Application. Performing general configuration tasks Enable checkpoint logging events Many companies use statistics from the access log to bill customers. the events you use to calculate billing might not occur within a billing cycle. <Proxy> <SSL> <SSLClientCtx> <SSLVerifyCertificate></SSLVerifyCertificate> <SSLCACertificatePath></SSLCACertificatePath> <SSLCACertifcateFile></SSLCACertificateFile> <SSLVerifyDepth></SSLVerifyDepth> <SSLCipherSuite></SSLCipherSuite> </SSLClientCtx> </SSL> </Proxy> </VirtualHost> When the SSL tag is present. To solve this problem. You can disable checkpoints at the vhost and application level in the Vhost. The following are available as checkpoint events: connect-continue. 2 Locate the Root/Server/Logging/Checkpoints element: <Checkpoints enable="false"> <CheckInterval>60</CheckInterval> <LogInterval>3600</LogInterval> </Checkpoints> 3 Set the Checkpoints enable attribute to true.5 CONFIGURATION AND ADMINISTRATION GUIDE 29 Configuring the server <VirtualHost> . If an SSL tag is omitted from this section.Last updated 3/2/2010 FLASH MEDIA SERVER 3. see the comments in the XML files located in the RootInstall/conf folder.xml files. the entire SSL section is used to configure the virtual host. Flash Media Server listens on port 1935 by default. 1 Open the RootInstall/conf/Server.. The hardware sits between Flash Media Server and the Internet. For more information. The hardware encrypts the data and forwards it to the Internet. 2 Restart the server. 4 You can optionally set values for the CheckInterval and LogInterval elements to indicate how often the server should check for and log events. Data sent between Flash Media Server and the hardware is unencrypted. Configure the hardware to listen externally on port 443 to receive encrypted data sent over Internet from clients. You can also override the logging interval at the vhost and application levels. If your programming includes live events or 24/7 programming.. configure the hardware to forward data on that port. Checkpoint events log bytes periodically during an event. and publish-continue. . If you’ve changed the default port. you can enable checkpoint events.xml file. Configure Flash Media Server to work with a hardware SSL proxy When you use a hardware SSL proxy.

1 Open the RootInstall/conf/fms. 2 Locate the following XML: <Debug> <MaxPendingDebugConnections>50</MaxPendingDebugConnections> <AllowDebugDefault>false</AllowDebugDefault> </Debug> 3 Set the AllowDebugDefault element to true. Wherever a numeric IPv6 address is used in a client-side script.xml file of the virtual host or application you want to configure. Configuring IPv6 IPv6 (Internet Protocol version 6) is a new version of Internet Protocol that supports 128-bit addresses.5 CONFIGURATION AND ADMINISTRATION GUIDE 30 Configuring the server 5 Save and validate the file.xml file” on page 175. Note: Debug connections count against license limits.ini file and set the SERVER. For more information. the server does not allow this connection. Important: In Red Hat® Linux systems.NetworkingIPV6 enable attribute to "true". IPv6 alleviates the address shortage problem on the Internet. Restart the server. IPv4.HTTPCOMMAND_ALLOW parameter to a comma-delimited list of APIs. By default. Enclose numeric IPv6 addresses in URLs in brackets.ini file. 6 Restart the server. The default value is ping. and restart the server. enclose it in brackets: . The current version of Internet Protocol. Allow Administration API methods to be called over HTTP You must specify each Administration API method that may be called over HTTP. Activate IPv6 on the network interface card. supports 32-bit addresses. You may need to activate IPv6 on the interfaces. server-side script. you must update the NETWORKING_IPV6 value in /etc/sysconfig/network when installing or uninstalling IPv6. Allow application debugging connections To play back streams and obtain data from shared objects. or in the server configuration files. A system that only runs IPv6 can't communicate with a system that only runs IPv4. Allow the server to listen on IPv6 sockets. 5 Restart the server. the Administration Console must make a special debugging connection to the server. 2 Set the USERS. see the operating system’s Help. Open the RootInstall/conf/fms. 4 Save and validate the file. For more information. see “Users.Last updated 3/2/2010 FLASH MEDIA SERVER 3. IPv6 is embedded in all operating systems that the server supports. 1 Open the Application.

If you define properties in the default Application. For example.192.108]:1935/streamtest You must specify the interface zone index for a link-local address: rtmp://[fe80::204:23ff:fe14:da1c%4]:1935/streamtest It’s a good idea to register the RTMP.prop_name application. create an XML tag in the JSEngine section of the Application.133. not from application.config.log.property.config["prop_name"] Note: The properties you define are accessible from application. Check the logs. if you are using an IPv4 host name (a host name that resolves to IPv4) on an RTMPT or RTMPTE connection. See HTTPIdent2. the properties are available only for that application.42 IPv6: fe80::204:23ff:fe14:da1c%4 Listener started ( _defaultRoot__? ) : 19350/v6 Listener started ( _defaultRoot__? ) : 19350/v4 Listener started ( _defaultRoot__? ) : 1935/v6 Listener started ( _defaultRoot__? ) : 1935/v4 Note: On IPv6-enabled Linux.log.xx.config.Last updated 3/2/2010 FLASH MEDIA SERVER 3. if necessary) in the server configuration files. and RTMPE protocols with a network services database and use a service name (or decimal port number.xml appropriately to resolve connections quickly. and all available IP addresses for the host in the master. it logs available stack configuration. host name. To define a property. with the values jdoe and engineering. use the syntax in either of these examples: application. . When the server starts.xx.5 CONFIGURATION AND ADMINISTRATION GUIDE 31 Configuring the server rtmp://[fd5e:624b:4c18:ffff:0:5efe:10. you should configure the Adaptor. the following XML fragment defines the properties user_name and dept_name. and that the server host has dual addresses and is listening on both interfaces: FMS detected IPv6 protocol stack! FMS config <NetworkingIPv6 enable=true> FMS running in IPv6 protocol stack mode! Host: fmsqewin2k3-02 IPv4: 10. edge.xml file.property.133.128.xml file in an application folder. The following xcomment fields from a sample edge log file indicate that the IPv6 stack and the IPv4 stack are available.xml file. and admin. respectively: <Application> <JSEngine> <config> <user_name>jdoe</user_name> <dept_name>engineering</dept_name> </config> </JSEngine> </Application> To access the property in server-side code. the properties are available for all applications on a virtual host. and the property value corresponds to the tag’s contents. The property name corresponds to the tag’s name.xx. RTMPS.log files (located in the RootInstall/logs/ directory).xml configuration files. If you define properties in an Application. Defining Application object properties You can define properties for the server-side Application object in the server’s Application.

the outermost edge server detects the bandwidth. trace("I am " + application.xml file.config. the following trace() statements are valid: trace("I am " + application. Native bandwidth detection is enabled and configured by default.config. or in a serverside script (called script-based bandwidth detection)."). You can also use environment variables and symbols you define in the substitution. given the previous XML fragment. which results in more accurate data. More Help topics “Using symbols in configuration files” on page 10 Configure or disable native bandwidth detection The server can detect a client’s bandwidth in the core server code (called native bandwidth detection). the following XML appears in the Application.xml file: <Root> <Symbols> <DEPT>Engineering</DEPT> </Symbols> </Root> In addition. The output from either statement would be as follows: I am jdoe and I work in the engineering department. For example.dept_name + " department.config.config["dept_name"] + " department.5 CONFIGURATION AND ADMINISTRATION GUIDE 32 Configuring the server For example. . trace("My department is: " + application. with native bandwidth detection. The output is as follows: My computer's name is: jsmith01 My department is: Engineering Note: Server-side ActionScript trace()statements display in the Live Log panel of the Administration Console.Last updated 3/2/2010 FLASH MEDIA SERVER 3.dept). and you have defined a symbol named DEPT in the substitution."). if a client connects through edge servers.compName). Native bandwidth detection is faster than script-based because the core server code is written in C and C++.xml file: <Application> <JSEngine> <config> <compName>${%COMPUTERNAME%}</compName> <dept>${DEPT}</dept> </config> </JSEngine> </Application> In a server-side script. Also.user_name + " and I work in the " + application. the following trace statements are valid: trace("My computer's name is: " + application.config.config["user_name"] + " and I work in the " + application. assume that the environment variable COMPUTERNAME is equal to jsmith01.

To detect the client’s bandwidth..Last updated 3/2/2010 FLASH MEDIA SERVER 3. Configuring content storage Setting the location of application files The presence of an application folder within the applications folder tells the server that the application exists. you can configure the size of the data chunks.ini file: • Registered applications folder: VHOST. Within the applications folder.. create subfolders for your applications. followed by 2x bytes. Increasing this number provides a more accurate bandwidth figure..xml file: .xml file. Note: To disable native bandwidth detection. followed by 3x bytes.. The number of seconds the server sends data to the client. x bytes are sent. each time sending this much more data. DataSize MaxWait 3 Save and validate the Application. set the enabled attribute to false and restart the server. see the Developer Guide. the rate at which they’re sent. <BandwidthDetection enabled="true"> <MaxRate>-1</MaxRate> <DataSize>16384</DataSize> <MaxWait>2</MaxWait> </BandwidthDetection> . the server attempts to send a series of random blocks of data to the client. 1 Locate the following code in the Application.. By default. For example.5 CONFIGURATION AND ADMINISTRATION GUIDE 33 Configuring the server The server detects bandwidth by sending a series of data chunks to the client. edit the locations in the following parameters in the fms. The maximum rate in Kbps that the server sends data to the client. which sends the data at whatever rate is necessary to measure bandwidth. the following path is to an instance of an application called “my_application”: RootInstall/applications/my_application/first_instance To change the location of the applications folder and the live and vod applications. The amount of data in bytes that the server sends to the client. and the amount of time the server sends data to the client. create subfolders to create instances of applications. If desired.. and so on until MaxWait time has elapsed. . Within each individual application folder.. The default value is -1. . 2 Edit the following elements. each larger than the last. For more information about detecting bandwidth in an application. Element BandwidthDetection MaxRate Description Set the enabled attribute to "true" or "false" to turn this feature on or off. the applications folder is located at RootInstall/applications. 4 Restart the server. For example.APPSDIR .. but it also forces the client to wait longer.

Otherwise.) 4 Restart Flash Media Server and Flash Media Administration Server. use virtual directories.xml file to specify a different location to store streams or shared objects. Within the directory that you specify as the storage directory. Note: Adobe strongly recommends that folders that store streams always contain only streams and no other application files. Setting the location of recorded streams and shared objects By default.5 CONFIGURATION AND ADMINISTRATION GUIDE 34 Configuring the server • Live application: LIVE_DIR • Vod application: VOD_DIR Mapping directories to network drives By default.Last updated 3/2/2010 FLASH MEDIA SERVER 3. you set the storage directory to C:\Content for the chatApp application: <storageDir>C:\Content</storageDir> When a user connects to the firstRoom instance of the chatApp application and tries to play a stream. Use the StorageDir tag in the Application. When you specify a value for the <storageDir> element in the application-specific XML. 2 Make the changes to the configuration. Let’s say. when you specify a value in the virtual host-level Application. You can change the service user to a user with network access privileges with a UNC path. all recorded streams for an application are stored in a streams folder in the application directory. If the server is running as a service and the user is logged out. you can set the storage directory to that other directory instead of copying content to the application directory. for example. 3 Check that the server user has appropriate access rights to map to the network drive (system account rights are usually not sufficient. the scope is extended to all the applications on that virtual host. the mapped drive is removed as well. Shared objects are stored in a shared objects folder in the application directory. A Windows network-mapped drive is not valid when a user is logged out. the server looks for the stream in a subfolder C:\Content\firstRoom. Using the UNC path is preferred when the server is running as a service. the server runs as System Account with no access to network drives. Content for each instance is sandboxed from other instance of the same application. To run with the mapped drive. Flash Media Server sandboxes the content for each instance of an application. . that value is specific to the application. a user who connects to the secondRoom instance would not be able to access the content in C:\Content\firstRoom. 1 Stop Flash Media Server and Flash Media Administration Server. You could do this for vod applications. If you do not want resources to be sandboxed by application and application instance.xml. you must create physical subdirectories for different application instances. if you already have a collection of video files in a directory other than the application directory. For example. lock the server instead of logging out.

xml file’s mapping of '/' (if it exists) for this application only. • When specified in the virtual-host Application.5 CONFIGURATION AND ADMINISTRATION GUIDE 35 Configuring the server Mapping virtual directories to physical directories Flash Media Server stores recorded streams and video and audio files in default locations in the application directory.xml file instead of the virtual-host Application. To map a virtual directory for an application. or by passing "rtmp://myDomain/VOD/sample. <VirtualDirectory> controls only the storage location of resources for that application. The order in which the server determines the correct directory to use for streams is as follows: 1 Virtual directory (as specified in <VirtualDirectory>) 2 Storage directory (as specified in <storageDir>) 3 Default location (the streams folder in the application directory) Note: Adobe strongly recommends that folders that store streams always contain only streams and no other application files. edit the application-specific Application. .xml file. although Adobe recommends that if you want control at the virtual host level. A connecting client will be able to play a file in the virtual directory. you configure the <VirtualDirectory> tag in Vhost. Use multiple <Streams> tags. To map a directory in this way. • When specified in an application-specific Application. <VirtualDirectory> controls the storage location of all applications on that virtual host.Specifies application specific virtual directory mapping for recorded streams.xml file to include the virtual directory.xml or the Application.play("sample").play().flv" to the source property of a call to FLVPlayback. the server maps the name to the specified directory and first looks for the stream in the specified directory. such as C:\my_videos\sample. by connecting to the vod application and issuing a NetStream play() call: ns.C:\my_videos</Streams> </VirtualDirectory> </StreamManager> </Application> This code overrides the VHost.xml file. Any instance of the application can access video files in that location (unlike with <storageDir>). but other applications cannot.xml file. but without restricting access by application or application instance. as shown in the following example: <Application> <StreamManager> <VirtualDirectory> <!-.xml file. you do not need to copy resources to Flash Media Server’s application directory. This element provides various options: • You can specify a virtual directory name or not.flv.Last updated 3/2/2010 FLASH MEDIA SERVER 3. You would use the <VirtualDirectory> element in the application-specific Application. All applications on the virtual host can access video files in the specified location.xml file or the Vhost. you can use the <VirtualDirectory> element in the Vhost. By mapping a virtual directory to a physical directory. Virtual directory example: vod One usage scenario for this element is to specify a directory to use for a specific vod application and put video files in this directory to stream them instantly. • You can specify multiple physical directories for a single virtual directory. In some scenarios. --> <Streams>/. you might want to specify particular locations for these resources. and you can retain your existing classification and categorization of resources.xml file. When a name is specified.

xml.5 CONFIGURATION AND ADMINISTRATION GUIDE 36 Configuring the server The <VirtualDirectory> element in the application-specific Application.play("high/sample") tells the server to look for the sample. including mapping to a network drive. so the server will then look for sample. If no storage directory is specified by <storageDir>. You can create a mapping wherein all streams that start with low are stored in specific directories. Virtual directory example: Separating high. so it will always be checked first. a call to ns. and how the configurations determine the directory to which a recorded stream is published. protecting your streams from being accessed by other applications on the same virtual host. This call tells the server to look for the sample. then the server looks in the default location (the streams folder) for the file. the stream name does not match any virtual directory specified. and all streams that start with high are stored in a different directory: <VirtualDirectory> <Streams>low. In the first case.play("low/sample"). the order in which the server looks for files is: 1 Virtual directory (as specified in <VirtualDirectory>) 2 Storage directory (as specified in <storageDir>) 3 Default location (the streams folder in the application directory) Virtual directory example: Local and network file paths The following table shows three examples of different virtual directory configurations.play(”low/sample”). that is.c:\high_bandwidth</Streams> </VirtualDirectory> When the client wants to access low-bandwidth video. which is mapped in Application. ns. Note that if the client calls ns. C:\low_bandwidth and C:\low_bandwidth2.play("sample").and low-bandwidth video One way you can use directory mapping is to separate storage of different kinds of resources. the server publishes the stream to the default streams directory. because the URI specified ("myStream") does not match the virtual directory name that is specified ("low").flv file in the C:\low_bandwidth and C:\low_bandwidth2 folders.c:\low_bandwidth2</Streams> <Streams>high.flv inside the directory specified by the storage directory element (<storageDir>). the client calls ns. Similarly. .xml file.xml file affects only that particular application. C:\low_bandwidth\sample.c:\low_bandwidth</Streams> <Streams>low. and you might want to store high-bandwidth and low-bandwidth video in separate folders.flv A client connects to the sample. your application could allow users to view either high-bandwidth video or low-bandwidth video.flv file in the c:\high_bandwidth folder.flv file in the low-bandwidth storage area on the server. It has a higher precedence than the virtual directory mapping in the Vhost.Last updated 3/2/2010 FLASH MEDIA SERVER 3. For example.

container HTML pages.5 by default on Windows). The Apache documentation and configuration files use “ServerRoot” to indicate the Apache root installation folder.xml files. edit the RootInstall/Apache2.ini and Adaptor. To manually enable Apache. The Apache root installation folder is RootInstall/Apache2. see “Monitoring and Managing Log Files” on page 55.\RootInstall\applications\yourApp\streams\_definst_\myStream. and media assets from Flash Media Server. Note: The Flash Media Server documentation uses “RootInstall” to indicate the Flash Media Server root installation folder (C:\Program Files\Adobe\Flash Media Server 3. If you install and enable the web server. In addition. • The log files are in the RootInstall/Apache2.2/manual/programs folder.flv e:\fmsstreams\myStream.\\mynetworkDrive\share\fmsstreams URI in NetStream call Location of published stream "myStream" "low/myStream" "low/myStream" c:\.ini file in a text editor.5 CONFIGURATION AND ADMINISTRATION GUIDE 37 Configuring the server Mapping in Vhost. as well as RTMP. The web root is RootInstall/webroot. .conf file and the standard secondary configuration files are in the RootInstall/Apache2. such as ASC • Handle any non-standard MIME types required for progressive download • Serve the default server-status and server-info pages • Modify source directories Enable Apache When you install Flash Media Server and choose to install Apache.flv \\mynetworkDrive\share\fmsstreams\myStream. you can deliver client SWF files.2.5 includes Apache HTTP Server.2/logs folder. 1 Open the fms. You can use Apache documentation for most configuration tasks.2/conf folder. edit the fms. it is enabled by default.Last updated 3/2/2010 FLASH MEDIA SERVER 3.e:\fmsstreams low. • The httpd. For more information. Installation locations The Apache server that installs with Flash Media Server differs from a standard Apache installation in the following ways: • The apachectl files are in the RootInstall/Apache2. Alternate configurations To do any of the following.conf file: • Handle multiple adaptors or virtual hosts • Block sensitive file types.2/conf/httpd. The Flash Media Server installation of Apache is like the standard installation. You can serve content over HTTP. you can serve video over HTTP progressive download as a fallback solution for web proxies that break RTMP or RTMPT.xml <VirtualDirectory><Streams> tag low.flv Configuring Apache HTTP Server About Apache HTTP Server Flash Media Server 3...e:\fmsstreams low.

HOSTPORT = :1935.pl http://myFMSServer. HTML files.com:80 Deliver SWF files and HTML files over HTTP Apache can deliver SWF files.HOST parameter. Configure HTTP proxying in the RootInstall/conf/fms.2/cgi-bin RootInstall/Apache2. The default Adaptor.HOST = :8134 Setting the parameter to no value disables HTTP proxying: HTTPPROXY. 5 Set the enable attribute of the HttpProxy tag to "true".HOST variable in the RootInstall/conf/fms. 80 3 To start and stop Apache when Flash Media Server starts and stops.xml file. and many other standard file types over HTTP. If you have multiple adaptors. JPG files. 6 Save and validate the Adaptor. you can enable or disable proxying through the HTTPPROXY.example.com/cgi-bin/someScript.ini file. Apache is configured to use following paths: Path / /cgi-bin /local-cgi-bin Location RootInstall/Apache2. open the file for the adaptor you want to configure. Flash Media Server proxies HTTP connections to port 8134. 7 Restart the server. Place files that you want to deliver over HTTP in the correct folders. In the fms. You can also specify the port to proxy to or proxy to a remote server.HOST = To proxy to a remote server. You can also remove the variable and set the value directly in the Host tag. ADAPTOR.HTTPD_ENABLED = true 4 Open the Adaptor.com/local-cgi-bin/someScript.ini file. To allow Flash Media Server to serve media over HTTP when RTMPT is blocked. The following default configuration proxies port 80 HTTP requests to local port 8134: HTTPPROXY.2/webroot RootInstall/Apache2.HOST parameter. By default.com/app. set the SERVER.5 CONFIGURATION AND ADMINISTRATION GUIDE 38 Configuring the server 2 Add port 80 to the ADAPTOR.HOST}</Host> </HttpProxy> Set the value of the HTTPPROXY.xml file is located in the RootInstall\conf\_defaultRoot_ folder.swf http://myFMSServer.ini file.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml configuration file in a text editor.HOST = webfarm. HTTP connections by default use port 80. set the parameter to the remote server you want to use: HTTPPROXY. set a value for the HTTPPROXY.pl . as in the following: <HttpProxy enable="true" maxbuf="16384"> <Host port="80">${HTTPPROXY.HTTPD_ENABLED parameter to true: SERVER.HOSTPORT tag. To enable HTTP proxying. Configure HTTP proxying Flash Media Server uses port 80 for RTMPT connections.2/local-cgi-bin Example URL http://myFMSServer.

either use one of the predefined web directories or create a web directory for that application.xml. see the Apache HTTP Server version 2. are accessible only to Flash Media Server. edit the RootInstall/Apache2. use custom aliases to give the HTTP virtual directories slightly different names from the RTMP applications. see the Apache documentation at www. If you have a CGI program used by server-side ActionScript.9 documentation at www.com/cgi-bin/someScript. Apache assumes any file you place in the RootInstall/Apache2. For example.5 CONFIGURATION AND ADMINISTRATION GUIDE 39 Configuring the server These folders are global. Apache serves it the someVideo. To change the location of the cgi-bin or the local-cgi-bin.2.org. edit the httpd. Deploying CGI programs By default.com/hd/someVideo. send. close.2/cgi-bin/someScript.2/cgi-bin folder is a CGI program. the following lines create an alias that points to the streams directory of an application called “hd”: Alias /hd/ "applications/hd/streams/_definst_/" <Directory "applications/hd/streams/_definst_/"> Options Indexes MultiViews FollowSymLinks AllowOverride None Order allow. on the other hand. Apache attempts to execute the file RootInstall/Apache2. For example.apache.2/conf/httpd. fpad.2/conf/httpd.conf file. such as “open_”. fcs.Last updated 3/2/2010 FLASH MEDIA SERVER 3.pl.example. place it in the local-cgi-bin folder. Using Apache as a WebDAV host You can configure the web server to act as a WebDAV host.conf file. .deny Allow from all </Directory> Copy media files to the RootInstall/applications/hd/streams/_definst_/ folder to serve them over HTTP. Create web directories for applications To have Apache serve content over HTTP.2/local-cgi-bin Notes Accessible to anyone through an HTTP call.flv. add an alias to the RootInstall/Apache2. fms. The following keywords are reserved words: open.pl. If you have applications with these names. Files in the local-cgi-bin folder. not application-specific. Any SWF files and HTML files you want to serve over HTTP must be in these folders or in application-specific folders. if a client requests http://fms. crossdomain.example. To create aliases for application-specific folders. Apache is configured with the following global aliases: Alias /cgi-bin/ /local-cgi-bin/ Path RootInstall/Apache2.org. To create a web directory for an application.conf file. For more information about editing the configuration file. For information. For example. if a client requests the URL http://fms. idle.2/cgi-bin RootInstall/Apache2.flv file from the RootInstall/applications/hd/streams/_definst_/ folder.apache. Accessible only to Flash Media Server. Reserved words cannot be used for directory names under the webroot directory or for anything else.

Note: The Administration Console calls Administration APIs to inspect and manage the server.swf files to the Mac. .htm and fms_adminConsole. You can change the port number of the Administration Server after installation by editing the fms.5 > Flash Media Administration Console.swf files in a browser with Flash Player.swf) that lets you manage the server and view information about applications running on the server.Last updated 3/2/2010 40 Chapter 3: Using the Administration Console Use the Adobe Flash Media Server Administration Console to maintain the server. This name is an alias you can use to connect to a server quickly. The Administration Console connects to Adobe Flash Media Administration Server. select Start > Programs > Adobe > Flash Media Server 3. monitor applications. localhost:1234. • On Mac® OS.htm and fms_adminConsole. • On Linux. which connects to Adobe Flash Media Server. open the fms_adminConsole. the Administration Server in installed on port 1111 (the default value at installation time).swf and fms_adminConsole. Connect to the Administration Console There are two types of administrators: server administrators and virtual host (vhost) administrators. 3 In the Server Address box. Application developers can also use the Administration Console to debug applications. do one of the following: • Type localhost if the server and the Administration Console are running on the same computer. Connecting to the Administration Console About the Administration Console The Administration Console is an Adobe Flash Player application (fms_adminConsole. the fms_adminConsole. Otherwise. Use the Flash Media Server Administration API Reference to build your own administrative applications. If you installed Apache with Flash Media Server. your session is specific to a virtual host.ini file. Server administrators have access to all applications running on the server. and manage users. for example. When you log in to the Administration Console as a virtual host administrator. The Administration Console remembers the server address for this server name the next time the console is opened.htm files are located in the root installation folder. By default. you must enter the port number as well. copy the fms_adminConsole. To log in to the Administration Console. the Administration Server must be running. 2 (Optional) Specify a server name. and you can only manage applications running on that virtual host.htm files are located in the RootInstall/webroot folder. do one of the following: • On Windows. Entering localhost connects you to the default virtual host on this computer. Open the fms_adminConsole. If the Administration Server is installed on a port other than 1111 (the default).htm file in a web browser that has Flash Player installed. the fms_adminConsole.swf and fms_adminConsole. 1 To open the Administration Console.

and select Pause.com) or the IP address and port number (12. enter the administrator user name and password you entered during installation. Reverting deletes all saved servers. To run the Administration Console from a computer other than the one in which the server is installed. check that the Administration Server has not been configured to prohibit connections from the specific domain or IP address you are using.example. Ensure your computer has permission to connect to the specified port on the other computer. enter the server’s name (FlashMediaServer. user names. however. verify that the Allow and Deny tags in the Users.xml file allow the connection from the other computer’s IP address. 7 (Optional) Click Revert to return the Administration Console to its default settings. Change or pause the refresh rate The information in the Administration Console panels refreshes every 5 seconds by default. If you are the server administrator who installed the server. scroll down.) 8 Click Login.34. To log in to a virtual host that is not on the default adaptor. or pause refreshing at any time.ini file. 4 Enter your username and password. you can edit your local hosts file at windows\system32\drivers\etc\hosts. In both cases.Last updated 3/2/2010 FLASH MEDIA SERVER 3.com). You can change the refresh rate to any time interval between 1 and 60 seconds. The host name must be mapped to a valid network IP address. Note: The color of the vertical bar in the upper-right corner (next to the question mark icon) indicates whether the Administration Console is connected (green) or not connected (red) to a server. The username and password are stored in the RootInstall/conf/fms. Also. 5 (Optional) Select the Remember My Password option. Change the refresh rate of the Administration Console ❖ Click the pop-up menu next to Refresh Rate (upper-right corner) and select a new time duration. Otherwise. does not affect the server. . All custom resizing within the Administration Console is restored to the original state. Click the folder icon to display links to the Flash Media Server website and related resources. You can disconnect at any time by clicking Logoff. For example.myCompany. Pause refreshing the Administration Console 1 Click the pop-up menu next to Refresh Rate (upper-right corner). Near the top of every screen of the Administration Console are two icons. • If you are connecting remotely by running the Administration Console on another computer. 6 (Optional) Select the Automatically Connect Me option. copy fms_adminConsole. enter the username and password you received from the server administrator. www. and passwords from the Administration Console. you must specify the name of the adaptor. (The Revert button. when logging in to a virtual host on the adaptor _secondAdaptor_.5 CONFIGURATION AND ADMINISTRATION GUIDE 41 Using the Administration Console • To connect to a virtual host other than the default virtual host. the vhost administrator JLee would enter the following information in the Username box: _secondAdaptor_/JLee.htm and fms_adminConsole. enter the fully qualified host name (for example. or make sure that this file is in the webroot directory so it can be accessed remotely. such as 10 seconds. Click the question mark icon to display links to Flash Media Server Help. To test this behavior on Windows.78:1112) of the Administration Server to which you want to connect.56.swf to the other computer.

Use the View Applications panel to view. or unload application instances. From here.) 7 The Administration Console adds a default instance _definst_. which can be edited. move to another panel and then back to refresh the console. press Shift+Escape. 3 Enter the administrator user name and password. To cancel. Note: If you add an application while the Administration service is running and the new application doesn't appear in the Administration Console. 5 Click New Instance. load. 2 Enter the name and address of the server or virtual host to which you want to connect. Manually load an application instance in the Administration Console 1 Follow the steps in “Connect to the Administration Console” on page 40. . 6 Select the application from the pop-up menu. the state of an application can be monitored. Inspecting applications View applications After connecting to a server or virtual host. Press Enter to submit the name and start the application instance. 4 Click View Applications. 3 To start refreshing information again. click the pop-up menu and select a time duration. (The application must already be configured on the server. the Administration Console displays a panel that lists the currently running application instances.Last updated 3/2/2010 FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 42 Using the Administration Console 2 Click Pause Refresh to continue. A red border appears around the panels of the Administration Console to show that the refresh feature is paused.

4 Click Unload (stop icon to the right of the Performance tab) Viewing log messages for an application The Administration Console Live Log panel displays log messages and trace() statements from server-side scripts for the selected application instance. The information in this panel is updated whenever the application instance generates a log message.5 CONFIGURATION AND ADMINISTRATION GUIDE 43 Using the Administration Console Reload an application instance in the Administration Console Reload an application instance to reload the server-side scripts for the instance or to disconnect all of its users while immediately allowing new connections.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 2 Click View Applications. such as total uptime or number of users Sort applications list 1 Follow the steps in “Connect to the Administration Console” on page 40. View information about an application 1 Follow the steps in “Connect to the Administration Console” on page 40. 2 Click View Applications. 2 Click View Applications. 3 Select an application from the list. (If the console refresh feature is paused. do one of the following: • Click the Name column header to sort the applications list by name.) . 1 Follow the steps in “Connect to the Administration Console” on page 40. 1 Follow the steps in “Connect to the Administration Console” on page 40. 3 Select an application from the list. 3 In the applications list. 4 Click Reload (circular arrow icon to the right of the Performance tab). log messages are still received. End an application instance When an application instance is ended. The following information is listed for the application on the different tabs: • Log messages generated by the application instance on the server • A list of clients connected to the application instance • A list of active shared objects for the application instance • A list of active streams for the application instance • Information about the overall state of the selected application instance. 3 Select the application from the list. all users are disconnected and all instance resources are released. 2 Click View Applications. • Click the Clients column header to sort by client.

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 44
Using the Administration Console

Live Log panel

1 Follow the steps in “Connect to the Administration Console” on page 40. 2 Click View Applications. 3 Click Live Log. 4 Select an application from the list. 5 Type text in the Find text box and click Find Next. Use the Find Previous and Clear Log buttons as necessary.

Viewing active streams
Use the Administration Console Streams panel to view information about streams and to play streams.

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 45
Using the Administration Console

Streams panel

1 Follow the steps in “Connect to the Administration Console” on page 40. 2 Click View Applications. 3 Click Streams. 4 Select an application from the list. The Streams panel displays the following information:

• Name: For NetStream streams, the name is the NetStream ID (a server-generated number). For a live stream
being published, the entry displays the live stream name. For a recorded steam, the entry displays the FLV or MP3 filename; for example, flv:stream2.flv or mp3:sound.mp3. If a client requests the stream2.flv, there will be two entries: one for flv:stream2.flv (stored) and one for the actual network stream going to the client.

• Type: A string that describes the type of stream, either stored, live, or NetStream.
5 Select a stream to view its properties. The values of the properties are as follows:

• Name: The actual stream name, not streamID. • Status: States if the stream is publishing, playing live, or playing recorded. • Client: The client ID playing the stream. • Time: The time that the client started playing the stream.
Note: If the stream type is available for debugging, the Administration Console displays its properties in the adjoining panel. If the type is not available for debugging, an error message is displayed.
6 Click Play Stream to start playing the selected stream in a separate window that is the size of the selected stream.

(The Play Stream button appears only if a debug connection is possible. Only named streams can be played.)

Viewing active clients
The Administration Console Clients panel lists detailed information about all clients connected to an application.

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 46
Using the Administration Console

Clients panel

1 Follow the steps in “Connect to the Administration Console” on page 40. 2 Click View Applications. 3 Click Clients. 4 Select an application from the list. The following information is displayed:

• Client ID: The internal ID of the client; this represents a server-generated number that Flash Media Server uses
to identify each client.

• Protocol: The connection protocol that the client uses, such as RTMP. • Bytes In and Bytes Out: The average bytes per second being sent to and from the server. The Administration
Console calculates this ratio by dividing the total number of bytes received in the most recent 15 seconds by 15. When the panel first appears, these figures appear as pending because there is only one data point to start with; figures appear after the panel is open for 15 seconds.

• Connection Time: The date and time the client connected. • Messages In and Messages Out: The number of messages sent to or from the client. Messages In reflects update
requests sent from clients to the server; Messages Out reflects notification of successful updates sent from the server to connected clients.

• Drops: The number of messages dropped since the client connected. For live streams, audio, and video,
messages may be dropped; for recorded streams, only video messages are dropped. Command messages are never dropped.

Viewing active shared objects
The Administration Console Shared Objects panel lists the active shared objects for an application and can be useful when debugging an application. The information is automatically refreshed every 5 seconds, or click Refresh to refresh at any time. The Administration Console displays the name, type (persistent or temporary), and connections (number of users subscribed) of each shared object.

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 47
Using the Administration Console

Shared Objects panel

Note: The Administration Console was built using ActionScript 2.0 and cannot understand AMF3 data. Therefore, the Administration Console cannot display data in remote shared objects in applications built in ActionScript 3.0 unless the application sets the NetConnection.objectEncoding property to AMF0.
1 Follow the steps in “Connect to the Administration Console” on page 40. 2 Click View Applications. 3 Click Shared Objects. 4 Select an application from the list. 5 To display information about a shared object, click the object. The number of users currently connected to and

using the shared object is displayed, along with the data properties assigned to the shared object.

View performance information
The Administration Console Performance panel shows information about the overall state of the application instance. The information is automatically refreshed every 5 seconds, or click Refresh to refresh at any time.

For example. look at the Live Log panel under View Applications. The following information is displayed: • Clients: Information about clients connected to this application instance. data received. When the panel first appears. (To determine why connections may have failed. • CPU and Memory Usage: The percentage of CPU and memory used by Flash Media Server. in the Bandwidth graph.5 CONFIGURATION AND ADMINISTRATION GUIDE 48 Using the Administration Console Performance panel 1 Follow the steps in “Connect to the Administration Console” on page 40. 4 Select an application from the list. figures appear after the panel is open for 15 seconds. 3 Click Performance. and the combined amount of data traffic. active clients. audio packets.) • Lifespan: The length of time the application instance has been running and the date and time it began to run. these figures appear as pending because there is only one data point to start with. • Bytes Per Second: The average number of bytes sent per second for this application instance. select Total and deselect In and Out to show only the total amount of bandwidth used. • Messages Per Second: The average number of messages (video frames. 5 Select and deselect checkboxes to customize the information displayed on the graphs. including the total number of clients who connected to the application instance since it started.Last updated 3/2/2010 FLASH MEDIA SERVER 3. • Active Connections: The number of users currently connected to the application instance. and the number of users whose attempts to connect to the application instance were rejected. • Bandwidth: The amount of data that the application instance manages. and command messages) sent per second. 2 Click View Applications. The Administration Console calculates this ratio by determining the total number of bytes received in the most recent 15 seconds and dividing that value by 15. . including data sent.

ADMIN_USERNAME}"> <Password encrypt="false">${SERVER. The User name attribute specifies the user name. and Order elements specify the hosts from which the administrator can connect to the Administration Console. Server administrators can control all virtual hosts and perform server-level tasks. such as restarting or shutting down the server. 3 Click New User. Edit the Users. . Deny. Virtual host administrators can manage the applications on their virtual host—for example. Add administrators Use the Administration Console to add server administrators Note: You must be a server administrator (not a virtual host administrator) to access the Manage Users tab. they can reload or disconnect applications.xml file. 3 Add a new <User></User> section for each server administrator you want to add.xml file to add server administrators 1 Open the RootInstall/conf/Users. see the comments in the Users. They cannot manage servers or administrative users. You do not need to restart either server.ADMIN_PASSWORD}</Password> <Allow></Allow> <Deny></Deny> <Order>Allow.xml file. There are two types of administrators: server administrators and virtual host administrators.xml file. 2 Select the Manage Users tab. Server administrators can access and perform all operations on all tabs. The following sample XML adds a user who can connect from any domain: <UserList> <User name="${SERVER. The Administration Console adds the new user and password to the Users.Deny</Order> </User> <User name="janedoe"> <Password encrypt="false">S4mpl3P4ss</Password> <Allow></Allow> <Deny></Deny> <Order>Allow. Virtual host administrators can access and perform operations on the View Applications tabs. The Password element specifies the password. 4 Enter the user name and password and click Save. 2 Locate the UserList section.Deny</Order> </User> </UserList> For more information.5 CONFIGURATION AND ADMINISTRATION GUIDE 49 Using the Administration Console Manage administrators About administrator roles Administrators are users who are allowed to log in to the Administration Console.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The Allow. 1 Log in to the Administration Console as a server administrator.

5 Confirm the action. and Order elements specify the hosts from which the administrator can connect to the Administration Console. 4 Click Reset The Password For This User. copy the Users. for example.xml file. Delete user account 1 Log in to the Administration Console as a server administrator.xml.sampleVhost. 5 Type a new password.Deny</Order> </User> </UserList> For more information. Delete administrator accounts and reset passwords You must be a server administrator (not a virtual host administrator) to perform operations on the Manage Users tab. 2 Click Manage Users. RootInstall/conf/_defaultRoot_/www. . Deny. 4 Click Delete This User Account On The Server. 2 Locate the UserList section. Reset user password 1 Log in to the Administration Console as a server administrator. 3 Select a user.Deny</Order> </User> <User name="vHostAdmin"> <Password encrypt="false">Ex4mpl3P4ss</Password> <Allow></Allow> <Deny></Deny> <Order>Allow. see the comments in the Users.xml file in the root folder of the virtual host. Add virtual host administrators 1 Open the Users.xml file.xml file from the RootInstall/conf folder.com/Users. 3 Add a new <User></User> section for each virtual host administrator you want to add. If the file doesn’t exist.ADMIN_USERNAME}"> <Password encrypt="false">${SERVER. The Password element specifies the password. The User name attribute specifies the user name. 4 Validate the XML and save the Users. 2 Click Manage Users.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 3 Select a user.xml file.5 CONFIGURATION AND ADMINISTRATION GUIDE 50 Using the Administration Console 4 Validate the XML and save the Users. The following sample XML adds a user who can connect from any domain: <UserList> <User name="${SERVER. The Allow.ADMIN_PASSWORD}</Password> <Allow></Allow> <Deny></Deny> <Order>Allow.

if necessary. • Delete a server from the list. A series of tabs is displayed along the top of the Manage Servers panel.5 CONFIGURATION AND ADMINISTRATION GUIDE 51 Using the Administration Console Managing the server Monitoring server performance You can review the performance of individual servers or a group of servers using the Administration Console.Last updated 3/2/2010 FLASH MEDIA SERVER 3. . • Review the access log and server log. • Ping the server to verify that it is running. The servers are arranged in a tree structure. The panel lists the servers and virtual hosts that you can access and manage. you can perform the following actions: • Review the performance statistics for the computer where the applications are running. Manage Servers panel Use the small buttons at the top and bottom of the panel to perform the following tasks: • Add a new server to the list. From here. • Connect to the selected server. add serial keys. • Review server licenses and. The Servers panel occupies the left side of the screen in this section of the Administration Console. • Review information about the applications located on the server or virtual hosts. • Edit server login information (user name and password) and select options such as remembering the password and automatically connecting when logging in to the server. • Review information about connections to the server.

3 Click Connections. (Automatic garbage collection intervals can be set in the Server. 2 Click Manage Servers. The following information is displayed: • Total number of current clients • Life span of the server • Graphical displays of active connections. Viewing server details The Administration Console Details panel displays live information for the server.xml and VHost.5 CONFIGURATION AND ADMINISTRATION GUIDE 52 Using the Administration Console • Restart the server or a virtual host. from memory. The following information is displayed for each client accessing the server or virtual host: • Server name • If connection has been made • Number of connections • Number of disconnections • Number of bytes in and out • Number of messages dropped Viewing application details The Administration Console Applications panel displays detailed information for all the applications running on the selected server or virtual host. 1 Follow the steps in “Connect to the Administration Console” on page 40. 3 Click Applications. . and CPU and memory resources consumed Viewing connection details The Administration Console Connections panel lists all client connections to the selected server.) • Stop a server or virtual host.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 1 Follow the steps in “Connect to the Administration Console” on page 40. 2 Click Manage Servers. 3 Click Details.xml configuration files. 4 Select a server from the list. • Run garbage collection to clear unused server resources. 2 Click Manage Servers. 4 Select a server from the list. 1 Follow the steps in “Connect to the Administration Console” on page 40. bandwidth resources consumed. such as streams and application instances.

2 Click Manage Servers. so note the capacity totals listed near the bottom of the Administration Console. The name of each application. . 3 Click License. 1 Follow the steps in “Connect to the Administration Console” on page 40. the following information is displayed: • The individual serial key number • Authorized peak number of client connections • Bandwidth cap • Whether the license is valid (true) or not (false) Note: Your organization may have more than one license.5 CONFIGURATION AND ADMINISTRATION GUIDE 53 Using the Administration Console 4 Select a server from the list. The lower frame displays information about custom licenses. added by editing configuration files directly) to either fms. 4 Select a server from the list. Note: Serial numbers that are added manually (that is.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Add a serial key Add serial keys in the Administration Console License panel. 1 Follow the steps in “Connect to the Administration Console” on page 40. 5 Click Add Serial Key. is displayed: • Server name • Application name • Number of instances of the application that have been loaded on and unloaded from the server • Number of users that are connected • Number of users that have connected and disconnected • Number of instances currently active • Number of instances that have been unloaded from the server • Total number of connections that have been accepted or rejected for each application Viewing license files The Administration Console License panel is where you add serial keys. For each license.xml file cannot be removed using the Administration Console. 4 Enter the serial key number in the text boxes at the bottom of the Administration Console. along with the following information. 3 Click License.ini or the <LicenseInfo> tag of the Server. 2 Click Manage Servers. Only serial numbers that are added using the Administration Console can be deleted using the Administration Console. 6 Restart the server. The panel also displays detailed information for all serial keys authorizing you to run Flash Media Server on the selected server.

5 CONFIGURATION AND ADMINISTRATION GUIDE 54 Using the Administration Console View the access log file The Administration Console Server Log panel displays messages that are written to the access log. Use the Find Previous and Clear Log buttons as necessary. 4 Select a server from the list. 1 Follow the steps in “Connect to the Administration Console” on page 40.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 2 Click Manage Servers. type it in the Find text box and click Find Next. . 3 Click Server Log. 5 To locate a specific string.

such as who is accessing the server. Flash Media Server handles log rotation for the Apache logs. Administrators can use standard parsing tools to parse the log files. Logs are in W3C format.xml files in virtual host root folders to control the behavior of each virtual host. The log files track server activity. Configuration files for logging Use the Server. application. For more information about Apache log files. edit the RootInstall/Apache2.log Tracks information about activities in application instances. The Logging section includes an Enable tag that determines whether the server logs events. Working with web server log files Flash Media Server installs with the Apache HTTP Server. see comments in the Server. Note: In Adobe Flash Player 9 Update 3. To change the location of the log files. If the Scope tag is set to server. .2/conf/httpd.2/logs.conf file. virtual host Logger. Flash Player no longer notifies the server about pause events. The server outputs statistics about client connections and stream activity to access logs.xml file in the RootInstall/conf folder determines the logging configuration for the whole server.xml files are ignored. The location of each log file is determined by the Directory and FileName tags in the Logger.xml files installed in the RootInstall/conf directory. how users are working with applications. access. see the Apache documentation at www.Last updated 3/2/2010 55 Chapter 4: Monitoring and Managing Log Files Adobe Flash Media Server has a variety of log files to help you manage and troubleshoot the server.xml files. If the Scope tag is set to server.xml and Logger.xml file contains a Logging section that controls logging behavior for the entire server. and general diagnostics. The Logging section also contains a Scope tag that determines whether the server writes separate log files for each virtual host or one file for the entire server.org.xml and Logger.log Tracks information about users accessing the server.xml configuration files to configure logging.XX.XX. The logs are in the default Apache error and combined access log formats. For more information. the Logger.apache. the root Logger. Working with log files About log files The server maintains several different types of logs.xml file doesn’t exist. If the Scope tag is set to vhost. diagnostic logs Track information about server operations. The default location of the Apache log files is RootInstall/Apache2. The Apache logs are named access_log and error_log. you can place Logger. The server also maintains diagnostic logs and application logs for application activities. The Server. If the Scope tag is set to vhost and a virtual host Logger.xml file controls the logging behavior.

FMS detected IPv6 protocol stack! FMS config <NetworkingIPv6 enable=true> FMS running in IPv6 protocol stack mode! Host: fmsqewin2k3-02 IPv4: 10. For more information about the Logger. Note: Log file rotation cannot be disabled. and that the Flash Media Server host has dual addresses and is listening on both interfaces. The following x-comment fields from a sample edge log file indicate that the IPv6 stack and the IPv4 stack are available.133. the server creates a new file on the next log event. you need to activate IPv6 on the network interface card.log. and maximum number of log files to keep can also be customized using the rotation element. For important log files. enable Flash Media Server to listen on IPv6 sockets. but there are methods for managing log file size. For example. even if the socket listeners accept connections over both IPv4 and IPv6. Choose a large value for the MaxSize tag.42 IPv6: fe80::204:23ff:fe14:da1c%4 Listener started ( _defaultRoot__? ) : 19350/v6 Listener started ( _defaultRoot__? ) : 19350/v4 Listener started ( _defaultRoot__? ) : 1935/v6 Listener started ( _defaultRoot__? ) : 1935/v4 Note: In Red Hat Linux. Name. and all available IP addresses for the host in the master. You can write an operating system script to delete or back up the log regularly. Set the Schedule type to "duration" and choose a long maximum duration. The first option is to set a daily rotation at a certain time.xml file installed in the /conf directory.xx. the edge logs display only the highest IP version the socket listeners are using. setting daily at 00:00 rotates files every 24 hours at midnight. set a rotation that occurs when the log exceeds a specified length. Flash Media Server (when it starts) logs available stack configuration. see “Configuring IPv6” on page 30. Use the rotation element in the Logger.xx.log. you can set values in the Logger. . and admin. moving or deleting the oldest files. only the two /v6 entries would be displayed. One option is to rotate log files.xx. maximum file size in kilobytes. edge. Alternatively. You can move the current active file. In the example above. move the log directory to a backup location.log files. see “Configuration files for logging” on page 55. see the Logger.xml file to specify a rotation schedule for log files.xml configuration files that effectively turn off rotation.xml configuration files. For more information about using IPv6.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Verifying IPv6 in log files IPv6 (Internet Protocol version 6) is a new version of the Internet Protocol that supports 128-bit addresses. After following those steps.192. To use IPv6. in Linux. For an example. Two types of rotation schedules can be established.5 CONFIGURATION AND ADMINISTRATION GUIDE 56 Monitoring and Managing Log Files Rotating and backing up log files Log files grow larger over time. host name. and enclose numeric IPv6 addresses in URLs within brackets. However.

A checkpoint event that provides updates of a corresponding publish event at intervals. it defines events that can be recorded. You can also configure the server to create a separate file per virtual host.log could be named access.2007052401. Use the x-sid field (stream id) and the c-client-id field to find the corresponding publish event. Client publishes a live stream. Logging events periodically for live and 24/7 applications Many companies use statistics from the access log to bill customers. set the value of the Scope tag in the Server. all logs for a particular virtual host are found in a subdirectory within the logs directory. which is located in the RootInstall/logs directory. see “Enable checkpoint logging events” on page 29. respectively. Client unpublishes a live stream.5 CONFIGURATION AND ADMINISTRATION GUIDE 57 Monitoring and Managing Log Files Access logs Reading access logs The access log records information about requests by Flash Player and Flash Media Server application instances.[YYYYMMDDNN]. DD. date.log.” (This is a separate scope tag just for logging. with YYYY. (For example. Access events defined in access logs Event connect-pending connect connect-continue Category session session session Description Client connects to the server. Substitution strings can be found in the [] brackets. If your programming includes live events or 24/7 programming. To solve this problem. The default configuration creates a single access log per server. When logging is configured on a per-virtual-host basis. access. you can enable checkpoint events. You can also use this information to determine which applications are used most. such as when a user connected to the server. disconnect publish unpublish publish-continue session stream stream stream play stream . You can use the status codes associated with specific events to troubleshoot event failures. MM. Logging can be customized to record all events or only specific events by editing the <Events> and <Fields> elements in the Logger.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Checkpoint events log bytes periodically from the start to the end of an event. The default access log is access. Client connects to the server. Using these logs. play-continue. and publish-continue. and for each category.xml file. and which streams were accessed by the connection (and similar resource information). month.xx. the events you need to calculate billing might not occur within a billing cycle. The following are available as checkpoint events: connectcontinue. how much total bandwidth was consumed during the session. and version. A checkpoint event that provides updates of a corresponding connect event at intervals.) Flash Media Server defines event categories. Use the c-client-id field to find the corresponding connect event. You can configure how often the server logs checkpoint events. waiting for the client to be authenticated. Client plays a stream. For information about configuring checkpoint events. You can use the substitution string to customize the filename of the access log.xml file to “vhost. you can find out about various events.log. The name of the subdirectory matches the virtual host name. Client disconnects.) To configure the server to create separate log files for each virtual host. and NN representing year.

Client seeks in a stream and NetStream. Client pauses stream. The seek position when the client seeks within the buffer when NetStream. Client resumes playing stream. An application instance has stopped. Client connects to server. This event occurs if an Authorization plug-in is present to handle the event. Client plays a stream. pause unpause client-pause stream stream stream client-unpause seek stream stream client-seek stream stop record recordstop start-transmit stream stream stream stream stop-transmit stream server-start server-stop vhost-start vhost-stop app-start app-stop auth-connect server server vhost vhost application application authorization auth-play authorization auth-publish authorization auth-seek authorization . Server has started. This type of pause is called a “smart pause”. The server received a “startTransmit” command. Client smart unpauses a stream. If a client seeks outside the buffer. Client pauses a stream but the server still sends data to the client so the player has enough data to play when the client unpauses. Client publishes a live stream.0 and Flash Media Server 3 and later.0.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Also fires when NetStream. The server received a “stopTransmit” command. This command asks the server to transmit more data because the buffer is running low. Client stops recording a stream. This event occurs if an Authorization plug-in is present to handle the event. Client begins recording a stream. A virtual host has stopped An application instance has started. Smart pause requires Flash Player 9. A virtual host has started. The stream position is logged in the “c-spos” field. Use the x-sid field (stream id) with the c-client-id field to find the corresponding play event.115.5 CONFIGURATION AND ADMINISTRATION GUIDE 58 Monitoring and Managing Log Files Event play-continue Category stream Description A checkpoint event that provides updates of a corresponding play event at intervals. the client sends a “seek” event. This event occurs if an Authorization plug-in is present to handle the event.inBufferSeek=true and the client seeks outside the buffer. This command asks the server to suspend transmission until the client sends a “startTransmit” event because there is enough data in the buffer. The stream position is logged in the “cspos” field. This event occurs if an Authorization plug-in is present to handle the event. Client stops playing or publishing a stream. The stream position is logged in the “c-spos” field.inBufferSeek=true (called a “smart seek”).inBufferSeek=false. Client jumps to a new location within a recorded stream. Server has stopped.

Duration of a stream or session event. Application instance name. This event occurs if an Authorization plug-in is present to handle the event. Memory usage (as reported by the getServerStats() method). Time the event occurred. Client IP address. Event category. this value is the number of seconds the stream has played. The publisher codec changes during a live event.5 CONFIGURATION AND ADMINISTRATION GUIDE 59 Monitoring and Managing Log Files Event filenametransform Category authorization Description A virtual stream path has been mapped to a physical location. Adaptor name. x-ctx. This event occurs if an Authorization plug-in is present to handle the event. Date of the event. x-vhost. cs-bytes. and xsname fields. CPU load. This event occurs if an Authorization plug-in is present to handle the event.Last updated 3/2/2010 FLASH MEDIA SERVER 3. but are present for better parsing of the data. x-status c-ip . x-adaptor. Time zone information. this value is the number of seconds the client has been connected. For a stream. Client begins recording a stream. auth-record authorization codecchange authorization Fields in access logs Note: When the data for this field contains a space or delimiter. The double quotation marks surrounding the data are not part of the data. For a complete description of the x-status codes and descriptions. Application names.” or “Pacific Standard Time” Field x-event x-category date time tz x-ctx s-ip x-pid x-cpu-load x-mem-load x-adaptor x-vhost x-app x-appinst x-duration Description Type of event. c-user-agent. IP address or addresses of the server. Logs data to the “x-codec-type” and “x-codec” fields. The following formats apply to the fields in the table below: For date: YYYY-MM-DD For time: hh:mm:ss For time zone: string such as “UTC. Virtual host name. sc-bytes. Event-dependent context information. This applies to the tz. see “Fields in diagnostic logs” on page 64. the data is wrapped in double quotation marks. Server process ID. c-referrer.” “Pacific Daylight Time. For a session. s-uri.

subtract sc-stream-bytes in the “play” event from sc-stream-bytes in the “stop” event. The query portion of s-uri. This information can be used to bill customers per session. This is a composite field: cs-uri-stem + x-sname + x-file-ext. subtract cs-stream-bytes in the “publish” event from csstream-bytes in the “unpublish” event. sc-stream-bytes This field shows the number of bytes transferred from the server to the client per stream. This is a composite field: cs-uri-stem + x-sname + x-file-ext + x-sname-query. subtract cs-bytes in the “connect” event from cs-bytes in the “disconnect” event. Stream length. such as MP3 files. The value of sc-stream-bytes can be greater than x-file-size after streaming files not encoded in FLV format. URI of the Flash Media Server application. or MP4). MP3. using the group connection between the servers for transmission x-sname x-sname-query x-suri-query x-suri-stem x-suri x-file-name x-file-ext x-file-size x-file-length x-spos cs-stream-bytes Stream name. This information can be used to bill customers per session. subtract sc-bytes in the “connect” event by sc-bytes in the “disconnect” event c-connect-type Type of connection received by the server: Normal: Connection from a client. Client ID. in milliseconds. . Stream size. User agent. To calculate the bandwidth usage per stream. Same as x-sname-query.5 CONFIGURATION AND ADMINISTRATION GUIDE 60 Monitoring and Managing Log Files Field c-proto s-uri cs-uri-stem cs-uri-query c-referrer c-user-agent c-client-id cs-bytes Description Connection protocol. in bytes. sc-bytes This field shows the number of bytes transferred from the server to the client.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Stream type (FLV. The stem portion of the s-uri field. This field shows the number of bytes transferred from the client to the server. This field shows the number of bytes transferred from the client to the server per stream. in seconds. To calculate the bandwidth usage per stream. To calculate the bandwidth usage per session. Note: The value of sc-stream-bytes is not necessarily the same as the value of the QoS ByteCount property. such as Flash Player Group: Connection between an edge and an origin server Virtual: Client connection that goes through an edge server. Stream position. x-service-name Name of the service providing the connection (only applicable to certain connection types). To calculate the bandwidth usage per session. URI of the referrer. Query portion of the stream URI specified in play or publish. Full path of the file representing the x-sname stream.

stop play. This ID is unique for the client session but not across sessions. the offset value indicates where to resume streaming. The file extension portion of the stream name for the stream that the server transitions from. play status_transition status_unavailable status_bad_request 200 210 302 400 A transition between streams has occurred. Name of the plug-in. invalid parameter or client connected to server using an unknown protocol. The transition mode sent by the client in the NetStream. The ID of a stream. Client disconnected due to admin command.5 CONFIGURATION AND ADMINISTRATION GUIDE 61 Monitoring and Managing Log Files Field x-sc-qos-bytes x-comment x-sid x-trans-sname x-trans-sname-query x-trans-file-ext x-plugin x-page-url x-smax-rec-size x-smax-rec-duration x-trans-mode x-offset c-spos x-eid Description Number of bytes sent to the client for quality of service. Connection rejected by Authorization plug-in or connection rejected due to invalid URI.log file. This field is empty in the access. The maximum duration of a recorded stream.log file. Client disconnected due to server shutdown (or application unloaded).log file. The URL of the web page in which the client SWF file is embedded. This field is empty in the access. Codec value of the “x-codec-type” retrieved in the Authorization plug-in’s E_CODEC_CHANGE event. x-codec-type x-codec Event status codes in access logs The Event status codes are based on HTTP response codes. This event is visible only in the auth. The client stream position when a “client-pause” or “client-seek” event is logged. When a stream is reconnected. Comments. Field connect pending disconnect disconnect Symbol status_continue status_admin_command status_shutdown Status Code 100 102 103 Description Waiting for the application to authenticate. This field is only available in authorization (auth-) events.Last updated 3/2/2010 FLASH MEDIA SERVER 3. play. connect. This field is empty in the access.play2() call. publish. unpublish. The name of the stream that the server transitions from (the original stream). Bad request.log file.log file. publish. Successful. The query stream portion of the stream name for the stream that the server transitions from. This event is visible only in the auth. The maximum file size of a recorded stream. publish status_unauthorized 401 connect status_forbidden 403 . Codec type of the frame retrieved in the Authorization plug-in’s E_CODEC event. record stop. This event is visible only in the auth. Application currently unavailable. An event ID received by Authorization plug-in. stop connect connect. play.log file. connect. status_OK record. Connection rejected by application script or access denied by application.

Unable to process message received when client connection was in pending or closed state. Expected response not provided when command issued.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Server internal error. Client does not have privilege to broadcast. Upstream connection closed because the last client disconnected. disconnect the client. SWF verification timeout. Resource limit exceeded or stream is already being published. License limit exceeded. closed due to inactive or idle status. Upstream connection closed. Flash Media Server autoclose feature automatically closed the connection. Error handling message. publish disconnect connect disconnect disconnect disconnect connect status_lic_limit_exceeded unsupported_type data_exceeded chunkstream_error cannot_broadcast cannot_screenshare remote_link_closed process_msg_failed 413 415 416 417 418 419 420 422 disconnect disconnect process_msg_exception process_remote_msg_failed 423 424 disconnect process_admin_msg_failed 425 disconnect process_rtmp_S2S_msg_failed 426 disconnect write_error 427 disconnect invalid_session 428 disconnect gc_client 429 disconnect disconnect remote_onstop remote_on_client_disconnect 430 431 disconnect gc_idle_client 432 disconnect disconnect disconnect swf_hash_fail swf_hash_timeout encoding_mismatch_error 433 434 435 disconnect. play connect server_internal_error bad_gateway 500 502 . Stream stopped because client disconnected. play play connect. Bad gateway. License to receive screen sharing video failed. SWF verification failure. Close downstream connection.5 CONFIGURATION AND ADMINISTRATION GUIDE 62 Monitoring and Managing Log Files Field connect. Client disconnected due to incompatibility with object encoding. Expected response not provided when issued an admin command. publish Symbol object_not_found client_disconnect status_conflict Status Code 404 408 409 Description Application or stream not found. Unable to obtain ping response or client states not connected. Client connection invalid. Client is not connected or client terminated. Expected response not provided when command was issued. Unsupported media type. Message queue too large. Unable to process unknown data type. Can also mean that a change has been made by the Authorization plug-in. unable to write data. connect play.

The default application log is application. The application folder is located in the matching virtual host directory. for instance. Bad application data.00.log. The most recent logs can be found in application. Time of the event. disconnect disconnect disconnect js_disconnect js_close_previous_client js_exception 600 601 602 disconnect disconnect play js_chunkstream_error js_debug_forbidden js_gc_object 603 604 605 Application logs Application log file The application log records information about activities in application instances. Fields in application logs Field date time Event(s) All All Description Date of the event. An unknown exception is thrown from the JS engine. located in the subdirectory within the Flash Media Server logs directory. to create one application log per application instance. Network connection was closed or reused. Flash Media Server is configured. Application does not allow debug connections.log.5 CONFIGURATION AND ADMINISTRATION GUIDE 63 Monitoring and Managing Log Files Field connect Symbol service_unavailable Status Code 503 Description Service unavailable.xx. . by default.Last updated 3/2/2010 FLASH MEDIA SERVER 3. This log is used primarily for debugging (logging uncommon events that occur in an application instance). Application disconnect. too many connections pending for authorization by access module. ~fcstreamjshook() clean up. The “xx” in the filename is a two-digit number representing the history of the application log.

All the diagnostic logs are located in the Flash Media Server logs directory.xx.log. Fields in diagnostic logs Field date time Event(s) All All Description Date on which the event occurred. All categories are listed in “Status categories in diagnostic logs” on page 65. The “xx” in the filename is a two-digit number representing the version of the log. All message IDs are listed in “Diagnostic Log Messages” on page 196.log. and message ID.5 CONFIGURATION AND ADMINISTRATION GUIDE 64 Monitoring and Managing Log Files Field x-pid x-status Event(s) All All Description Server process ID.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The default diagnostic logs are master. Status code: The code is a 10-character string that represents the severity.xx. as follows: (w) = warning (e) = error (i) = information (d) = debug (s) = trace from server-side script (_) = unknown The next three characters represent category. admin.log.xx. Flash Media Server is configured. edge. The last four characters represent message ID. Time at which event occurred. For a list of messages that appear in the diagnostic log files. . by default. x-ctx All Event-dependent context information. and httpcache. This log is used primarily for debugging (logging uncommon events that occur in Flash Media Server processes).log.xx. see “Diagnostic Log Messages” on page 196.log. to create a diagnostic log for each type of process. The first three characters represent severity. category. Diagnostic logs Diagnostic log file The diagnostic log records information about Flash Media Server operations (this is in addition to the information logged by the operating system). core.xx.

and message ID. category. All message IDs are listed in “Diagnostic Log Messages” on page 196.5 CONFIGURATION AND ADMINISTRATION GUIDE 65 Monitoring and Managing Log Files Field x-pid x-status Event(s) All All Description Server process ID. Status categories in diagnostic logs Category 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 Description TCService TCServer Presence Storage Stream SMTP Adaptor JavaScript TCApplication TCConnector Admin SharedObject Configuration VirtualHost SSL . Status code: The code is a 10-character string that represents the severity. x-stx All Event-dependent context information. as follows: (w) = warning (e) = error (i) = information (d) = debug (s) = trace from server-side script (_) = unknown The next three characters represent category.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The first three characters represent severity. All categories are listed in “Status categories in diagnostic logs” on page 65. The last four characters represent message ID.

/fmsmgr server start . or Restart. 2 Change to the directory where the server is installed. 3 Open a shell window and type one of the following: • • • . or Restart. . Start the server from the Start menu ❖ Do one of the following: • Choose Start > All Programs > Adobe > Flash Media Server 3. stop. • Select Flash Media Administration Server from the Services list and click Stop.5 > Start Flash Media Administration Server 3.5 Stop the server from the Start menu ❖ Do one of the following: • Choose Start > All Programs > Adobe > Flash Media Server 3. or restart Flash Media Server 1 Log in as a root user.5 > Stop Flash Media Server 3. stop. 2 Do one of the following: • Select Flash Media Server (FMS) from the Services list and click Stop. or restart the server from the Services window 1 Choose Start > Control Panel > Administrative Tools > Services. Start./fmsmgr server stop . Start. or restart the Administration Server 1 Log in as a root user. stop.5 • Choose Start > All Programs > Adobe > Flash Media Server 3./fmsmgr server restart Start. Start and stop the server Start and stop the server in Windows Use one of the following methods to shut down or restart the server.Last updated 3/2/2010 66 Chapter 5: Administering the server Perform regular administrative tasks to keep the server running smoothly. Start and stop the server in Linux Start.5 > Start Flash Media Server 3.5 > Stop Flash Media Administration Server 3.5 Start.5 • Choose Start > All Programs > Adobe > Flash Media Server 3.

3 Double-click an event generated by Flash Media Server to view details. Check server health FMSCheck is a command line utility program that can be used to diagnose and determine server status. When the tool connects to Flash Media Server. it does the following: • Checks the connection to any instance of an application • Checks all active instances of the server by connecting to those applications • Can publish and play a stream • Can play the available server-side stream for an application Note: Currently. The tool is available for both Windows and Linux using different executable files./fmsmgr adminserver stop . Start.) 1 From the Windows Start menu. bash.xml file must be configured to accept a connection from this tool (this configuration is required to use --allapps and its dependent commands). such as Cscript. 2 Enter ./fmsmgr adminserver restart Start. FMSCheck provides information about whether the server is running or not. FMSCheck only supports RTMP connections and does not check for shared objects. C shell.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 3 Open a shell window and type one of the following: • • • . use Event Viewer to open a remote connection to the server.5 CONFIGURATION AND ADMINISTRATION GUIDE 67 Administering the server 2 Change to the directory where the server is installed./fmsmgr adminserver start . FMSCheck is completely scriptable using the language of your choice. stop. or restart Flash Media Server using the command line 1 * cd /<the directory where FMS is installed>. and which fmscore processes are not responding. or Python. 2 Enter ./adminserver [start | stop | restart]. The Event Viewer displays a list of events that the server generates. To view the events from another Windows machine. A small video file for testing is included. what the response time is. or restart the Administration Server using the command line 1 * cd /<the directory where FMS is installed>. select Settings > Control Panel > Administrative Tools > Event Viewer. Checking server status View server events in the Windows Event Viewer The Windows Event Viewer can be used for tracking Flash Media Server activity and debugging server applications. ./server [start | stop | restart]. 2 Select the Application panel. As a command line tool. stop. The Users. (The following steps are accurate if you are working directly on the server.

This command can take time to finish. use the following: --parallel 10 --stagger <sec> Inserts a pause between tests. Example: --publish foo -1 --pubfile <file> Specifies a filename. The duration parameter is required. such as authentication. The administrator must configure Users. Administrator must specify the application. tests are run on each application serially (connect to the first application. If the program does not receive a response from the server within this interval. You can specify all to play the entire file. verify that the timeout value is adequate. fmscheck -v . Example: --play foo 10 5 --allapps --help --logfile <file> --play <name> [start [duration]] --publish <name> <duration> [record|append] Publishes files to the server. The default value of duration is 1 second. Allows the program to output a response to a file. If neither is specified. After the file is published. This command must be used along with --pubfile.xml to accept connections from this program. Displays Help for using FMSCheck. Options are start and duration. the default behavior is to record. This command is used along with --parallel. If the file already exists and record is used. In this case. Example: --pubfile input. The default value is 1935. The default value of start is any. running all of them in parallel may not be desirable. and -ahostport options in order to log in to the Administration Server. and the default value is 1 second. the administrator must use the --auser.Last updated 3/2/2010 FLASH MEDIA SERVER 3. which plays the file from the beginning. and so on). a result cannot be provided. or all is allowed. Both record and append are optional. to run 10 tests in parallel.5 CONFIGURATION AND ADMINISTRATION GUIDE 68 Administering the server FMSCheck commands and options Option --host <hostname> --port <number> --app <app> Description Required. an error is returned. Example: --port 1935 Allows the program to connect to an application. Indicate the maximum number of applications that can be run in parallel by specifying a value for max. then you are effectively running in serial mode. run test. the existing file is overwritten. You cannot give the play and publish commands at the same time. zero. if there is a large number of applications. connect to the second application. Example: --app app1/inst1 Queries the Administration Server for active instances and makes a connection to each active instance. If you specify a very long stagger time (longer than the duration of the test). in seconds. and the duration. Prints a version string. it is automatically played to verify the success of the publish operation. Running parallel without specifying max tests every application in parallel. --apswd. Example: --stagger 2 Allows you to input your own string for special purposes.flv --publish output 10 --parallel [<max>] Allows the program to play multiple applications at the same time. Example: --logfile output. This command must be used with --publish. If this option is not specified. Example: --host localhost Port number is optional. If there is more than one application. Values for start and duration must be in positive numbers or 0 and represent the number of seconds. the name of the output file to be created on server side. only a positive number. However. The value of <sec> is in seconds. tells the program where to connect the server. Specify the name of the input video file residing on the client side. Example: rtmp://host/app/inst?foo=abcd --query <" "> --timeout <sec> Specifies a timeout value.log Instructs the program to play video files. run test. For example. This command is used with --allapps.

The tool supports unicode filenames.exe.txt All of the Windows examples can be adapted to Linux by using * .exe --host localhost --app app1 --logfile output. Code 0 -1 -2 -3 -4 -5 -6 -7 Status Success. . FMSCheck return codes Return codes for the FMSCheck tool report the status after the tool has been run. invalid onMetaData messages. The tool can then merge the server metadata with the data present in the file./fmscheck instead of * fmscheck. the default port is 1111. The FLVCheck tool can be used to analyze FLV files before they are deployed on Flash Media Server. Checking video files Checking FLV files created or modified with third-party tools Third-party tools are available to create and modify FLV files. In addition.txt * fmscheck. but some of the tools create files that do not comply with the FLV standard. Example: --apswd admin Specifies the Administration Server port number.exe --host localhost --app app1 --pubfile foo. Publish failed. At least one application failed. Common problems include bad timestamps in the FLV file.5 CONFIGURATION AND ADMINISTRATION GUIDE 69 Administering the server Option --auser <username> --apswd <password> --ahostport <port> Description Specifies a user name for the Administration Server user.txt * fmscheck. bad message headers. the tool can also add or update metadata to reflect file duration correctly. Invalid command line argument. File not found. If the port number is not specified in the command line. and corrupted audio and video.txt * fmscheck. The tool verifies that metadata is readable. Connection failed. Example: --auser admin Specifies a password for the Administration Server. Example: --ahostport 1111 Usage examples for Windows: • • • • * fmscheck. and checks that the FLV file is seekable by Flash Media Server.flv --publish bar 10 --logfile output.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Play failed. The tool does fix metadata by scanning the Duration and Can Seek To End metadata fields. Operation timed out.exe --host localhost --app app1 --play foo 0 10 --logfile output. Note: The FLVCheck tool does not correct FLV file content corruption. specifies an accurate duration.exe --host localhost --allapps --auser admin --apswd admin --parallel 10 -stagger 2 --timeout 100 logfile output.

The --help option overrides this option. be returned.. nothing will be logged. creates a new copy of the original FLV file in the same directory as the original. to check two files: flvcheck -f abc.> For example. -w [ --warnings] -W [--warnings_as_errors] -s [ --fixvideostall ] -u [ --usage ] -m [ --fixmeta ] . in seconds. To get the exact duration. Provides a description of options and an example.. For MPEG-4–based container formats. Check a video file with the FLVCheck tool The FLVCheck tool is a command line program. that FLVCheck reports.) When validating metadata. Note: The FLVCheck tool does not correct corrupted H. 1 Open your operating system’s command prompt and change directories to RootInstall/tools.264-encoded video and HE-AAC-encoded audio within an MPEG-4–based container format. specify -d 0.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Relative paths may be used. use the FLVCheck tool to verify that the server can play back your files. (The default is 2 seconds. (FLV files only) If a metadata tag is corrupted. a backup file is not created. not the text output. 2 Use the following syntax to run the FLVCheck tool: flvcheck [-option] <file . Prints version information. Option -f [ --file ] file . Description Specifies the path to the video file(s) being checked. Display warnings. If the margin is exceeded. All MP4 files and Adobe F4V files are part of the supported subset. the executable is named flvcheck.flv .5 CONFIGURATION AND ADMINISTRATION GUIDE 70 Administering the server Checking other video files Flash Media Server supports playback and recording of H.. Treat warnings as errors. Displays an example and information about command-line parameters. Fix a stall in video playback (FLV only). Specifies the margin of error. A subset of the MPEG-4 standards are supported. (If the file contains no errors.) Only the Duration and Can Seek To End metadata fields are corrected.. the server logs a warning that the metadata duration is incorrect.) Sets the verbose flag. If the margin has not been exceeded. (Avoid using the “\\xd3 character.flv The following table describes the command line options available. Turns off header. try the “/” character instead. with corrected metadata. the absolute difference between metadata_duration and actual_duration is calculated and compared against the margin specified in this command. -v [--verbose] -V [ --version ] -n [ --nobanner ] -h [ --help ] -d [ --duration ] -q [ --quiet ] Specifies that only the status code./test/123..264-encoded files or make any other fixes to MP4/F4V files.

the status code returned is 0. Unrecognized message type. This error occurs if you run the tool with the -m option set. Flash Media Server cannot read the file. File read error.5 CONFIGURATION AND ADMINISTRATION GUIDE 71 Administering the server 3 If the FLVCheck tool finds no errors in the FLV file. Found backward timestamp. you can use the tool to try to correct the problem. flvcheck -f abc. . If there are one or more errors. -7 -8 -9 -10 -11 -12 -13 FLV FLV FLV FLV FLV FLV MP4 Invalid FLV signature. Try the following: a Use the -m option to try to fix the metadata in the file: flvcheck -m <file> [-quiet] [-help] b Use the -d option to change the duration field margin of error. a positive number indicating the total number of invalid files found is returned. Maximum allowed is 64. -15 MP4 Too many tracks. -6 General Cannot create corrected file. indicating that the encoding of part or all of the file is not compatible with the codecs that are supported. FLVCheck errors If an error is found. Cannot open file. ErrorMessage. If a return code of -1 is returned. types of errors. -14 MP4 File does not contain any valid tracks. and FileName. For example. and messages are as follows. 4 (FLV files only) If an error is returned from an FLV file due to a metadata error. ErrorNumber. Invalid FLV data offset. Other types of errors cannot be fixed using the FLVCheck tool. MP4/F4V files cannot be fixed using the FLVCheck tool.flv -d 5 would allow the metadata duration to be inaccurate +/. File not found. Time. Error numbers -2 -3 -4 -5 Error type General General General General Error messages Invalid file system path specified. The possible error numbers. Invalid FLV message footer. File does not contain a movie box. This error occurs if the MP4 file is empty.Last updated 3/2/2010 FLASH MEDIA SERVER 3. but the tool cannot create a file with corrected metadata. This error could occur if the MP4 file contains audio or video encoded with unsupported codecs.5 seconds. Unparsable data message. The duration field in the metadata may be inaccurate by a few seconds. the error is logged to the stdout file in the following format: Date. Errors and warnings are logged in a log file (stdout). an invalid command-line parameter was specified.

Found duplicate audio track. Error reading MP4 tables.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Flash Media Server cannot play back the track.. canSeekToEnd is false. Ignoring. Unsupported DRM scheme. -108 MP4 Invalid video codec. warnings are informative and are not fatal errors. Invalid number of data entries in box. Track has unsupported sample type. Truncated box. Ignoring.. This warning indicates that a track has an invalid video codec. Warning Message. Warning Number. Invalid movie time scale. Duplicate box. Invalid sample size. Flash Media Server will ignore the error that caused the warning and continue to load and play back the video or audio file.. Invalid chapter time. Box is too large. File contains out-of-order movie fragments. Ignoring. but you may experience problems with playback. Unrecognized box. Max is 64. Found incomplete track. File appears to be FLV with wrong extension. Warnings are logged to the stdout file in the following format: Date. Warning number -100 -101 -102 -103 -104 -105 -106 -107 Warning type General FLV MP4 MP4 MP4 MP4 MP4 MP4 Message Metadata duration is missing or is incorrect.. Flash Media Server ignores (will not play back) tracks that are encoded with unsupported codecs..5 CONFIGURATION AND ADMINISTRATION GUIDE 72 Administering the server Error numbers -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 Error type MP4 MP4 MP4 MP4 MP4 MP4 MP4 MP4 MP4 MP4 General MP4 MP4 MP4 MP4 Error messages Only one sample type allowed per track. FLVCheck warnings Generally. Found duplicate video track.. Too many tag boxes. . Time. Found duplicate data track. Invalid box version. and File Name. File contains unexpected movie fragments.

You can use the timestamp to determine when a cached file was used. Missing FLV metadata. Sample(s) skipped. The directory structure remains and any files currently locked by the edge server are not deleted. 3 Select Control Panel > Scheduled Tasks > Add Scheduled Task. Clearing the edge server cache Deleting files from the edge server cache Edge servers do not delete content automatically. The entry in the cache. Track contains unsupported sample flags.bat file has the following syntax: del /Q /S <cache_directory>\*. -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 FLV MP4 MP4 FLV FLV FLV FLV MP4 MP4 FLV MP4 MP4 MP4 Video may appear stalled due to lack of audio data. File is truncated. 1 Create a cache. Video flag set but no video messages found.bat file to empty the cache directory. This warning indicates that a track has an invalid audio codec.bat file and verify that it deletes files in the cache directory. Video messages found but video flag not set.bat as the new file to run. . this is expected behavior. Track contains unsupported edit list. Manage the edge server cache in Windows You can create a weekly scheduled task to clear the edge server cache. Invalid Track Extends Box. you must delete unused files to manage disk usage. 5 Replicate this procedure on each edge server. Edge servers update the timestamp of a file each time the file is used. Audio messages found but audio flag not set. Bad NellyMoser Frequency.5 CONFIGURATION AND ADMINISTRATION GUIDE 73 Administering the server Warning number -109 Warning type MP4 Message Invalid audio codec. Will only be partially playable. File has unsupported metadata format. 4 Select cache. Box has extraneous bytes at end. Flash Media Server cannot play back the track. Audio flag set but no audio messages found.* 2 Run the cache.Last updated 3/2/2010 FLASH MEDIA SERVER 3.

For tasks not listed in the following table.5 CONFIGURATION AND ADMINISTRATION GUIDE 74 Administering the server Manage the edge server cache in Linux 1 Create a shell script named cache. you still need to manually remove the installed files. The server name is fms by default. Lists all the services installed. Command fmsmgr adminserver start|stop|restart fmsmgr server <service_name> start|stop|restart fmsmgr clearautostart fmsmgr list Description Starts. or restarts Flash Media Administration Server. Note: You can add any additional file types to the script. You do not need to be a root user to use the Administration Console. Sets the Flash Media Administration service to start manually.sh 3 Run cache. stops.Last updated 3/2/2010 FLASH MEDIA SERVER 3. the old entry is updated with the new one. such as starting and stopping the server and services.flv" -exec rm-f{}\. Warning: Use this command only if you want to uninstall the server service. with additional information about services that are currently running. find <cache_directory> -name "*. find <cache_directory> -name "*. If <service_name> does not exist. You must be a root user to use the fmsmgr utility.sh to empty the cache directory. if you do not specify <service_name>. the command is performed on the name of the server you selected during installation.mp3" -exec rm-f{}\. Note: Running multiple Flash Media Server services concurrently is not supported. If <service_name> already appears in the fmsmgr tables. the command fails. Removes the Flash Media Server service from the fmsmgr tables. or restarts a Flash Media Server service. including Administration services. such as adding users or checking the status of applications. Starts.sh to verify that it deletes the correct files in the cache directory. stops. Syntax fmsmgr server <service_name> <cmd> For commands that use the <service_name> parameter. If you remove a server service.sh to run. The <install_dir> parameter is the absolute directory path where you installed Flash Media Server. 2 Verify that the script is executable by running the following command: $ chmod 700 cache.) Managing the server on Linux Use the fmsmgr utility to perform basic management tasks for Flash Media Server running on Linux systems. see the documentation for your Linux distribution. . (For details about the cron utility. The cache. fmsmgr remove fmsmgr add <service_name> <install_dir> Add a Flash Media Server service to the fmsmgr tables. the corresponding Administration service is also removed. 4 Use the cron utility to schedule cache.mp4" -exec rm-f{}\. use the Administration Console.sh script has the following syntax: find <cache_directory> -name "*. A root user must use the fmsmgr utility to start the Flash Media Administration Server before anyone can use the Administration Console.

Any installed Administration service can be used to administer one or more servers.5 CONFIGURATION AND ADMINISTRATION GUIDE 75 Administering the server Command fmsmgr setadmin <service_name> Description Changes the default Administration service. The Administration service name is the same as the Flash Media Server service name. . Sets the Flash Media Administration service to start manually. fmsmgr getadmin fmsmgr setautostart<service_name> fmsmgr clearautostart <service_name> fmsmgr suggestname Gets the name of the default Administration service. Sets the Flash Media Server service to start automatically when the system is started.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Suggests a service name that does not already appear in the fmsmgr tables. Only one Administration service can be running at a time.

changePswd</Allow> <Deny>All</Deny> <Order>Deny. The API is described in detail in Adobe Flash Media Server Administration API Reference. For example. 2 Make sure that the USERS. 4 In the <Allow> element. enter method names in a comma-delimited list to allow HTTP requests to execute Administration API calls. For more information. For example. When logging in to a virtual host not on the default adaptor.HTTPCOMMAND_ALLOW parameter is set to true.xml file that give you finer control over permissions. a default value may be used depending on the method. the following code allows the ping() and changePswd() methods: <AdminServer> <HTTPCommands> <Enable>${USERS. For example. The Flash Media Server Administration Console was built using the Administration API.Allow</Deny> </HTTPCommands> </AdminServer> Note: There are additional XML elements in the Users. 5 Save the file and restart Flash Media Administration Server.Last updated 3/2/2010 76 Chapter 6: Using the Administration API Working with the Administration API About the Administration API Use the Administration API to monitor. 3 Open the Users. • If you do not specify an optional parameter. it is assumed that you want to perform the command on the virtual host to which you connected when you logged in to Flash Media Server. 1 Open the fms. manage. if you have. see “XML configuration files reference” on page 80. administrators are logged in to the “_defaultRoot_” adaptor. • By default. use your valid port number in all examples. if you do not specify a virtual host in the scope parameter.ini file in the RootInstall/conf folder. Here are a few important tips for working with the Administration API: • Both Adobe Flash Media Server and Flash Media Administration Server must be running. and configure the server from an Adobe Flash Player or Adobe AIR client over RTMP or RTMPE or from a web client over HTTP. • This document assumes that you have not changed the default port number (1111) for the Administration Server. Set permissions for Administration API method calls over HTTP Note: You do not need to set permissions to call methods over RTMP. virtual-host administrators must specify the name of the adaptor.xml file in the RootInstall/conf folder.HTTPCOMMAND_ALLOW}/Enable> <Allow>ping. when logging in (over RTMP using NetConnection) to a virtual host on the adaptor _secondAdaptor_. . the administrator JLee would enter the following information for the administrator user name parameter in the method call: _secondAdaptor_/JLee.

"Hello World" 'String2' The only exceptions are the auser and apswd parameters.4] ['abcd'. • Arrays are passed as comma-separated values enclosed in square brackets."hi"] [10.ini file.32]. 3 The server sends the XML results back to the browser: <?xml version="1. Parameters passed in an HTTP request must adhere to the following formatting rules: • Name the parameters in the string. which should be passed without quotation marks.40] • Objects are passed as inline object literals. use the server address instead of localhost. the following code calls the addAdmin() method: http://localhost:1111/admin/addAdmin?auser=adminname&apswd=adminpassword&username="joe"&pa ssword="pass123"&vhost="_defaultRoot_/foo.5 CONFIGURATION AND ADMINISTRATION GUIDE 77 Using the Administration API Call an Administration API method over HTTP 1 Verify that Flash Media Administration Server is running. {foo:123.20.[31.com" • Strings are passed as literals surrounded by quotation marks.Last updated 3/2/2010 FLASH MEDIA SERVER 3. This example uses a web browser because it’s the simplest client and good for testing purposes. Substitute your administrator user name and password. Note: You can construct an Administration API call from any language that can send HTTP requests.34. 245 1. which are located in the fms. 2 Open a browser window and enter the following in the address bar: http://localhost:1111/admin/ping?auser=username&apswd=password If the web browser is on a different computer than Flash Media Server.2. For example.0" encoding="utf-8" ?> <result> <level>status</level> <code>NetConnection.myCompany.Call. [1.3. the application name must be included within quotation marks (" ") for methods such as reloadApp() and unload App() to work properly.Success</code> <timestamp>10/3/2007 05:31:01 PM</timestamp> </result> Constructing an HTTP request string Many Administration APIs expect one or more parameters in addition to auser and apswd.03 -45 Note: When a number is used for an application name.bar:456} . You can use either single quotation marks (') or double quotation marks ("). • Numbers are passed as either integer or floating-point literals.

"MHill". The following code creates a NetConnection for the administrator MHill with password 635xjh27 to the server on localhost: ncAdmin = new NetConnection(). and an administrator password. Note: If you want to connect to a virtual host. "vod"). The getAppStats() method returns performance data for an application running on the server..com/admin:1111. 2 Call the NetConnection. passing in three parameters: the URI of the Administration Server. Create your first application This section contains the code for a simple Flash application that calls the getAppStats() method.xml configuration file. code. you need a Flash Player or AIR client.connect() call to RTMPE.connect("rtmp://localhost:1111/admin". but change the protocol in the example NetConnection. 1 In the client application. new onGetAppStats().Success"){ outputBox. can connect to the server.Last updated 3/2/2010 FLASH MEDIA SERVER 3. create a NetConnection to Flash Media Administration Server. } else { outputBox.code != "NetConnection. an administrator user name. in this example. a response object (if needed) and any parameters (if needed): ncAdmin. To call Administration APIs over RTMP. appName. All information objects have level. printObj(info. outputBox).text+ " returned:" + newline. as defined in the Users. . .text = "Call failed: " + info. Only valid administrators.description. which typically provide information about errors. } } } The data is returned to the handler function in an information object. and vod is the name of the application instance from which to retrieve statistics.myVhost. ncAdmin. 3 Define a function to handle the information object returned by the Administration API method. rtmp://www.call("getAppStats".Call.5 CONFIGURATION AND ADMINISTRATION GUIDE 78 Using the Administration API {user:"Joe".text = "Info for "+appName. function onGetAppStats(){ this. "635xjh27"). specify the virtual host’s domain name or IP address as part of the URI— for example.. Note: To call the Administration API over RTMPE.call("getAppStats".ssn:"123-45-6789"} Call Administration API methods over RTMP or RTMPE To call the Administration API over RTMP or RTMPE.text). you need a Flash Player or AIR client. Some information objects have a data property (containing return data. new onGetAppStats(). and timestamp properties. The following sample is built in Flash. onGetAppStats(): ncAdmin. follow the instructions below. the response object onGetAppStats() captures the result of the call.call() method and pass it the Administration API method. often in an object or array) and description and details properties.onResult = function(info){ if (info.

text += prop + " = " + obj[prop] + newline. create an application with the following elements: • An input text field named appName • A button called button_btn • A multiline. if (typeof (obj[prop]) == "object") { // recursively call printObj printObj(obj[prop].0.Success"){ outputBox. printObj(info. destination){ for (var prop in obj) { destination. destination. . } 3 Before running this sample application. "getAppStats" **/ function doGetAppStats() { function onGetAppStats(){ this. outputBox). ncAdmin.5 CONFIGURATION AND ADMINISTRATION GUIDE 79 Using the Administration API Note: You can call Administration APIs from applications written in ActionScript 1.description. /** Makes the API call.Call. dynamic text field called outputBox • A scroll component attached to the outputBox text field Note: Since this is a Flash Media Server application.0.text = "Info for "+appName.text += "\t". 5 Run the sample Flash application and enter the name of the application you started in step 3 in the input text field. } // Calls the getAppStats() API on the name of application // in the input text field // places the response in the onGetAppStats funtion ncAdmin."admin_name". for example.text). 2 Enter the following code on frame 1 of a Flash file: /** Establishes the connection to Flash Media Server **/ ncAdmin = new NetConnection(). destination).connect("rtmp://localhost:1111/admin". } }.0. you must create an application directory with the application name in the RootInstall\applications directory.text = "Call failed: " + info. 1 In Flash.Last updated 3/2/2010 FLASH MEDIA SERVER 3. } else { outputBox. start another Flash Media Server application.onRelease = function(){ doGetAppStats(). ActionScript 2. } } } button_btn.onResult = function(info){ if (info. appName. // Replace admin_name and admin_pass with your // administrator name and password. 4 Open the Administration Console to verify that the application you started in step 3 is running.call("getAppStats".text+ " returned:" + newline. } function printObj(obj. or ActionScript 3. new onGetAppStats().code != "NetConnection."admin_pass").

adobe. the communications ports the adaptor binds to. 10. 10. To see the element structure and default values in the Adaptor. and/or full or partial IP addresses from which clients can connect to the server. the default adaptor included with the server at installation is named _defaultRoot_ and its directory is found in the conf/ directory. see the RootInstall/conf/_defaultRoot_/Adaptor.xml file is the configuration file for individual network adaptors.com. To change an adaptor’s settings.yourcompany.xml file. It determines the number of threads that can be used by the adaptor.60</Allow> See also Deny. Contains all the elements in the Adaptor.com. These elements are marked with an Important note.xml file. if you want to use different digital certificates for different adaptors.xml file. Example <Allow>foo. Each adaptor directory must contain an Adaptor.xml file The Adaptor. Allow A comma-delimited list of host names.xml file. Important: Some XML elements should not be configured without contacting Adobe Support. More Help topics “Editing configuration files” on page 9 Adaptor.xml file. For example. edit the elements in its Adaptor. Each adaptor has its own directory inside the server’s conf directory. You can also implement SSL with the Adaptor. The name of the directory is the name of the adaptor. Order . domain names.xml file.Last updated 3/2/2010 80 Chapter 7: XML configuration files reference Edit the configuration files in the RootInstall/conf directory to configure the server. Adaptor Root element. and the IP addresses or domains from which the adaptor can accept connections.1.60.133.

WriteBufferSize.1only keepalive Description Allow all HTTP tunnelling connections. Allow HTTP 1. NeedClose. Edges are defined in HostPort elements in the HostPortList container. Contains elements that specify an edge to configure for HTTP tunnelling. 10. MaxWriteDelay .0 keepalive connections. WriteBufferSize. Use the name specified in the HostPort element. Important: Only one application can use a port at a time. Disallow all HTTP tunnelling connections. Redirect. Order Edge Container element. These are the possible values for the Enable element: Value true false http1. This is the default value. Contained elements Enable.60.yourcompany. MimeType.com.Last updated 3/2/2010 FLASH MEDIA SERVER 3. MimeType. SetCookie. and/or full or partial IP addresses from which clients cannot connect to the server. domain names.com. IdleAckInterval. Allow only HTTP 1. Attribute name A name identifying an edge. IdlePostInterval. the web server cannot use port 80.60</Deny> See also Allow. 10. Example <Enable>true</Enable> See also IdlePostInterval.5 CONFIGURATION AND ADMINISTRATION GUIDE 81 XML configuration files reference Deny A comma-delimited list of host names.1. Example <Deny>foo. adobe. Redirect.1 tunnelling connections. Each edge can have different HTTPTunnel configurations. For example. IdleAckInterval.1 or HTTP 1. SetCookie. MimeType. if you configure Flash Media Server to use port 80 for HTTP tunnelling. MaxWriteDelay Enable Specifies whether or not to allow HTTP tunnelling connections.133.

where 443 is designated as a secure port that will only receive RTMPS connections. 80. 80. the first adaptor to bind to the specified HostPort wins. Example The following HostPort value instructs the adaptor to bind to the IP address 127. See also Redirect HostPort Specifies to which IP address and port(s) an adaptor binds. which are always on by default. (A port is marked as secure by specifying a minus sign in front of the port number.1 on ports 1935.HOSTPORT parameter in the RootInstall/conf/fms.port. ctl_channel The internal port that an FMSEdge (fmsedge in Linux) process listens on. each must have a different name.) RTMPS connection attempts to ports 1935 or 80 will not succeed. If there are multiple HostPort elements.-443. add a HostPort element for each IP address. where 443 is designated as a secure port that will only receive RTMPS connections.Last updated 3/2/2010 FLASH MEDIA SERVER 3. To resolve this conflict. and 443.port. keep in mind the following: • There is a risk in assigning more than one adaptor to listen on the same IP:port pair. RTMP. To bind to any IP address. if you configure Flash Media Server to use port 80 for HTTP tunnelling... The client will attempt to perform an SSL handshake that the server will fail to complete.80. If another process tries to bind to the same IP:port combination. it connects to an FMSEdge process on this internal port to establish a control channel.. Similarly. the web server cannot use port 80.0. When assigning port numbers.5 CONFIGURATION AND ADMINISTRATION GUIDE 82 XML configuration files reference EnableAltVhost Determines whether an alternative virtual host may be specified as a part of the RTMP URL as query parameter rtmp://host1/app/?_fcs_vhost=host2. The default value is :1935. • Only one application can use a port at a time. This element is exposed as the ADAPTOR.0. SSL Host Redirects unknown requests to an external server. . The format is IP:port. <EnableAltVhost>false</EnableAltVhost> See also HTTPTunnel. If you want to bind an adaptor to multiple IP addresses. and 443. For example.. a conflict results. When an FMSCore process is started (fmscore in Linux). This does not apply to administrative connections.ini file. The default value is false. don’t specify anything in front of the colon. Flash Media Server logs a warning in the Access log file indicating that the specified IP:port is in use. Each HostPort element corresponds to an FMSEdge process. This value instructs the adaptor to bind to any IP address on ports 1935. If there are multiple HostPort elements. each must have a different ctl_channel. a regular RTMP connection to port 443 fails because the server tries to perform an SSL handshake that the client fails to complete. Attributes name A name to identify this HostPort element.

The default value is false. Attributes enable A Boolean value specifying whether the server responds to an HTTP identification request (true) or not (false).5 CONFIGURATION AND ADMINISTRATION GUIDE 83 XML configuration files reference <HostPort>127. For a response to be returned.0.0.80.1 on port 1935: <HostPort>127. the <FCS></FCS> response is returned without content.0. When the enable attribute is set to true. Example <HTTPIdent enable="true"> <Company>Adobe System Inc</Company> <Team>Flash Media Server</Team> </HTTPIdent> The following is an example request: http://serverIP:1935/fcs/ident The following is an example response: .HOSTPORT}</HostPort> <HostPort name="edge2" ctl_channel=":19351">:1936. When the server receives an HTTP Identification request. If the HTTPIdent function is enabled but no content is specified.0.0.0.log file.Last updated 3/2/2010 FLASH MEDIA SERVER 3. it logs the request to the edge.-443</HostPort> If there is no colon in the HostPort value.0. The elements in this container list HostPort elements associated with this adaptor. The entire response is enclosed in <FCS></FCS> elements.xx. or there is a colon with no ports specified.1</HostPort> <HostPort>127.1:1935.1:</HostPort> See also HostPortList HostPortList Container element.0. the HTTPIdent function must be enabled and the client must do a POST or GET for the "/fcs/ident" resource. all elements in the HTTPIdent section are returned as a response. the data is assumed to be an IP address and binds to port 1935. The following values instruct the adaptor to bind to IP 127. Example <HostPortList> <HostPort name="edge1" ctl_channel=":19350">${ADAPTOR. which are added by the server.-444</HostPort> </HostPortList> Contained elements HostPort HTTPIdent Configures the server to respond to or reject an HTTP identification request from a client.

Example <HTTPNull enable="false"> . The IP address can be explicitly configured and does not need to be the IP of the Flash Media Server machine. HTTPTunnel. each connection may be sent to any one of many Flash Media Servers behind load balancers. This causes the session to be split across machines.5 CONFIGURATION AND ADMINISTRATION GUIDE 84 XML configuration files reference <fcs> <Company>Adobe System Inc</Company> <Team>Flash Media Server</Team> </fcs> See also HTTPNull.) If the tag is left empty. RTMPT (Tunnelled Real-Time Messaging Protocol) can have difficulties working with load balancers. HTTPUserInfo HTTPIdent2 Configures the server to respond to or reject a special HTTP request from the client before the client attempts to make a RTMPT connection to Flash Media Server. Example <HTTPIdent2 enabled="true">10. requests for the "/" resource are passed to the webserver. For a response to be returned. Attributes enabled A Boolean value specifying whether the server responds to a special HTTP identification request before making a RTMPT connection (true) or not (false). The default value is false. the HTTPIdent2 function must be enabled. If a single RTMPT session consists of multiple socket connections. By default. This function is available when using Flash Player Update 3 or later. If HTTPNull is disabled and the webserver is enabled. the HTTPNull function is disabled.128. Using <HTTPIdent2> enables Flash Player to send a special HTTP request before connecting to Flash Media Server. (This allows RTMPT connections to be redirected to a different server.71</HTTPIdent2> See also HTTPNull. HTTPTunnel. When the enable attribute is set to true. the IP address is determined automatically. an HTTP 404 response is sent in response to an HTTP GET request. This feature is enabled by default. If you are running Flash Media Server on Linux and have enabled IPv6 but are using an IPv4 hostname (a hostname that resolves to IPv4). then use this tag to resolve RTMPTE and RTMPE connections more quickly: either set the enabled attribute to false or set it to true and set the value of the tag to the IP address to which you’re connecting. even if the <HTTPIdent2> tag or the enabled attribute is missing.Last updated 3/2/2010 FLASH MEDIA SERVER 3. HTTPUserInfo HTTPNull Configures the server to respond to or reject an HTTP GET request for the “/” resource from a client. Attributes enable A Boolean value.133.

5 CONFIGURATION AND ADMINISTRATION GUIDE 85 XML configuration files reference HttpProxy Specifies whether the server proxies unknown requests to an external server. if you configure Flash Media Server to use port 80 for HTTP tunnelling. the value of the Host element is a variable from the fms. The elements in this section configure the incoming HTTP tunnelling connections to the adaptor. Each edge can have different HTTPTunnel configurations. UpdateInterval . The following is from the default Adaptor. the web server cannot use port 80. Example In the default Adaptor. HTTPTunnel/Enable must be set to true. the server uses a localhost port. automatically handling the case when producers and consumers differ widely in bandwidth. or replace the variable in the Adaptor. Flow control kicks in when the buffer in either direction fills up.HOST in the fms. Note: Only one application can use a port at a time.HOST}</Host> </HttpProxy> The IP address and port to which the server proxies unknown HTTP requests. For proxying to work.HOST = webfarm. MaxSize.xml file. You can set the value of HTTPPROXY.ini file. For example.ini file. The default value is 16384. Contained elements Path.HOST = :8134 HTTPTunnel Container element.xml file: <HttpProxy enable="true" maxbuf="16384"> <Host port="80">${HTTPPROXY. The default value is true.example. The elements in this section configure the absolute path to XML files and the cache settings.xml file.HTTPPROXY. Contained elements Enable HTTPUserInfo Container element. as in the following: HTTPPROXY. Request proxying to a specific host can be further controlled based upon port on which the request arrived. Attributes enable A Boolean value. maxbuf The size of the io buffers.Last updated 3/2/2010 FLASH MEDIA SERVER 3.com:80 If you do not specify an IP address or domain name.

which provides medium latency. Lower values reduce latency but increase the network bandwidth overhead. Applications desiring low latency may configure the combination of values 128/256 for IdlePostInterval and IdleAckInterval elements. and that the receiving server is ready to accept transmissions. For applications not sensitive to high latencies. <IdleAckInterval>512</IdleAckInterval> See also IdlePostInterval. for a tunnel session before it is closed. in seconds. Low values reduce the latency but increase the network bandwidth overhead. The default value is 512 milliseconds. The default setting for IdleTimeout is 8 seconds. Example <IdleTimeout>8</IdleTimeout> See also IdlePostInterval. These elements should be configured at the same time. An IdleTimeout of -1 indicates that idle tunnel sessions will not be disconnected. in seconds. IdleTimeout IdleTimeout Specifies the maximum inactivity time.5 CONFIGURATION AND ADMINISTRATION GUIDE 86 XML configuration files reference IdleAckInterval Specifies the maximum time in milliseconds the server waits before it sends an acknowledgement code for a client idle post. Applications that do not have high latencies can use the configuration 1024/2048. Values that are too high may result in disconnected sessions consuming server resources for longer than necessary. Example <IdlePostInterval>512</IdlePostInterval> See also IdleAckInterval. that such a session may remain idle before it will be automatically disconnected. Applications desiring low latency may configure the combination of values 128/256 for the IdlePostInterval and IdleAckInterval elements. use the combination 1024/2048. their session may remain open for a long period of time after disconnecting. IdleAckInterval . An acknowledgement code is a transmission control character used to indicate that a transmitted message was received uncorrupted and without errors. IdleTimeout IdlePostInterval Specifies the interval in milliseconds at which the client sends idle posts to the server to indicate that Flash Player has no data to send. When a client using HTTP tunnelling disconnects unexpectedly.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The values for this element and the IdlePostInterval element affect the latency observed by a client tunnelling into the server. The value of IdleTimeout indicates the maximum time. The default settings for the IdleAckInterval and IdlePostInterval elements provide medium latency and are set to 512/512 milliseconds. Values that are too low may cause clients with very high latencies to become disconnected.

the server reduces the cache. the notification may not reach the server. when connections close under abnormal conditions. UpdateInterval MaxWriteDelay The HTTP tunnelling protocol ensures that a server will be able to write every four seconds. Occasionally. By default.5 CONFIGURATION AND ADMINISTRATION GUIDE 87 XML configuration files reference MaxFailures Specifies the maximum number of failures an edge server may incur before it restarts. the value is 100. The default number of failures is 2. When the cache size reaches the maximum size. See also HTTPTunnel . Anomalous connections are closed after the specified wait time. Example <MaxFailures>2</MaxFailures> See also IdleAckInterval MaxSize Specifies the maximum number of HTTP requests the server keeps in the cache.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Example <MaxSize>100</MaxSize> See also Path. The default wait time is 40 seconds. Example <Edge name="Edge1"> <Enable>true</Enable> <IdlePostInterval>512</IdlePostInterval> <IdleAckInterval>512</IdleAckInterval> <MimeType>application/x-fms</MimeType> <WriteBufferSize>16</WriteBufferSize> <SetCookie>false</SetCookie> <Redirect enable="false" maxbuf="16384"> <Host port="80">:8080</Host> </Redirect> <NeedClose>true</NeedClose> <MaxWriteDelay>40</MaxWriteDelay> </Edge> You may want to use this sample code as a template for configuring each edge server. which may continue to place writes in a queue.

and the special characters $-_.Deny</Order> .+!*'() See also HTTPTunnel Order Specifies the sequence in which the server evaluates the Allow and Deny elements. The following is the default sequence: <Order>Allow. If the NodeID element is used. which closes the connections. a following string of up to nine characters is prefixed to the tunnel session IDs and can be used by the load balancers to uniquely identify each node in the cluster.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The default value is true. The alternative sequence Deny. and 0-9.0 non-keepalive connections are closed once the response is written. The ID must contain URL-safe characters: alphanumerical A-Z.Deny</Order> The default sequence indicates that access to a server is denied unless it is specified in the Allow element. Example <NeedClose>true</NeedClose> See also MaxWriteDelay NodeID Specifies a unique node identification that supports the implementation of load balancers.Allow indicates that access to a server is allowed unless specified in the Deny element and not specified in the Allow element. Example The following is the default sequence: <Order>Allow. a-z.5 CONFIGURATION AND ADMINISTRATION GUIDE 88 XML configuration files reference MimeType Specifies the default MIME (Multi-purpose Internet Mail Extensions) type header sent on tunnel responses. The server uses the entry for the MIMEType element only if it is unable to determine the MIME type from the incoming requests. Example <MimeType>application/x-fcs</Mimetype> See also HTTPTunnel NeedClose A Boolean value specifying whether or not HTTP 1. The server generally uses the MIME type specified by the incoming requests.

it is set to uInfo/ in the FMS install directory. NeedClose ResourceLimits Container element. Flow control begins when the buffer in either direction fills up.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The wait time is specified in seconds. Example This example instructs the server to redirect unknown requests to the specified redirect host. Note: For redirection to work.5 CONFIGURATION AND ADMINISTRATION GUIDE 89 XML configuration files reference See also Allow. An unknown request may connect only when it is the first request on a newly accepted connection. the request is considered an error and the connection is closed. At any other time. The maxbuf attribute determines how big the IO buffers are. <Redirect enable="false" maxbuf="16384"> <Host port="80">:8080</Host> <Host port="443">:8443</Host> </Redirect> See also MaxWriteDelay. By default. Flow control automatically handles the request when the bandwidth resources for producers and consumers differ widely. The number of failures is specified by the MaxFailures element. HTTP tunnelling must be enabled. . Example <RecoveryTime>30</RecoveryTime> See also MaxSize Redirect Specifies whether or not the adaptor redirects unknown requests to an external server. UpdateInterval RecoveryTime Specifies the number of seconds an edge server waits before restarting after a failure. See also MaxSize. When an edge server fails. it waits for the interval specified here before it restarts. Deny Path Specifies the absolute path of the folder where the server looks for XML files.

then for HTTP tunnelling to work. Example <SetCookie>false</SetCookie> See also NodeID SSL Container element. Keep in mind that the cookie adds to the HTTP header size and increases the bandwidth overhead. The load balancer checks the cookie and sends requests with this cookie to the same server. This element is enabled by default. If the server does not have an externally visible IP address. in Windows only. RecoveryTime RTMP Container element. The elements in this section configure the incoming connections via the Secure Sockets Layer protocol.Last updated 3/2/2010 FLASH MEDIA SERVER 3. cookies are currently supported only on Flash Player 9.5 CONFIGURATION AND ADMINISTRATION GUIDE 90 XML configuration files reference The elements in this container configure the resource limits for the edge server. The SSL elements in Adaptor. setting enabled to false will not allow RTMPE or RTMPTE on this adaptor. Contained elements MaxFailures. The elements in this container determine whether encrypted RTMP (RTMPE) and encrypted tunnelling RTMP (RTMPTE) can be used. you should enable cookies when you deploy servers behind a load balancer. . Note: For tunnelling connections.xml configure the server to act as an SSL-enabled server to accept incoming SSL connections.28 or later.0. RTMPE is the encrypted RTMP protocol covering both RTMPE and RTMPTE. Contained elements RTMPE RTMPE Specifies whether encrypted RTMP (RTMPE) can be used. Example <RTMPE enabled="true"></RTMPE> See also RTMP SetCookie Specifies whether or not the server sets a cookie. known as SSL.

• Specify where to find the associated private key file in the SSLCertificateKeyFile element. • Specify the location of the certificate in the SSLCertificateFile element. The default is PEM.xml file. The following is a quick start to allowing SSL-enabled connections to the server: • to the SSL section of the Adaptor. SSLCipherSuite. a password must be specified for decrypting and placed in the SSLPassPhrase element described below. If an absolute path to the key file is not specified. you then use the SSL elements to configure the server for SSL. Example <SSLCertificateFile>c:\myCertFile</SSLCertificateFile> See also SSLCertificateKeyFile. • Save the modified Adaptor. such as Verisign.xml file. Contained elements SSLServerCtx SSLCertificateFile Specifies the location of the certificate to return to clients who want to make a secure connection to the server. A component can be a key exchange algorithm. . SSLPassPhrase. This element contains a list of colon-delimited components. encryption method. The encryption format is either PEM (Privacy Enhanced Mail) or ASN1 (Abstract Syntax Notation 1). See also SSLCertificateFile. SSLPassPhrase.5 CONFIGURATION AND ADMINISTRATION GUIDE 91 XML configuration files reference You need to acquire a digital certificate to use SSL. or one of a selected number of aliases for common groupings. or by creating it yourself with a product such as OpenSSL.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Example <SSLCertificateKeyFile type="PEM"></SSLCertificateKeyFile> The type attribute specifies the type of encoding used for the certificate key file. • If the private key file is encrypted. it is assumed to be relative to the adaptor directory. SSLSessionTimeout SSLCertificateKeyFile This specifies the location of the private key file that corresponds to the public key in the certificate specified in SSLCertificateFile element. Once you get your SSL certificate through a certificate authority. the certificate location is assumed to be relative to the adaptor directory. If an absolute path is not specified. If this file is encrypted. SSLCipherSuite. specify the passphrase to use for decrypting the private key file in the SSLPassPhrase element. SSLSessionTimeout SSLCipherSuite Specifies the suite of encryption ciphers that the server uses to secure incoming connections. digest type. authentication method.

which the client can place in the cache and reuse at a later time. it can send back the cached session object. If the client connects to the same server again at a later time. SSLCertificateKeyFile. SSLCertificateKeyFile. The elements in this section control the incoming SSL configuration for this adaptor. If the key file is not encrypted. Example <SSLCipherSuite>ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH</SSLCipherSuite> See also SSLCertificateFile. It is a base64 encoding that makes the password less readable. Contained elements SSLCertificateFile.5 CONFIGURATION AND ADMINISTRATION GUIDE 92 XML configuration files reference Note: Contact Adobe Support before changing the default settings as listed in this example. it is not a true encryption. it must perform the full handshake. SSLCipherSuite. When a client connects to a server for the first time. . SSLSessionTimeout SSLServerCtx Container element. SSLPassPhrase.Last updated 3/2/2010 FLASH MEDIA SERVER 3. SSLPassPhrase. To prevent plain text passwords from appearing in the configuration file. The default time period is 5 minutes. encode the password in base64 format and set the encrypt attribute to true. SSLCipherSuite. this element is left blank. SSL sessions are used to improve performance by avoiding the need to perform the full SSL handshake for every connection. See also SSLCertificateFile. Example <SSLPassPhrase encrypt="true">dGluY2Fu</SSLPassPhrase> The encrypted password is equivalent to the plain text format: <SSLPassPhrase>tincan</SSLPassPhrase> or <SSLPassPhrase encrypt="false" >tincan</SSLPassPhrase> Even though the element attribute is named "encrypt". After that first handshake. SSLSessionTimeout SSLPassPhrase Specifies the passphrase to use for encrypting the private key file. SSLSessionTimeout SSLSessionTimeout Specifies in minutes how long a SSL-based session remains valid. the server sends back a session object to the client. SSLCertificateKeyFile. The server does not require the full SSL handshake if the session is still valid. Specifies the password to use for decrypting the key file if the key file is encrypted.

xml file is located in the application directory and specifies a different value than the default for an element that cannot be overridden. The Application. the value is 5000 milliseconds.xml file to the application’s registered application directory (/applications/app_name) and edit it to include the settings you want. The default size is 16 KB. it is ignored. • If an element has the override attribute set to no.xml file in the virtual host directory configures the default settings for all applications within the virtual host. the settings in the Application. MaxSize WriteBufferSize Specifies the size of the write buffer in kilobytes. SSLCipherSuite UpdateInterval Specifies how often the server refreshes the cache content. Example <WriteBufferSize>16</WriteBufferSize> See also ResourceLimits Application. then all subelements also cannot be overridden.5 CONFIGURATION AND ADMINISTRATION GUIDE 93 XML configuration files reference Example <SSLSessionTimeout>5</SSLTimeout> See also SSLCertificateFile. and bandwidth limitations.xml file in the application directory override settings in the Application. in milliseconds. These settings include the size of the Server-Side Media ActionScript runtime engine. .xml file.xml files cannot override that element’s setting. • If an Application. By default. copy an Application. as in the following: <LoadOnStartup override="no">false</LoadOnStartup> The server uses the following rules when applying the override attribute: • When the override attribute is included in an element and set to no. application-specific Application. SSLCertificateKeyFile. Example <UpdateInterval>5000</UpdateInterval> See also Path. In most cases. and the default is used. If you want to have different settings for a particular application. the location at which streams and shared objects are stored. but not always.xml file in the virtual host directory.xml file The Application. You can add an override attribute to certain elements in a virtual host’s Application.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml file contains the settings for Flash Media Server applications. SSLPassPhrase.

which allows the values for the ClientToServer and ServerToClient elements nested in these sections to be overridden. see the Application.xml file installed with Flash Media Server in the RootInstall/conf/_defaultRoot_/_defaultVhost_ directory. • If the user-specified Application. • If you omit the override attribute.Last updated 3/2/2010 FLASH MEDIA SERVER 3. the server will deliver aggregate messages to clients that support them.xml file is missing or invalid. To see the element structure and default values. Contains elements that configure logging in the Access log. the server will not start.xml configuration file is invalid. The elements in this section specify the maximum size and duration of intermediate frames a live stream can hold in the buffer. The Client element in this XML file includes an override="no" attribute by default. the LoadOnStartup element can be overridden. Note: By default. MaxSize (AccumulatedIFrames) AggregateMessages (Client) Specifies whether or not to send aggregate messages to clients. It intercepts and examines each connection request to Flash Media Server to determine whether the connection should be accepted or rejected. When this setting is disabled.dll file. set the override tag to no in the uppermost tag. • All subelements under the LoadOnStartup element cannot be overridden. Access Container element. Contained elements Checkpoints AccumulatedIFrames Container element. contains an element that control the size of the aggregate messages. When the enabled attribute is set to true. aggregate messages are broken up into individual messages before being delivered to clients. The default is false.5 CONFIGURATION AND ADMINISTRATION GUIDE 94 XML configuration files reference • If the default Application. the Bandwidth and BandwidthCap container elements include an override parameter set to yes. . Contained elements FolderAccess Access (Logging) Container element. AggregateMessages (Queue) Container element. • To change an element so it cannot be overridden. it is ignored. Contained elements MaxTime. The Access plug-in consists of the libconnect.

UnrestrictedAuth AllowDebugDefault Specifies the default value for application. MaxMessageSizeLosslessVideo. when queuing is enabled. which prevents TCP/IP connections over nonstandard ports. Example <AllowDebugDefault>false</AllowDebug Default> See also MaxPendingDebugConnections AllowHTTPTunnel This element configures the server to allow HTTP tunnelling connections into this application.allowDebug. The default is true. If that fails. This is an opening that allows debug connections on a per application basis. The values for this element are described in the following table.5 CONFIGURATION AND ADMINISTRATION GUIDE 95 XML configuration files reference This element also specifies. When the enabled attribute is set to true (the default value). allowing HTTP redirects. In some cases. Flash Player communicates with the server using the RTMP protocol over port 1935.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The server attempts to send aggregate messages to supported clients whenever possible. By default. Flash Player has to negotiate a connection to Flash Media Server through an edge server. The default value is false. it will try again over ports 443 and 80 in an attempt to get around firewall settings. aggregate messages are always broken up into individual messages before being delivered to clients. Example <AggregateMessages enabled="false"><\AggregateMessages> See also MaxAggMsgSize. the server creates aggregate messages. When this setting is disabled. OutChunkSize Allow Specifies whether or not to allow the "following and Location:" header that is sent with redirection of an HTTP header. or use the HTTP protocol to transmit RTMP packets (called HTTP tunnelling) if there is a firewall that allows only HTTP content to be sent out to public servers. whether messages in the queue can be combined to form aggregate messages. . HTTPTunnel. Example <Allow>true</Allow> See also Max.

xml configuration file apply to all clients connected to the Vhost. Password AutoCloseIdleClients Container element. The values defined in the Vhost. The elements in this section specify the settings for audio streams on the server.xml values. A client is active when it is sending or receiving data.1 connections only. SWFVerification Audio Container element. HTTP. The Vhost. (Subsequently. StreamManager. Once you enable the feature in the Server. The server closes the client connection to the server and writes a message to the access log.xml values. See also Process. SendSilence. the server sends a status message to the NetConnectionobject (the client).xml. Contained elements CombineSamples.xml file. Example <AllowHTTPTunnel>true></AllowHTTPTunnel> See also Allow Application This is the root element for Application. Set the enable attribute to true to close idle clients.xml configuration file apply to all clients connected to the server. JSEngine. The server also writes a message such as “Client x has been idle for y seconds” in the core and event logs. If the enable attribute is omitted or set to false.xml values override the Server. Contains elements that determine whether or not to close idle clients automatically.1only keepalive Description Allows tunnelling connections.xml files or for individual applications in Application.5 CONFIGURATION AND ADMINISTRATION GUIDE 96 XML configuration files reference Value true false http1. .xml file.xml file. Debug. the values defined in the Server. Allows HTTP 1. When a client has been idle longer than the maximum idle time (60 seconds by default).0 and 1. you must enable the feature in the Server. Allows HTTP 1. MaxAppIdleTime. To configure the closing of idle connections. The Application. unless the values are defined in the Vhost.1 keepalive connections. you can disable the feature for individual virtual hosts in the Vhost.Last updated 3/2/2010 FLASH MEDIA SERVER 3. unless values are defined in the Application. SharedObjManager. Use the AutoCloseIdleClients element to specify how often the server should check for idle clients. LoadOnStartup. AllowHTTPTunnel. Disallows tunnelling connections. the feature is disabled.xml file.xml values override the Vhost.xml. The default value is false. Client.

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 97
XML configuration files reference

Example
<AutoCloseIdleClients enable="false"> <CheckInterval>60</CheckInterval> <MaxIdleTime>600</MaxIdleTime> </AutoCloseIdleClients>

AudioSampleAccess
Allows the client application to access the raw uncompressed audio data in a stream. By default, this element is disabled. To enable it, set the enable attribute to true. In the tag, specify a list of semicolon-delimited folders to which client applications have access. When this element is enabled, all clients can access the audio data in streams in the specified folders. To enable access to all audio data streamed by the server, specify / in the tag. The folder path is restricted to the application’s streams folder or folders, so do not use absolute paths in the list of folders. While you can also enable access through Server-Side ActionScript, this element allows access to the data without requiring Server-Side ActionScript. You can also override this element with the Access plug-in or Server-Side ActionScript. Example If an application is configured to store streams in folders C:\low_quality and C:\high_quality, the configuration to allow access to sample those streams is as follows:
<AudioSampleAccess enabled="true">low_quality;high_quality</AudioSampleAccess>

See also
VideoSampleAccess

AutoCommit
Specifies whether shared objects are automatically committed when they have been changed. Setting this element to false disables Flash Player function for all shared objects within this instance. Note: If the AutoCommit function is disabled, the server-side script has to call the save function or the SharedObject.commit command for the shared object to persist; otherwise, all data will be lost when the application is shut down. Example
<AutoCommit>true</AutoCommit>

See also
StorageDir, DuplicateDir, ResyncDepth, LockTimeout, MaxProperties, MaxPropertySize

Bandwidth
Container element. The elements nested in this container specify the bandwidth settings for upstream (client-to-server) and downstream (server-to-client) data. By default, the Bandwidth element includes an override parameter set to yes, which allows the values for the ClientToServer and ServerToClient elements to be overridden as well.

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 98
XML configuration files reference

Contained elements
ClientToServer (Bandwidth), ServerToClient (Bandwidth)

BandwidthCap
Container element. The elements in this section specify the bandwidth settings that a user can set. By default, this element includes an override parameter set to yes, which allows the values for the ClientToServer and ServerToClient elements nested in this section to be overridden, too. Contained elements
ClientToServer (BandwidthCap), ServerToClient (BandwidthCap)

BandwidthDetection
Container element. This element contains settings for how the server detects bandwidth. Set the enable attribute to true or false to turn this feature on or off. The server can detect client bandwidth in the core server code (native) or in a server-side script (script-based). Native bandwidth detection is enabled by default and is faster than script-based because the core server code is written in C and C++. The server detects bandwidth by sending a series of data chunks to the client, each larger than the last. You can configure the size of the data chunks, the rate at which they are sent, and the amount of time the server sends data to the client. The following table lists the values available for the BandwidthDetection element.
Element
BandwidthDetection

Description Set the enabled attribute to true or false to turn this feature on or off. The maximum rate in Kbps at which the server sends data to the client. The default value is -1, which sends the data at whatever rate is necessary to measure bandwidth. The amount of data in bytes that the server sends to the client. To detect the client’s bandwidth, the server attempts to send a series of random blocks of data to the client, each time sending this much more data. For example, x bytes are sent, followed by 2x bytes, followed by 3x bytes, and so on until MaxWait time has elapsed. The number of seconds the server sends data to the client. Increasing this number provides a more accurate bandwidth figure but also forces the client to wait longer.

MaxRate

DataSize

MaxWait

Example
<BandwidthDetection enabled="true"> <MaxRate>-1</MaxRate> <DataSize>16384</DataSize> <MaxWait>2</MaxWait> </BandwidthDetection>

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 99
XML configuration files reference

Contained elements MaxRate, DataSize, MinBufferTime (Live)

Bits
This element contains the settings for Flash Player on the Windows and Macintosh platforms. Example
<Bits from="WIN 6,0,0,0" to="WIN 7,0,55,0">0x01</Bits> <Bits from="MAC 6,0,0,0" to="MAC 7,0,55,0">0x01</Bits>

See also
UserAgent

BufferRatio
Specifies the ratio of the buffer length used by server-side stream to live buffer. Example
<BufferRatio>0.5</BufferRatio>

See also
Server

Cache
Container element; contains elements that configure the cache setting for SWF verification. See also TTL, UpdateInterval

CachePrefix
Specifies the cache prefix that is passed from the origin server to the edge server. This element is set on the origin server. The edge server uses the value of this element as a relative path to locate the cache file defined in the CacheDir element. The type attribute provides additional specification for the cache prefix. The type attribute can be set to path or sname. The default is path. Examples
<CachePrefix type="path"></CachePrefix>

When the attribute type is path, the server appends the physical path of the recorded stream to the prefix.
<CachePrefix type="sname"></CachePrefix>

When the attribute type is sname, the server appends the stream name to the prefix. The cache prefix is any text with or without preset parameters. The prefix can be any name without special characters, such as \, :, *, ?, ", <, >, |. All parameters are surrounded by “?”. The server substitutes the actual names for everything specified within the “?”.

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 100
XML configuration files reference

By default, the prefix is set to ?IP?.
Cache prefix
?IP? ?APP? ?APPINST? ?VHOST?

Actual name IP address of the server Application name Application instance vhost name

You can include the IP address in the prefix to avoid file collision. For example, the edge server might be connecting to two different origin servers with the same file in c:\data\foo.flv. Adding the IP to the prefix for these files points each file to the appropriate server. If you want more than one origin server to share the cache file, do not include the IP as a parameter. Remember the cache prefix is a relative path used by the edge server to look up the cache stream file. Examples The cache prefix creates a relative path in the edge’s CacheDir. All parameters are separated by \ or /.
<CachePrefix type="path">c:\fms\flvs\foo.flv. data/?IP?</CacheDir>

resolves to:
data/xxx.xxx.xxx.xxx/c/fms/flvs/foo.flv <CachePrefix type="path">?APPINST?/data</CacheDir>

resolves to:
app1/inst1/data/c/fms/flvs/foo.flv <CachePrefix type="path">origin1/data/</CacheDir>

resolves to:
origin1/data/c/fms/flvs/foo.flv

See also
StorageDir, DuplicateDir, CacheUpdateInterval

CacheUpdateInterval
This element defines the wait interval for updating cache streaming in the edge server. The interval is defined in milliseconds. The default value is 10 minutes. The minimum interval is 10 seconds. The maximum interval is 24 hours. Example
<CacheUpdateInterval>10</CacheUpdateInterval>

See also
StorageDir, DuplicateDir, CachePrefix

For example. Logging checkpoint events to the Access log is enabled in the Vhost. Contained elements Bandwidth.000 bytes per second. The elements nested within this container configure the client. BandwidthDetection. play-continue. You can configure this value in the Bandwidth section of XML and in the BandwidthCap section of XML. By default. the Client element includes an override="no" parameter. The values in the Bandwidth section can be overridden. Checkpoint events log bytes periodically during an event. and publish-continue. You can configure this value in the Bandwidth section of XML and in the BandwidthCap section of XML. ClientToServer (Bandwidth) Specifies the bandwidth the client can use for sending data upstream to the server. but the values in the BandwidthCap section are not.xml file.250. This allows ISPs to host applications for customers and ensure that no customer abuses the bandwidth limit. If your programming includes live events or 24/7 programming. MsgQueue.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Individual applications cannot override how the elements in the Client section are configured. the events you use to calculate billing might not occur within a billing cycle. You can disable logging checkpoints for this application. HTTPTunnel. or change the checkpoint interval of this application. The following are available as checkpoint events: connect-continue. but cannot exceed the caps set by the ISP. For example.000. BandwidthCap. or if the value is invalid. a customer can set any bandwidth limit for their applications. Example <ClientToServer>1250000</ClientToServer> See also ServerToClient (Bandwidth) ClientToServer (BandwidthCap) Specifies the maximum bandwidth a client can send to the server. The default bandwidth is 1. but cannot exceed the caps set by the ISP. the server uses the value set in the Vhost. If the checkpoint interval is not specified in the Application. a customer can set any bandwidth limit for their applications. you can enable checkpoint events.xml file. but the values in the BandwidthCap section are not.xml file by default. Contained elements LogInterval Client Container element.5 CONFIGURATION AND ADMINISTRATION GUIDE 101 XML configuration files reference Checkpoints Many companies use statistics from the access log to bill customers.000 bytes per second. The values in the Bandwidth section can be overridden. This allows ISPs to host applications for customers and ensure that no customer abuses the bandwidth limit. OutChunkSize. To solve this problem. The default bandwidth is 100. MaxMessageSizeLosslessVideo. .

Example <DataSize>16384</DataSize> See also MaxRate. The elements in this section configure debug connections. as it can cause latency.allowDebug.5 CONFIGURATION AND ADMINISTRATION GUIDE 102 XML configuration files reference Example <ClientToServer>100000000</ClientToServer> See also ServerToClient (BandwidthCap) CombineSamples Container element. followed by 3x bytes. Note: Use this strategy of combining sound samples advisedly during periods of high CPU usage. including the maximum number of connections and the value for application. For example. and so on until MaxWait time has elapsed. To detect the client’s bandwidth. MinBufferTime (Live) Debug Container element. This strategy saves the CPU and bandwidth overhead when transmitting individual audio packets only. the server attempts to send a series of random blocks of data to the client. Subscribers Connections Container element. Contained elements AllowDebugDefault. The elements in this section configure the HTTP connections for this application. MaxSamples. The server conserves system resources by combining sound samples. Contained elements LoCPU. followed by 2x bytes. HiCPU. Interface DataSize Specifies the amount of data in bytes that the server sends to the client. Contained elements MaxTimeOut (Connections). each time sending this much more data. MaxPendingDebugConnections .Last updated 3/2/2010 FLASH MEDIA SERVER 3. x bytes are sent. Reuse.

With the default configuration. Scopes have an enclosing relationship with a strict ordering: adaptors contain virtual hosts. See also Enabled DirLevelSWFScan Specifies the number of levels of subfolders within a parent folder to scan for SWF files. if the value of Scope is adaptor. Specifying rtmpe includes rtmpe and rtmpte connections. The default value is 1. The parent folder is specified in the SWFFolder element. which allows all protocols to connect to the server. the value of Distribute can be vhosts. apps. which contain applications. Specifying a negative value scans all subfolder levels. for all your applications and application instances under a single virtual host.5 CONFIGURATION AND ADMINISTRATION GUIDE 103 XML configuration files reference Diagnostic Specifies whether diagnostic logging for the message queue is enabled. which contain instances. so systems that use multiple virtual hosts will generate more running processes. Specify protocols in a comma delimited list. The value of the Distribute tag must be a scope that is lower in order than the value in the Scope tag. but you should never need more than 40. or clients. the numprocs attribute must be set to a value higher than 0 or 1. Note: There is no limit to the value of the numprocs attribute. or rtmpe. For example. The default value of the numprocs attribute is 3. Specifying zero scans the parent folder and no subfolders.rtmps</DisallowedProtocols> The default value is blank. which contain clients. The default value is insts. Specifying a positive value scans that number of subfolder levels. rtmps. insts. If the value of Scope is app. This feature is turned on by default. In other words. which specifies the maximum number of processes to run concurrently. Distribute Specifies how to distribute application instances to processes. This tag contains a numprocs attribute. By default.Last updated 3/2/2010 FLASH MEDIA SERVER 3. See also SWFFolder. the following XML disallows rtmp and rtmps and only allows clients to connect over rtmpe: <DisallowedProtocols>rtmp. which means that the server scans only one subfolder level. Each virtual host is allotted three core processes. the server uses the value immediately lower than the one specified in the Scope tag. To use this feature. SWFVerification DisallowedProtocols Specifies which protocols cannot be used to connect to an application. The default value is false. the value of Distribute can be insts or clients. three core processes will run. Specifying rtmp includes rtmp and rtmpt connections. Any protocol not specified is allowed. The following table lists the values available for the Distribute element: . You can specify rtmp. meaning each application instance runs in its own process.

This location serves as a backup for shared object files and recorded stream files. clients Example <Distribute numproc="1"></Distribute> See also Scope. in seconds. The minimum wait time is 1 second. to wait before it notifies the client when the audio has stopped in the middle of a live or recorded audio stream. If you choose this value.5 CONFIGURATION AND ADMINISTRATION GUIDE 104 XML configuration files reference Value vhosts apps insts Description All instances of applications in a virtual host run together in a process. There is effectively no maximum value (the maximum is the maximum value of a 32-bit integer). For example. Most vod (video on demand) applications are stateless because each client plays content independently of all other clients. change the appName attribute to "true". Chat and gaming applications are not stateless because all clients share the application state. Use this value for stateless applications—applications that don’t require clients to interact with other clients and don’t have clients accessing live streams. the messages wouldn't reach everyone in the chat because they’d be split into separate processes. Specifies the physical location where duplicate copies of shared objects or recorded streams are stored. LifeTime. you must also set the Distribute numprocs attribute to a value greater than 1. Example <Duration>3</Duration> . Example To include the application name in the paths for the backup files.xml file: one is in the SharedObjManager container and one is in the StreamManager container. This is the default value. This location must already exist when a shared object is copied to it. All instances of an application run together in a process.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Each client connection runs in its own process. MaxFailures. Each application instance runs in its own process. RecoveryTime DuplicateDir Note: This feature has been deprecated. if a shared chat application were set to client. This is one of two DuplicateDir elements in the Application. <DuplicateDir appName="true">c:\backupSharedObjects</DuplicateDir> <DuplicateDir appName="true">c:\backupStreams</DuplicateDir> See also StorageDir Duration This element instructs the server how long. The default wait time is 3 seconds.

Add To="WIN 9. This is a string comparison with editing to make all numeric fields equal length. Example <EnhancedSeek>true</EnhancedSeek> See also KeyFrameInterval EraseOnPublish When set to true.0. For On2 VP6.28. Keyframes improve the visual display of video files while seeking. See also Diagnostic EnhancedSeek This element enables or disables fine-tuning of the seeking performance within streams by creating a keyframe. a new keyframe is dynamically generated to provide smooth seeking to that index point.0.0 as its UserAgent.0.264-encoded video.5 CONFIGURATION AND ADMINISTRATION GUIDE 105 XML configuration files reference See also Password Enabled Specifies whether diagnostic logging for the message queue is enabled. using a specific Flash Player will report WIN 9. See also Live (StreamManager) Exception This element indicates that a specific user agent is an exception to authentication. For H.28. Note: The server generates new keyframes for Sorenson Spark-encoded FLV files. Use the from and to attributes to indicate the lowest and highest versions to except. the new keyframe is calculated and generated in Flash Player 9 Update 3 or later.0" and only that version is an exception. The default value is true. When set to true.Last updated 3/2/2010 FLASH MEDIA SERVER 3. See also UserAgentExceptions . The server does not insert keyframes and all seeks begin at the nearest existing keyframe. The default value is false. this setting is disabled and the server does not erase a recorded stream. the new keyframe is calculated and generated in Flash Player 9a or later. For example.28. the server erases a recorded stream when a new publisher starts publishing. By default.0" and From="WIN 9.

See also SWFVerification FirstHashTimeout This element defines the maximum amount of time that a client can use to provide its first verification to the server. MaxQueueSize. The default percentage of utilization is 80. Example <FolderAccess>false</FolderAccess> See also Access HiCPU This element instructs the server to start combining samples when CPU utilization is higher than the specified percentage of CPU resources. The default is true. AccumulatedIFrames FolderAccess Configures the level of permission that the Access plug-in can set for accessing streams and shared objects. See also SWFVerification FlushOnData Specifies whether the server flushes the message queue when a data message arrives. This allows two levels of permissions: file-level access (a value of false). which allows access to a particular directory.Last updated 3/2/2010 FLASH MEDIA SERVER 3. so the server can send out the messages immediately. Contained elements VirtualDirectory FinalHashTimeout This element defines the maximum amount of time that a client can use to provide its final verification to the server. which allow access to a particular file only. See also Queue. This element is important for streaming data-only messages. Example <HiCPU>80</HiCPU> .5 CONFIGURATION AND ADMINISTRATION GUIDE 106 XML configuration files reference FileObject Container element. The VirtualDirectory element nested within this container configures the JSEngine file object settings. and folderlevel access (a value of true). MaxQueueDelay.

The elements in this section configure the HTTP connection settings for this application.com:8080</Host> See also Port. Proxy. Example <Host>www. Example <HTTP1_0>false</HTTP1_0> See also HTTP. The value of the Host element can be the host name or an IP address. . Selecting too small a delay value for the above parameters will increase the polling frequency and reduce network performance and efficiency. Contained elements HTTP1_0. Connections. The port number can also be specified in the Port element. Username. The tunnelling protocol is based on the client continuously polling the server. Proxy. Selecting too high values can adversely affect the interactivity of the application and the server. Type.0 protocol.xml configuration file offers three settings for these parameters.example. The following table presents these settings. Verbose. disallowing the use of the HTTP 1. The Application. The frequency of polling affects both network performance and the efficiency of the HTTP protocol.Last updated 3/2/2010 FLASH MEDIA SERVER 3. LoCPU. MaxSamples Host This element identifies the HTTP proxy. Redirect HTTP1_0 This element determines whether or not the server can use the HTTP 1. Password HTTP Container element. Tunnel.5 CONFIGURATION AND ADMINISTRATION GUIDE 107 XML configuration files reference See also Subscribers.0 protocol. Connections. Redirect HTTPTunnel Container element. The elements nested within this container configure the parameters for HTTP tunnelling (sending RTMP packets through HTTP). The default is false. Verbose. The IdleAckInterval and IdlePostInterval elements control the polling frequency on a per-client basis.

5 CONFIGURATION AND ADMINISTRATION GUIDE 108 XML configuration files reference Acceptable Latency Low Medium High IdlePostInterval 128 milliseconds 512 milliseconds 1024 milliseconds IdleAckInterval 256 milliseconds 512 milliseconds 2048 milliseconds Example <HTTPTunnel> <IdlePortInterval>512</IdlePostInterval> <IdleAckInterval>512</IdleAckInterval> <MimeType>application/x-fcs</MimeType> <WriteBufferSize>16</WritebufferSize> </HTTPTunnel> Contained elements IdlePostInterval. Note: At times. The interval for an idle post ranges from 0 to 4064 milliseconds. This interval implies that the client may not be able to reach the server for the selected duration. MimeType. WriteBufferSize IdlePostInterval Specifies how long Flash Player should wait before sending an idle post to the server. but posting is necessary to provide the server with an opportunity to send data downstream to the client. Example <IdleAckInterval>512</IdleAckInterval> See also IdlePostInterval. the default value of 512 milliseconds is used. MimeType. The server may respond sooner than the value of this element if it has data to send back to the client or if some other client is being blocked by the current idle request. The interval cannot be set to a negative value. Example <IdlePostInterval>512</IdlePostInterval> .Last updated 3/2/2010 FLASH MEDIA SERVER 3. Idle posts are sent when Flash Player has no data to send. IdleAckInterval. If the IdlePostInterval element is set to a value that lies outside of this range. The default interval is 512 milliseconds. WriteBufferSize IdleAckInterval Specifies the maximum time the server may wait before it sends back an ack (acknowledgement code) for an idle post sent by the client. the server will not be able to send any data to the client for the selected duration.

xml file in an application folder creates properties available for that application only. with the values jdoe and engineering. The elements nested within this container configure the JavaScript engine.example.xml file creates properties available for all applications on a virtual host. Example The following XML fragment defines the properties user_name and dept_name. The server only sends the silence message to clients specified in the UserAgent element in the Client section. Defining properties in an Application.5 CONFIGURATION AND ADMINISTRATION GUIDE 109 XML configuration files reference See also IdleAckInterval. Example <Interface>www. Defining properties in the default Application. and the property value corresponds to the tag’s contents. create an XML tag. respectively: <JSEngine> <config> <user_name>jdoe</user_name> <dept_name>engineering</dept_name> </config> </JSEngine> . Bit-flag 0x01 is used to control the silence message. Silence messages are used to support older versions of Flash Player. MimeType. Example <Interval>3</Interval> See also SendSilence JSEngine Container element.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The default interval is 3 seconds. you can define properties for the server-side Application object.com</Interface> See also MaxTimeOut (Connections). To define a property. The property name corresponds to the tag’s name. Set this to 0 to disable silence message transmission. or a host name. The name can be an interface name.xml configuration files. Reuse Interval Specifies the interval in milliseconds for sending silence messages when no audio is being published to a live stream. In the server Application. WriteBufferSize Interface This element defines the name to use as the outgoing network interface. an IP address.

CacheUpdateInterval LifeTime Container element.5 CONFIGURATION AND ADMINISTRATION GUIDE 110 XML configuration files reference To access the property in server-side code. Queue.property.property. set this element to a nonzero value. The initial value is 60000. ScriptLibPath. the server uses a default value of 1000. EraseOnPublish . Example <KeyFrameInterval>1000</KeyFrameInterval> See also StorageDir. StartClockOnPublish. if this tag is unspecified or set to a value out of range. To roll over such processes. or 43%.prop_name application. Note: Be aware of the correlation between file size and accuracy of seeking when you set this value. MaxLatency. which is the recommended value. However. which is an increase of 33 KB. Contained elements AccumulatedIFrames. The elements nested within this container configure the intermediate frames in a live stream and the message queue. PublishTimeout.Last updated 3/2/2010 FLASH MEDIA SERVER 3. however. Setting this element to a higher value than the initial value reduces the number of keyframes added to the FLV file and thus reduces the file size. The same video has a size of 109 KB with the KeyFrameInterval element set to 1000. which is an increase of 13 KB. use the syntax in either of these examples: application. Contained elements RuntimeSize. DuplicateDir.config. or 17%. For example. MaxGCSkipCount. Setting a higher value for the interval. MaxTimeOut (JSEngine).config["prop_name"] Note: The properties you define are accessible from application. The value of this element is defined in milliseconds. This element determines the lifetime of core processes. not from application. NetConnection KeyFrameInterval This element defines how often to generate and save keyframes in an FLV file. FileObject. a 15-second video with a file size of 76 KB is increased only to 89 KB when the KeyFrameInterval element is set to 5000. RollOver Live (StreamManager) Container element. Contained elements MaxCores. Process rollover happens only when the Scope element is set to inst. and the amount of time the server waits before allowing another publisher to take over a live stream. XMLSocket.config. reduces the seeking accuracy.

5 CONFIGURATION AND ADMINISTRATION GUIDE 111 XML configuration files reference Live (MsgQueue) Container element. MaxSamples Logging A container element. Example <LoadOnStartup>false</LoadOnStartup> See also Process. The timeout value is specified in seconds. Contained elements MaxAudioLatency. DuplicateDir. ResyncDepth. Example <LoCPU>60</LoCPU> See also Subscribers. which instructs the server to wait for an indefinite time. MaxPropertySize LoCPU This element instructs the server to stop combining samples when CPU utilization is lower than the specified percentage of CPU resources. Example <LockTimeout>-1</LockTimeout> See also StorageDir. JSEngine. The default value is false. The elements nested within this container configure live audio. AutoCommit. an instance of each application on the server will be loaded at start-up.Last updated 3/2/2010 FLASH MEDIA SERVER 3. MaxProperties. HiCPU. The default percentage of utilization is 60. Contains elements that control the server logs. The default value is -1. Having an application instance loaded at server start-up saves time when the first client connects to that application. StreamManager LockTimeout Specifies the timeout value before automatically unlocking a shared object if there is a client waiting for an update. . If you set this element to true. MinBufferTime (Live) LoadOnStartup This element determines whether or not the server loads an application instance when the server starts. MaxAppIdleTime.

Time is expressed in milliseconds. Example <MaxAppIdleTime>600</MaxAppIdleTime> See also Process. MaxQueueSize. ApplicationGC MaxAudioLatency Specifies that live audio should be dropped if audio exceeds the time specified. The default is 600 seconds (10 minutes). when aggregate messages are enabled. it is not evaluated as idle. If the application instance is loaded with no clients connected. See also Allow MaxAggMsgSize Specifies the maximum size in bytes of the aggregate messages created from the message queue. FlushOnData. in seconds. LoadOnStartup. Example <MaxAudioLatency>2000</MaxAudioLatency> See also MinBufferTime (Live) . The maximum idle time is specified.5 CONFIGURATION AND ADMINISTRATION GUIDE 112 XML configuration files reference Contained elements Access (Logging) LogInterval The interval at which the server logs checkpoint events. See also Checkpoints Max This element defines the maximum number of redirects allowed.Last updated 3/2/2010 FLASH MEDIA SERVER 3. An application instance is evaluated as idle after all clients disconnect from it. See also Queue. The default value is 4096. AccumulatedIFrames MaxAppIdleTime Specifies the maximum time an application instance can remain idle with no clients connected before it is unloaded from the server’s memory. StreamManager. JSEngine. MaxQueueDelay.

a customer can set any MaxDuration for their applications. see “Configure how applications are assigned to server processes” on page 16. of a recorded file. Note: The F_STREAM_RECORD_MAXDURATION field in the Authorization plug-in can override this value. It is only applicable in edge servers. The default value of 128 is sufficient in most cases.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The default value is -1. By default. For more information on setting the maximum number of core processes. DuplicateDir. This configuration tag prevents the server from indefinitely trying to buffer data that is never delivered by the origin server. See also MaxDuration. MaxSize (Recording) MaxDurationCap Specifies the cap on the maximum duration (in seconds) of a recorded file. in seconds. Setting the value -1 removes the maximum duration cap. The value -1 means there is no maximum duration. See also MaxDurationCap. MaxSizeCap. Example <MaxBufferRetries>128</MaxBufferRetries> See also StorageDir. Setting the value 0 disables recording.5 CONFIGURATION AND ADMINISTRATION GUIDE 113 XML configuration files reference MaxBufferRetries Specifies the maximum number of attempts to start buffering stream data. Example <MaxCores>0</MaxCores> See also LifeTime. Set this parameter when you deploy a DVR application to prevent the disk from exceeding its capacity. MaxSizeCap. CacheUpdateInterval MaxCores The value of this element determines how many core processes can exist for an application. the MaxCores function is disabled. For example. but cannot exceed the MaxDurationCap set by the ISP. Note: The F_STREAM_RECORD_MAXDURATION field in the Authorization plug-in can override this value. CachePrefix. Values set in the MaxDuration element or in Server-Side ActionScript cannot exceed this value. The value 0 disables recording. RollOver MaxDuration Specifies the maximum duration. The default value is zero. MaxSize (Recording) . This element allows ISPs to host applications for customers and ensure that no customer abuses the MaxDuration limit. The default value is -1.

the server forces a GC when the skip count exceeds the value in MaxGCSkipCount.xml file.xml file. RecoveryTime MaxIdleTime The maximum time a client can be idle before the server closes the connection. the JS engine does not necessarily perform GC when it is busy. Example <MaxFailures>2</MaxFailures> See also Scope. the server forces a GC regardless of the JS engine state. NetConnection MaxFailures The value of this element determines the maximum number of core process failures that can occur before a core process is disabled. This value is set in the Server.FileObject.5 CONFIGURATION AND ADMINISTRATION GUIDE 114 XML configuration files reference MaxGCSkipCount Specifies the maximum number of times that the server will skip garbage collection (GC) when the JS engine is busy. Distribute. the server only performs GC when the JS engine is not busy. See also AutoCloseIdleClients MaxInitDelay The maximum number of seconds used to process SWF files. LifeTime. If MaxGCSkipCount is set to 0. However.xml file by default. By default. Example <MaxInitDelay>5</MaxInitDelay> Example SWFVerification . so in some cases you must force the server to perform GC regardless of the JS engine state. MaxTimeOut (JSEngine). XMLSocket. Having a time lag for recovery avoids a denial-of-service action. This element determines the frequency of the garbage collection process. ScriptLibPath.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml file to override the value set in the Server. Once the core processes are disabled. You can set the value in the Vhost. Example <MaxGCSkipCount>-1</MaxSGCSkipCount> See also RuntimeSize. The default value is 5 seconds. the server does not launch a core process until some minimum recovery time has elapsed. If MaxGCSkipCount is set to a positive value.xml file to override the value set in the Vhost. which can happen when a faulty core consumes all CPU resources by repeatedly launching itself. You can set the value in the Application.

The default value is 500. the server adds the time difference between the last message time and the injection time to the timestamp of the data message. The default is 50. When a server-side script injects a data message into a live stream. debugging connections are disabled. Example <MaxMessageSizeLosslessVideo>0</MaxMessageSizeLosslessVideo> See also OutChunkSize. use -1. To specify unlimited size. To specify unlimited. this setting determines the timestamp of the message. Example <MaxProperties>-1</MaxProperties> See also StorageDir.Last updated 3/2/2010 FLASH MEDIA SERVER 3. the oldest pending debug connection is rejected to create space.) Once the specified number is reached. LockTimeout. the timestamp is the last message time. If the injection time is larger than MaxLatency. (If the number is set to 0. ResyncDepth. DuplicateDir.5 CONFIGURATION AND ADMINISTRATION GUIDE 115 XML configuration files reference MaxLatency The maximum latency. of incoming messages in a live stream. See also Live (StreamManager) MaxMessageSizeLosslessVideo Specifies the maximum size of messages for screen-sharing packets. The minimum value is 0. UserAgent MaxPendingDebugConnections Specifies the maximum number of pending debug connections. Access. MaxPropertySize MaxPropertySize The maximum size in bytes for each property of a shared object. AccumulatedIFrames. use -1. Example <MaxPropertySize>-1</MaxPropertySize> . in milliseconds. AutoCommit. Example <MaxPendingDebugConnections>50</MaxPendingDebugConnections> See also AllowDebugDefault MaxProperties The maximum number of properties for each shared object. Otherwise.

Example <MaxRate>-1</MaxRate> See also DataSize. MinBufferTime (Live) MaxSamples Specifies how many sound samples can be combined into one message. AutoCommit. The buffer contains a history of the video messages up to the last keyframe. MaxQueueSize. The default value of -1 sends the data at whatever rate is necessary to measure bandwidth without throttling. in bytes. See also Audio MaxSize (AccumulatedIFrames) Specifies the maximum size. See also Queue. ResyncDepth. AggregateMessages (Queue) MaxRate Specifies the maximum rate in Kbps at which the server sends data to the client. the server clears the messages. A default value of -1 means the size of intermediate frames is unlimited. The default number of samples is 4. The default value is 4096. See also Queue. The default value is 500 milliseconds. This setting prevents the buffer from growing too large and should be set larger than the total size of intermediate frames between keyframes. MaxQueueDelay. LockTimeout. This enables clients to catch up to the latest message even if they join between keyframes. FlushOnData. in kilobytes. of intermediate frames that a live stream can hold in the buffer. If the buffer size is larger than MaxSize. DuplicateDir. AggregateMessages (Queue) MaxQueueSize Specifies how often the server will flush the message queue. A value of 0 disables queuing. in milliseconds. FlushOnData.Last updated 3/2/2010 FLASH MEDIA SERVER 3. MaxProperties MaxQueueDelay Specifies how often the server will flush the message queue. Example <MaxSize>-1</MaxSize> .5 CONFIGURATION AND ADMINISTRATION GUIDE 116 XML configuration files reference See also StorageDir.

Note: The F_STREAM_RECORD_MAXSIZE field in the Authorization plug-in can override this value. Note: The F_STREAM_RECORD_MAXSIZE field in the Authorization plug-in can override this value. The default value of -1 means the duration is unlimited. See also MaxSize (Recording). Example <MaxTime>-1</MaxTime> . in kilobytes. The value 0 disables recording. The default value is -1 (unlimited). For example. CachePrefix. If the duration in the buffer is larger than the MaxTime. Set this parameter when you deploy a DVR application to prevent the disk from exceeding its capacity. The default value is -1. The value -1 means there is no maximum size. of a recorded file.5 CONFIGURATION AND ADMINISTRATION GUIDE 117 XML configuration files reference See also Subscribers. a customer can set any MaxSize for their applications. MaxDuration. DuplicateDir. in seconds. MaxDurationCap MaxSizeCap Specifies the maximum size cap. The value -1 means there is no maximum size. of a recorded file. See also MaxSizeCap. but cannot exceed the MaxSizeCap set by the ISP. LoCPU. The default value is -1. the server clears the messages. GC occurs during the application GC interval. MaxDuration. This element allows ISPs to host applications for customers and ensure that no customer abuses the MaxSize limit. Example <MaxStreamsBeforeGC>-1</MaxStreamsBeforeGC> See also StorageDir.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The value 0 disables recording. The buffer contains a history of the video messages up to the last keyframe. MaxDurationCap MaxStreamsBeforeGC Specifies that garbage collection (GC) should be forced if the stream list grows over the set value. HiCPU MaxSize (Recording) Specifies the maximum size. This setting prevents the buffer from growing too large and should be set larger than the keyframe interval. CacheUpdateInterval. of intermediate frames that a live stream can hold in the buffer. in kilobytes. MaxBufferRetries MaxTime Specifies the maximum duration. This enables clients to catch up to the latest message even if they join between keyframes.

NetConnection MaxUnprocessedChars Specifies how much data can be received from an XML server (without receiving an end tag) before XMLSocket closes the connection.maxUnprocessedChars. This can be overridden by each XMLSocket by specifying the property XML. If the value of this element is too low.5 CONFIGURATION AND ADMINISTRATION GUIDE 118 XML configuration files reference See also RuntimeSize. you should set this element to a more realistic value that does not impose limits on the time scripts take to execute. a script can take to execute a JavaScript (Server-Side ActionScript) function. but that number cannot exceed the number specified in this element. ScriptLibPath. XMLSocket. Interface MaxTimeOut (JSEngine) The maximum time. This setting may be useful in a debugging environment. XMLSocket. . but it also forces the client to wait longer. then the script is evaluated as a runaway script and its execution is terminated. after the applications and scripts have been thoroughly tested. MaxGCSkipCount. ScriptLibPath. Setting a maximum time to execute a script prevents infinite looping in scripts. in seconds. the risk of aborting correctly functioning operations increases. Operations such as DNS lock-ups may take more time. Example <MaxUnprocessedChars>4096</MaxUnprocessedChars> See also XMLSocket MaxWait This element specifies the number of seconds to wait before the server sends data to the client. FileObject. Example <MaxTimeOut>60</MaxTimeOut> See also Reuse. MaxGCSkipCount. If its execution takes longer than the maximum allowed time. The default value is 0 and no checks are performed to detect runaway scripts.FileObject.Last updated 3/2/2010 FLASH MEDIA SERVER 3. NetConnection MaxTimeOut (Connections) This element defines the maximum time for a transfer to be completed. In a production environment. Example <MaxTimeOut>0</MaxTimeOut> See also RuntimeSize. Increasing this number provides a more accurate bandwidth figure. The default time is 60 seconds.

The server will use the entry for the MIMEType element only when it is unable to determine the MIME type from the incoming requests. Example <MinGoodVersion>0</MinGoodVersion> . Example <MinBufferTime>2000</MinBufferTime> See also Recorded MinGoodVersion Specifies the minimum accepted version of SWF verification allowed by the server. WriteBufferSize MinBufferTime (Live) Specifies the default buffer length in milliseconds for the live audio and video queue. The server generally uses the MIME type specified by the incoming requests.5 CONFIGURATION AND ADMINISTRATION GUIDE 119 XML configuration files reference Example <MaxWait>4096</MaxWait> See also MaxRate.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Example <MimeType>application/x-fcs</MimeType> See also IdleAckInterval. The default value is 0. DataSize MimeType Specifies the default MIME (Multi-purpose Internet Mail Extensions) type header sent on tunnel responses. Example <MinBufferTime>2000</MinBufferTime> See also MaxAudioLatency MinBufferTime (Recorded) Specifies the default buffer length in milliseconds for audio and video. The value cannot be set below this by Flash Player. IdlePostInterval. which allows the current and all future versions.

Example <NotifyAudioStop enabled="false"></NotifyAudioStop> Contained elements Duration ObjectEncoding Specifies the default object encoding to use for SSAS NetConnection. The default value is 64. Contained elements Live (MsgQueue). Setting this value to less than 64 may cause content with a low FPS to delay before starting. Streams that use H. The Duration element nested within this container determines whether or not the server is notified when an audio transmission ending on a stream is encountered. This setting ensures that regardless of the buffer setting there are enough messages to begin playback quickly.264 or any other pipelined codec need messages to begin playback. The elements nested within this container configure live and recorded audio. The default can be overridden for each individual NetConnection by setting the NetConnection.5 CONFIGURATION AND ADMINISTRATION GUIDE 120 XML configuration files reference See also SWFFolder. Contained elements ObjectEncoding NotifyAudioStop Container element. The element nested within this container specifies object encoding to use for SSAS NetConnection. .objectEncoding property to either 0 for AMF0 or 3 for AMF3.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Server NetConnection Container element. Recorded. This can be AMF0 or AMF3. See also Server MsgQueue Container element. UserAgentExceptions MinQueuedVideo The minimum number of video messages to queue at the start of a stream. The default is AMF3.

Example <OverridePublisher>true</OverridePublisher> See also Audio. HTTPTunnel. The default value is false. If set to true. Note that older clients might not support chunk sizes larger than 1024 bytes. add application logic to avoid stream name collision. See also Host. MsgQueue. Larger values reduce CPU usage but cause larger writes that can delay other content on lower bandwidth connections. The default value is 4096. Specifies whether a second client is able to take over the ownership of a live stream when the stream is already published by another client. MaxMessageSizeLosslessVideo OverridePublisher Deprecated. If the chunk setting is larger than these clients can support. Username . Type. Tunnel. BandwidthCap. Live (StreamManager). Example <OutChunkSize>4096</OutChunkSize> See also Bandwidth. the chunk setting is capped at 1024 bytes. see the PublishTimeout element. Tunnel. Port.5 CONFIGURATION AND ADMINISTRATION GUIDE 121 XML configuration files reference Example <ObjectEncoding>AMF3</ObjectEncoding> See also NetConnection OutChunkSize Specifies the RTMP chunk size in bytes to use in all streams for this application. SendDuplicateOnMetaData Password Specifies the password for connecting to the proxy. The server breaks stream content into chunks of this size. See also Host. SendDuplicateStart. Type.Last updated 3/2/2010 FLASH MEDIA SERVER 3. BandwidthDetection. Password. This can have a minimum value of 128 bytes and a maximum value of 65536 bytes. Username Port Specifies the proxy port to connect to if the port is not specified as part of the host in the Host element.

which contain instances. if the value of Scope is adaptor. prioritization is set to false. apps. By default. MaxFailures. Username. Tunnel. Messages are sent out through one channel and all messages have the same priority. the server sends messages through multiple channels and prioritizes messages based on the message type. Password . Process rollover happens only when the Scope element is set to inst. Distribution may be turned off by setting numproc to 0 or 1. Value Scope Description Specifies the level at which application instances are assigned to core processes. The value for this element determines the maximum number of core process failures that can occur before a core process is disabled. Specifies how to distribute application instances to processes. The following table lists descriptions of the contained elements. Specifies the lifetime of core processes. which is the correct setting to avoid possible latency when server-side NetStream objects are used to publish messages to remote servers. as follows (where 1 has the highest priority): 1 Data 2 Audio 3 Video See also Server Process Container element. Distribute. the value of Distribute can be vhosts. which contain clients.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Type. The value of the Distribute tag must be a scope that is lower in order than the value in the Scope tag (for example. Scopes have an enclosing relationship with a strict ordering: adaptors contain virtual hosts. LifeTime.5 CONFIGURATION AND ADMINISTRATION GUIDE 122 XML configuration files reference Prioritization Specifies whether outgoing messages are prioritized by message type when sending across a server-to-server connection. or clients). The elements nested within this container configure the HTTP Proxy settings. Distribute LifeTime MaxFailures RecoveryTime Contained elements Scope. Port. Specifies the recovery time for a core. The elements nested within this container determine how a core process is managed. This setting is relevant for multi-point publishing. which contain applications. Contained elements Host. If the value is set to true. insts. Proxy Container element. RecoveryTime.

Contained elements MaxDuration.Last updated 3/2/2010 FLASH MEDIA SERVER 3. You can map the stream differently for each client in the F_STREAM_PATH property of your Authorization plug-in code. set the enabled attribute to false. Contained elements MaxQueueSize. MaxDurationCap. To disable queuing. Contained elements MinBufferTime (Recorded) Recording Container element. This tag replaces the OverridePublisher tag. Queue Container element. This tag is applicable when using the Authorization plug-in. Flash Media Server pings the first publisher and waits to receive a response. The default value is 2000 milliseconds. MaxSizeCap .flv for client 2. MaxSize (Recording). The elements nested within this container specify the duration and file size of files recorded by the server. If the first publisher fails to respond within the time specified in this tag. an E_FILENAME_TRANSFORM event occurs in the Authorization plug-in. the server allows the second publisher to take over the live stream. To prevent the server from pinging the first client. You can remap the stream to c:\video1\myStream. AggregateMessages (Queue) Recorded Container element. contains elements that configure the settings of the message queue. QualifiedStreamsMapping Enables mapping of virtual stream paths to different physical locations.flv.5 CONFIGURATION AND ADMINISTRATION GUIDE 123 XML configuration files reference PublishTimeout Specifies how long in milliseconds the server waits to receive a response from a publisher when another client tries to publish to the same stream. A message queue is used to buffer incoming messages from the publisher so that the server can send messages in chunks to the subscribers. suppose client 1 and client 2 both request to play myStream. You can disable queuing so that individual messages are immediately sent to subscribers. The element nested within this container specifies the ratio of buffer length used by the server-side stream to the live buffer. If a client tries to publish to the same live stream that is being published by another client. When a client requests to play a stream.flv for client 1 and c:\video2\myStream. MaxQueueDelay. FlushOnData. disable this setting by setting the value of the tag to -1. For example.

Example <RecoveryTime>300</RecoveryTime> See also Scope. MaxPropertySize Reuse This element configures whether or not the server explicitly closes the HTTP connection after each transfer. A value of 0 disables any checking for process failures. MaxProperties. LockTimeout. Example <Reuse>true</Reuse> See also MaxTimeOut (Connections). Note: Loading an application with Flash Media Administration Server tools or APIs bypasses this check. The recovery time for a core process is specified. Set this to false to use a new connection after every transfer.Last updated 3/2/2010 FLASH MEDIA SERVER 3. AutoCommit. The default is to reuse connections. The server will not launch a core process until some minimum recovery time has elapsed. DuplicateDir. The shared object is resynchronized when its version number is greater than the head version minus the current version. The elements nested within this container configure the settings for redirecting the HTTP connection. Max. in seconds. Example <ResyncDepth>-1</ResyncDepth> See also StorageDir. Interface . which happens when a faulty core process consumes all CPU time by repeatedly launching itself. UnrestrictedAuth ResyncDepth This element instructs the server to resynchronize a shared object file.5 CONFIGURATION AND ADMINISTRATION GUIDE 124 XML configuration files reference RecoveryTime Specifies the recovery time for a core. MaxFailures Redirect Container element. LifeTime. Distribute. Contained elements Allow. The default value of -1 sends a resynchronized version of the file with every connection. The time lag for recovery can avoid a denial-of-service action.

The following table lists the values available for the Scope element. All subsequent connections are directed to the new core. ScriptLibPath.exe (Windows) or fmsmaster (Linux). Settings made in an Application. If you create a new script object that will cause the runtime size of the application instance to exceed the value of this element. Only one master process can run at a time. you must increase the engine size. The default value is 0 (seconds). see “Configure how applications are assigned to server processes” on page 16. a new core is instantiated. .Last updated 3/2/2010 FLASH MEDIA SERVER 3. The rollover functionality is disabled by default. Example <Rollover>0</RollOver> See also MaxCores RuntimeSize Specifies the maximum size in kilobytes that a particular application instance can use to run Server-Side ActionScript code before the server removes unreferenced and unused JavaScript objects. FileObject. XMLSocket. For more information on rollover processes.xml file in a virtual host folder apply to all applications running in that virtual host. NetConnection Scope This element determines the level at which application instances are assigned to core processes.xml file in an application’s folder apply only to that application. The default value applies when the engine size lies outside of these limits. If your application consumes a significant amount of memory. Settings in an Application. MaxTimeOut (JSEngine). Starting Flash Media Server starts a process called FMSMaster. an out-ofmemory error occurs and the application instance is shut down. Application instances run in processes called FMSCore.exe (Windows) fmscore (Linux).5 CONFIGURATION AND ADMINISTRATION GUIDE 125 XML configuration files reference RollOver Specifies how many seconds a core process can be in use before the server creates a new core process. The lower and upper limits on the size of the JavaScript engine are 10 kilobytes and 51200 kilobytes (50 megabytes). In most cases. The master process is a monitor that starts core processes when necessary. After the time limit for a core is reached. increasing the engine size to 30720 (30 MB) is sufficient to run intensive Server-Side ActionScript operations. The default size is 1024 kilobytes. but many core processes can run at the same time. which is the equivalent of 1 megabyte. Example <RuntimeSize>1024</RuntimeSize> See also MaxGCSkipCount.

Last updated 3/2/2010 FLASH MEDIA SERVER 3.asc file with the load() method. MaxGCSkipCount. MaxTimeOut (JSEngine). the script engine searches. Each application instance runs in its own process. NetConnection SendDuplicateOnMetaData Specifies whether an onMetaData message is sent at the beginning of video files when the play and seek commands are called. If you choose this value. no onMetaData is sent. once falls back to FMS 1. MaxFailures. The default value is true. false sends onMetaData for play only. Example <Scope>vhost</Scope> See also Distribute. The following values are available: • • • true sends onMetaData for the play and seek commands. If no onMetaData is found at the start position. Example <ScriptLibPath>${APP.JS_SCRIPTLIBPATH}</ScriptLibPath> See also RuntimeSize. regardless of the command.x behavior and sends onMetaData based on the start position. RecoveryTime ScriptLibPath This element is a list of paths delimited by semicolons instructing the server where to look for server-side scripts loaded into a main. Example <SendDuplicateOnMetaData>true</SendDuplicateOnMetaData> See also SendDuplicateStart . This is the default value. All application instances in a virtual host run together in a process. the list of paths specified in this element. All instances of a single application run together in a process.asc or application_name. LifeTime. These paths are used to resolve a script file that is loaded with the load API. you must also set the Distribute numprocs attribute to a value greater than 1.asc file is located. The server first looks in the location where the main.5 CONFIGURATION AND ADMINISTRATION GUIDE 126 XML configuration files reference Value adaptor vhost app inst Description All application instances in an adaptor run together in a process. XMLSocket. in sequence. If the script file is not found there. FileObject.

000 bytes per second. and Prioritization. Example <SendDuplicateStart>true</SendDuplicateStart> See also SendDuplicateOnMetaData. but the values in the BandwidthCap section are not. a customer can set any bandwidth limit for their applications.Start is sent for all commands. The default bandwidth is 250.5 CONFIGURATION AND ADMINISTRATION GUIDE 127 XML configuration files reference SendDuplicateStart Specifies whether status message NetStream. Contained elements BufferRatio. OverridePublisher SendSilence Container element. only the play command receives the start message. Contained elements Interval Server Container element. which specifies the ratio of the buffer length used by the server-side stream to the live buffer. Example <ServerToClient>250000</ServerToClient> See also ClientToServer (Bandwidth) ServerToClient (BandwidthCap) Specifies the maximum bandwidth in bytes per second that the server can use for sending data downstream to the client. If set to false.Play. Contains two elements: BufferRatio. including play. This allows ISPs to host applications for customers and ensure that no customer abuses the bandwidth limit. and unpause. but cannot exceed the caps set by the ISP. You can configure this value in the Bandwidth section of XML and in the BandwidthCap section of XML. which specifies whether to prioritize outgoing messages for server-to-server connections. seek. . The values in the Bandwidth section can be overridden. Prioritization ServerToClient (Bandwidth) Specifies the bandwidth in bytes per second that the server can use for sending data downstream to the client. The Interval element nested within this container configures the settings for sending silent messages. For example.Last updated 3/2/2010 FLASH MEDIA SERVER 3.

By default the physical location is not set. The values in the Bandwidth section can be overridden. but the values in the BandwidthCap section can not.5 CONFIGURATION AND ADMINISTRATION GUIDE 128 XML configuration files reference The default bandwidth is 10.000 bytes per second. This allows ISPs to host applications for customers and ensure that no customer abuses the bandwidth limit. See also Live (StreamManager) StorageDir Specifies the physical location where shared objects or streams are stored. multibitrate streaming. Example <ServerToClient>10000000</ServerToClient> See also ClientToServer (BandwidthCap) SharedObjManager Container element. MaxProperties. DuplicateDir. You can configure this value in the Bandwidth section of XML and in the BandwidthCap section of XML. . ResyncDepth. Set this element only if the files for shared objects or recorded streams must be stored in a location other than the application directory. To use dynamic. Example <StorageDir>C:\myapp\sharedobjects\</StorageDir> <StorageDir>C:\myapp\streams\</StorageDir> See also DuplicateDir StreamManager Container element. Contained elements StorageDir. LockTimeout. a customer can set any bandwidth limit for their applications. but cannot exceed the caps set by the ISP. leave this value false. MaxPropertySize StartClockOnPublish Specifies whether the stream time is sensitive to the difference between publish time and the arrival of the first stream message. For example. The elements nested within this container configure the Shared Object Manager setting of an application. AutoCommit.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The default value is false.000. The elements in this section configure the Stream Manager settings for this application.

Example For an application named myApplication located at C:\applications\. FinalHashTimeout. The server compares these SWF files to client SWF files connecting to applications on the server. See also MinGoodVersion. MinGoodVersion. CacheUpdateInterval. Use a semicolon to separate multiple directories. ThrottleBoundaryRequest. DuplicateDir. Note: SWF files connecting to Flash Media Administration Server cannot be verified. Specifies how the server verifies client SWF files before allowing the files to connect to an application. MaxSizeCap. SendDuplicateOnMetaData. MaxSize (Recording). ThrottleLoads.Last updated 3/2/2010 FLASH MEDIA SERVER 3. authenticating SWF files should be placed in C:\applications\myApplication\SWFs. The default number of subscribers is 8. DirLevelSWFScan. Live (StreamManager). MaxInitDelay. MaxDuration. Example <Subscribers>8</Subscribers> See also LoCPU. EnhancedSeek. SendDuplicateStart. CachePrefix. ThrottleDisplayInterval. Contained elements SWFFolder.5 CONFIGURATION AND ADMINISTRATION GUIDE 129 XML configuration files reference Contained elements StorageDir. KeyFrameInterval. see “Verify SWF files” on page 19. HiCPU. Audio. MaxSamples SWFFolder Specifies a single folder or a semicolon-delimited list of folders containing copies of client SWF files. SWF files located under an instance named folder can only connect to that specific instance. FirstHashTimeout. . For more information. Cache ThrottleBoundaryRequest Controls the maximum number of concurrent boundary requests per recorded stream. When streaming through a proxy server. UserAgentExceptions. The default value of the SWFFolder element is the application's folder appended with /SWFs. UserAgentExceptions SWFVerification Container element. MaxStreamsBeforeGC. Verifying SWF files is a security measure that prevents someone from creating their own SWF files that can attempt to stream your resources. MaxBufferRetries. the boundary information about video segments are sent to the proxy server by request. MaxDurationCap Subscribers This element instructs the server to combine sound samples only if there are more than the default number of subscribers to that stream.

The default setting is false. video segments are sent to the proxy server by request. ThrottleDisplayInterval Tunnel Specifies whether or not to tunnel all operations through a given HTTP proxy. Example <ThrottleDisplayInterva>64</ThrottleDisplayInterval> See also ThrottleBoundaryRequest. The default value is 64.5 CONFIGURATION AND ADMINISTRATION GUIDE 130 XML configuration files reference The default value is 8. See also Cache. Example <Tunnel>false</Tunnel> See also Host. When streaming through a proxy server. Password TTL Specifies in minutes how long each SWF file remains in the cache. The default value is 8. Example <ThrottleBoundaryRequest enable="false">8</ThrottleBoundaryRequest> See also ThrottleDisplayInterval. ThrottleLoads ThrottleDisplayInterval Controls the interval at which the server displays the throttle queue length. Port. Type. UpdateInterval .Last updated 3/2/2010 FLASH MEDIA SERVER 3. which means the server displays the message 1 out of 64 times when the throttle queue is full. The default value is 1440 minutes (24 hours). Example <ThrottleLoads enable="true">8</ThrottleLoads> See also ThrottleBoundaryRequest. ThrottleLoads ThrottleLoads Controls the maximum number of concurrent segment loads per recorded stream. Username.

Contains an element that specifies a user agent that should be an exception to authentication. Setting the value 0x01 will configure the player and platform for silent messages. Contained elements Bits UserAgentExceptions Container element.5 CONFIGURATION AND ADMINISTRATION GUIDE 131 XML configuration files reference Type Specifies the type of proxy being connected to.28. Username. Max UpdateInterval Specifies the maximum time in minutes to wait for the server to scan the SWF folders for updates when there is a miss in the cache. Port.0"</Exception> </UserAgentExceptions> . Example <UnrestrictedAuth>true</UnrestrictedAuth> See also Allow.0. The default setting is true. Sending the user name/password combination is useful only if the Allow element permits redirections.0" from="WIN 9.28. The value for this element can be HTTP or SOCKS5. The settings for clients vary according to whether Flash Player platform is Windows or Macintosh. The default value is 5 minutes. Example <Type>HTTP</Type> See also Host. Tunnel. See also Cache. TTL UserAgent Container element.0. Use the to and from attributes to indicate the lowest and highest versions to except. Example <UserAgentExceptions> <Exception to="WIN 9. Password UnrestrictedAuth A Boolean value that determines whether or not to allow sending the user name/password combination with each HTTP redirect.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The default is HTTP.

Example If an application is configured to store streams in folders C:\low_quality and C:\high_quality. so do not use absolute paths in the list of folders. To enable access to all video data streamed by the server. In the tag. See also Host. this element allows access to the data without requiring Server-Side ActionScript. Redirect VideoSampleAccess Allows the client application to access the raw uncompressed video data in a stream. this element is disabled.5 CONFIGURATION AND ADMINISTRATION GUIDE 132 XML configuration files reference Contained elements Exception Username Specifies the user name for connecting to the edge.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Proxy. . While you can also enable access through Server-Side ActionScript. specify / in the tag.high_quality</VideoSampleAccess> See also AudioSampleAccess VirtualDirectory Specifies virtual directory mappings for Server-Side ActionScript File objects. specify a list of semicolon-delimited folders to which client applications have access. When this element is enabled. see comments in the Application. By default. the configuration to allow access to sample those streams is as follows: <VideoSampleAccess enabled="true">low_quality. For more information. Tunnel. The folder path is restricted to the application’s streams folder or folders. all clients can access the video data in streams in the specified folders. Connections. Example <Verbose>false</Verbose> See also HTTP1_0. Password Verbose This element determines whether or not the server outputs verbose information during HTTP operations.xml file and “Mapping virtual directories to physical directories” on page 35. Port. set the enable attribute to true. To enable it. Type. You can also override this element with the Access plug-in or Server-Side ActionScript.

The default location of the log files is in the /logs directory in the server installation directory. IdleAckInterval. MimeType XMLSocket Container element. This can be overridden by each XMLSocket by specifying the property XML. including the location of the log files.physical_dir_path</VirtualDirectory> See also FileObject WindowsPerAck Controls how many messages can be sent before receiving an acknowledgement from the other end. The default size is 16 KB. Contains an element that specifies how much data can be received from the XML server (without receiving an end tag) before XMLSocket closes the connection.xml file The Logger. Note: Adobe recommends that you do not change the value of this element.maxUnprocessedChars. .You can edit this file to add or change configuration information.5 CONFIGURATION AND ADMINISTRATION GUIDE 133 XML configuration files reference Example <VirtualDirectory>virtual_dir_name. but that number cannot exceed the number specified in this element. Example <XMLSocket> <MaxUnprocessedChars>4096</MaxUnprocessedChars> </XMLSocket> Contained elements MaxUnprocessedChars Logger. WriteBufferSize Specifies in kilobytes the size of the write buffer.xml contains the elements and information used to configure log files.xml file is located at the root level of the /conf directory and is the configuration file for the logging file system. Logger. Example <WriteBufferSize>16</WriteBufferSize> See also IdlePostInterval.Last updated 3/2/2010 FLASH MEDIA SERVER 3.

Fields.5 CONFIGURATION AND ADMINISTRATION GUIDE 134 XML configuration files reference Log files are written in English. QuoteFields. Events. the columns x-sname and x-suri-stem show the name of the stream. Rotation AuthEvent Container element. Field names displayed in the log file are in English. Rotation.adobe. depending on the filename and the operating system. To effectively turn off rotation. Contained elements LogServer Application Container element. Directory.xml file installed in the RootInstall/conf/ folder. even if the server is running on an English-language operating system. To see the element structure and default values. Note: Log file rotation cannot be disabled. Contained elements LogServer. Contained elements Directory. choose a large maximum size and a long maximum duration for the log files. Access Container element. The Logging section in the Server. For more information. For example. Contained elements LogServer. If the name of the recorded stream is in a language other than English.com/go/learn_fms_plugindev_en. Some content within the log file. The elements in this section configure the AuthEvent log file settings.xml file enables or disables the log files. FileName. FileName. . however. Time. EscapeFields AuthMessage Container element. The elements nested within this container configure the admin log settings. The elements nested within this container configure the Application log file settings. Directory. in the Access.log file. Time. see the Logger.Last updated 3/2/2010 FLASH MEDIA SERVER 3. see the Plug-in Developer Guide at www. Time admin Container element. The elements nested within this container configure the Access log settings. the name is written in that language. Delimiter. may be in another language.

Time. QuoteFields Diagnostic Container element.xml file. Rotation core Container element. The following characters are not allowed as delimiters: • triple quotation marks (''' ) • paired double quotation marks ("") • comma (. the log files are located in the logs directory in the server installation directory.5 CONFIGURATION AND ADMINISTRATION GUIDE 135 XML configuration files reference The elements in this section configure the AuthMessage log file settings.adobe. Rotation Directory Specifies the directory where the log files are located. since # is used as the comment element in the Logger. Contained elements Directory.) • colon (:) • hyphen (-) See also Directory. The elements nested within this container configure the core log settings. see the Plug-in Developer Guide at www. Contained elements Directory. A delimiter is used to separate the fields in the log file.com/go/learn_fms_plugindev_en. Time.Last updated 3/2/2010 FLASH MEDIA SERVER 3. For more information. By default.LOGDIR}</Directory> . The use of the number sign (#) as a delimiter is not recommended. The elements in this section configure the diagnostic log file. Example <Directory>${LOGGER. Contained elements LogServer Delimiter Specifies whether or not to use a single quotation mark (') as a delimiter to separate the fields in the log file. EscapeFields.

the percent sign (%). Time. The default line count is 100 lines. it is set to enable. Events. and the apostrophe (' ). and QuoteFields Events Specifies the events written to the log file. For a list of events that are recorded in the Access log file. Rotation.5 CONFIGURATION AND ADMINISTRATION GUIDE 136 XML configuration files reference See also Time. Fields. Rotation DisplayFieldsHeader Formatting element. the tilde (~). This element controls whether or not the fields in the log file are escaped when unsafe characters are found. bar (|). The elements nested within this container configure the edge log settings. square brackets ([ ]). Example <EscapeFields>enable</EscapeFields> See also LogServer. See also Fields Fields Specifies which fields for an event are logged in the Access log file. FileName. Specifies how many lines to write to the log file before repeating the field headers. .Last updated 3/2/2010 FLASH MEDIA SERVER 3. open or closed angle brackets (< >). Delimiter. a double quotation mark ("). The keyword * instructs the server to log all events. Directory. EscapeFields. open or closed curly braces ({ }). the number sign (#). Contained elements LogServer EscapeFields Formatting element. This optional flag can be set to enable or disable. Specify events in a semicolon-separated list. Example <DisplayFieldsHeader>100</DisplayFieldsHeader> See also Delimiter. see “Access events defined in access logs” on page 57. the carat (^). QuoteFields edge Container element. The unsafe characters are as follows: the space character. By default.

the format YYYY must be used. the formats D or DD are both allowed. see the Plug-in Developer Guide at www. The elements in this section configure the settings for the File plug-in log file settings. Rename . See also LogServer. Fields without data are left empty. For example. Not every field is associated with each event in the log file.log This example identifies version 43 of the access log file for October 30. EscapeFields History Specifies the maximum number of log files to keep. D represents the day of the month of the file’s creation. Schedule. Contained elements Directory. access. QuoteFields. For more information. M represents the month of its creation. Rotation. Note that there is no limit on the number of versions. see “Fields in access logs” on page 59. Delimiter.01. For a list of fields associated with events in the Access log file. Events.03. N represents the version number of the file. Rotation FileName Specifies the name of the Access log file. The keyword * specifies that all fields are to be logged.log.com/go/learn_fms_plugindev_en. Example access. Adobe recommends that you include the following fields in the fields to be logged: the type. access. and time fields. Time. The default number of files to retain is 5. and so on.Last updated 3/2/2010 FLASH MEDIA SERVER 3.adobe. Directory. See also Events FileIO Container element. The Access log filename includes a date stamp and version number. MM represents 04 (April). The files are named access. Example <History>5<History> See also MaxSize. Y represents the year of its creation. Time.log.log. Fields. date. The repetition of a letter represents the number of digits. The field specification is a semicolon-separated list of one or more fields associated with an event in the log file. 2007.02.5 CONFIGURATION AND ADMINISTRATION GUIDE 137 XML configuration files reference Fields are associated with the events found in the Access log file. M represents 4 (April).2007103043. category. the formats M or MM are both allowed.

Contained elements LogServer MaxSize Specifies the maximum log file size in bytes.xml. Specifies whether or not to use quotation marks to surround those fields in the log file that include a space.xxx:1234</HostPort> See also ServerID.5 CONFIGURATION AND ADMINISTRATION GUIDE 138 XML configuration files reference HostPort Specifies the IP and port of the log server. The default file size is 10240 KB.Last updated 3/2/2010 FLASH MEDIA SERVER 3. History. it is set to disable. Rename QuoteFields Formatting element. By default. or approximately 1 MB. . The elements nested in this section configure the server to send messages to a remote log server. Example <HostPort>xxx. The Logger element is a container for all the other elements in Logger. The elements nested within this container configure the master log settings. This element can be set to enable or disable. LogServer Container element. DisplayFieldsHeader master Container element.xxx.xxx. DisplayFieldsHeader Logger Root element. ServerID. Contained elements HostPort. Example <Maxsize>10240</MaxSize> See also Schedule.

02. The default is true. The duration is specified in minutes. Fields. the timestamp 00:00 causes the file to rotate every midnight. EscapeFields Rename Specifies a new name for log files when rotation occurs. Contained elements MaxSize. Rotation. There are two types of scheduling: daily rotation and rotation that occurs when the log exceeds a specified length. The log file with the highest version number keeps the oldest log history. Directory. Examples <Rename>true</Rename> See also MaxSize. a new log file is created with the next available version when rotation occurs. The elements in this section configure the rotation of the log files.00. Examples If the type attribute is daily. Events. History Rotation Container element. Delimiter. and application. If Rename is set to true. FileName. History. application. rotation occurs when the duration of the log exceeds a specified length. History. Schedule.01.log.log is renamed application. <Schedule type="daily"></Schedule> If the type attribute is hh:mm. Rename . Schedule. If Rename is set to false. This occurs until the maximum history setting is reached. <Schedule type="hh:mm"></Schedule> If the type attribute is duration.log (and so on) when it is time to rotate the log files.01. the server rotates the log files every 24 hours. Time. <Schedule type="duration"></Schedule> See also MaxSize.5 CONFIGURATION AND ADMINISTRATION GUIDE 139 XML configuration files reference Example <QuoteFields>disable</QuoteFields> See also LogServer.log is renamed application. Rename Schedule Specifies the rotation schedule for the log files. The log file with the lowest version number keeps the oldest log history.Last updated 3/2/2010 FLASH MEDIA SERVER 3.

or local. Flash Media Administration Server and the active cores communicate over ACCP. see the Server. the value of the ServerID element is the IP address of the server whose events are being logged. SocketOverflowBuckets . The default is local time. Example <ServerID>xxx. The elements nested within the Access container configure the Access log settings.xml file affect the entire server unless they are overridden in another configuration file. Scope ACCP Container element. See also Logging Server. The elements nested within the ACCP container configure the Admin Core Communication Protocol (ACCP). Valid values are utc.5 CONFIGURATION AND ADMINISTRATION GUIDE 140 XML configuration files reference ServerID By default.xml file is located at the root level of the conf directory.xxx.xml file The Server. MaxIOThreads. which in turn connects to Flash Media Server.xxx:1234</ServerID> See also HostPort. The Flash Media Administration Console connects to Flash Media Administration Server. SocketTableSize. The Access logs are located in the RootInstall\logs directory. Edits made in the Server. This protocol is also used for collecting performance metrics and issuing administrative commands to Flash Media Server cores.xml. The setting for the Time element can be used to override the server-wide configuration.xxx. DisplayFieldsHeader Time The Timefield in a log file can be logged either in UTC (GMT) or local time. Contained elements Enable.Last updated 3/2/2010 FLASH MEDIA SERVER 3. To see the element structure and default values in Server. Contained elements MinIOThreads. Access Container element.xml file installed with Flash Media Server in the RootInstall/conf/ directory. gmt.

and other licensed limits. SocketOverflowBuckets AdminElem Specifies the format used to display an element name in an HTTP command. set the AdminElem element to true. 10. domain names. This potential security risk can be managed by the Allow element. The elements nested within the Admin container configure the RTMP (Real-Time Messaging Protocol) for the fmsadmin process. AdminElem.1. Example <AdminElem>true</AdminElem> See also Process. and full or partial IP addresses. The getActiveVHostStats()command allows administrators to query the statistics information for all active virtual hosts.Last updated 3/2/2010 FLASH MEDIA SERVER 3.com.133. The keyword all can also be used. Permissible administrator connections are detailed as a comma-delimited list of host names. 10. To display <elem name="x"> instead of <_x> in the HTTP command. a client can connect to Flash Media Administration Server from any domain or IP address. SocketTableSize. SocketGC. Order. Contained elements RTMP (AdminServer). See also Process. Mask. Allow. connection.60</Allow> . Select a profile to determine bandwidth.5 CONFIGURATION AND ADMINISTRATION GUIDE 141 XML configuration files reference ActiveProfile Specifies the limits enforced by the server on each license key (set in the LicenseInfo element).60. which means the element name is displayed as <_x>. Deny. Deny. foo. Allow. The default value is false. Contained elements MinIOThreads. LicenseInfo Admin Container element. Order AdminServer Container element. RTMP is the protocol used for communication between Flash Player and Flash Media Server. The elements nested within the AdminServer container configure Flash Media Administration Server.com. Example <Allow>x.foo. MaxIOThreads. The getActiveVHost() command lists only the active virtual hosts. HostPort. Process. otherwise the element name is displayed as <elem name="x">. By default. CrossDomainPath Allow Specifies the administrator connections that are to be accepted.

Last updated 3/2/2010 FLASH MEDIA SERVER 3. set this value to true. increase the AudioAutoBufferReadSize buffer. the server does not stream any AAC audio profiles that are not supported by Flash Player 10. Contained elements Enable ApplicationGC Specifies in minutes how often the server checks for and removes unused application instances. The Enable element nested within the Application container enables the Application log file. Order AllowAnyAACProfile By default. the server does not stream any H. An application is considered idle if it has no clients connected for longer than the amount of time specified in MaxAppIdleTime in Application. To override this behavior. For example. Caching data allows the server to make fewer disk reads and to perform better. video. The default value is 5. if you are delivering audio-only content. . This lag allows the server to sort timestamps before flushing the buffer to disk when video is delayed. To override this behavior.5 CONFIGURATION AND ADMINISTRATION GUIDE 142 XML configuration files reference or <Allow>all</Allow> See also Deny. which is also the minimum value for this element. set this value to true. and decrease the VideoAutoBufferReadSize buffer. and other data in memory. Application Container element.xml. See also Playback AllowedVideoLag The number of seconds the server holds audio messages in the recording buffer while waiting for a video message. You can tune the size of each cache. to achieve better disk performance. audio. AudioAutoBufferReadSize The server caches F4V/MP4 video. The default interval is 5 minutes. See also Playback AllowAnyAVCProfile By default. Each data type (audio.264 video profiles that are not supported by Flash Player 10. and other) has its own cache. depending on the type of content you are delivering.

xml values. the feature is disabled. Use AutoCloseIdleClients to specify how often the server should check for idle clients.xml configuration file apply to all clients connected to the server. the values defined in the Vhost.xml file. you must enable the feature in the Server. A client is active when it is sending or receiving data.xml values override the Vhost. The default value is 51200 bytes. The Enable element nested within the AuthEvent container enables the logging of events from the Authorization plug-in.xml values. the server sends a status message to the NetConnection object (the client). The server also writes a message such as “Client x has been idle for y seconds” in the core and event logs.xml. you can disable the feature for individual virtual hosts in the Vhost. Contained elements Enable AuthMessage Container element.xml files or for individual applications in Application. Determines whether or not to automatically close idle clients. The Vhost. If the enable attribute is omitted or set to false.xml file. unless values are defined in the Application. Once you enable the feature in the Server. The Application. (Subsequently. Contained elements AuthMessage AutoCloseIdleClients Container element.xml values override the Server. The values defined in the Server. unless the values are defined in the Vhost. OtherAutoBufferReadSize AuthEvent Container element.xml configuration file apply to all clients connected to the virtual host. When a client has been idle longer than the maximum idle time (60 seconds by default). The default value is false.) Example <AutoCloseIdleClients enable="false"> <CheckInterval>60</CheckInterval> <MaxIdleTime>600</MaxIdleTime> </AutoCloseIdleClients> Contained elements CheckInterval. To configure the closing of idle connections.xml file. See also VideoAutoBufferReadSize. The server closes the client connection to the server and writes a message to the access log. The Enable element nested within the AuthMessage container enables the logging of messages from the Authorization plug-in. MaxIdleTime . Set the enable attribute to true to close idle clients.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml file.5 CONFIGURATION AND ADMINISTRATION GUIDE 143 XML configuration files reference The minimum size is 1024 bytes.

LogInterval Connector Container element.xml files.xml file. in seconds.Last updated 3/2/2010 FLASH MEDIA SERVER 3. RTMP (Connector) Content Enables operations in the current File plug-in on content (streams or SWF files). The following are available as checkpoint events: connect-continue. The elements nested within the Connector container configure the connector subsystem. Checkpoint events log bytes periodically from the start to the end of an event. play-continue. Example <CheckInterval>60</CheckInterval> See also Checkpoints Checkpoints Enables logging checkpoint events. Contains elements that configure the cache setting for SWF verification. You must enable checkpoint events at the server level in the Server. Contained elements CheckInterval. UpdateInterval (Cache) CheckInterval Specifies the interval. and publish-continue. The minimum and default value is 60 seconds.5 CONFIGURATION AND ADMINISTRATION GUIDE 144 XML configuration files reference Cache Container element. You can also override the logging interval at the vhost and application levels. You can disable checkpoints at the vhost and application level in the Vhost. Contained elements HTTP. .xml and Application. See also TTL. This element contains the enable attribute which you can set to true or false. Set the enable attribute to true to turn on checkpoint events in logs. A shorter interval results in more reliable disconnection times. A client is disconnected the first time the server checks for idle connections if the client has exceeded the MaxIdleTime value. at which the server checks for active client connections. The default value is false. Flash Media Server provides connectors that allow application scripts to connect to other Flash Media Servers or HTTP servers. The value of true enables the operation on the specified content type and false disables it. but can also result in decreased server performance.

The elements nested within the Core container configure the RTMP protocol for the FMSCore. for detecting unresponsive cores. Example <CoreGC>300</CoreGC> See also CoreExitDelay CoreTimeout Specifies the timeout value.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Enable if you plan to use the File plug-in to retrieve SWF files for verification by the server. in seconds. This element is nested within the FilePlugin tag. SocketTableSize. Example <Content type="Streams">true</Content> <Content type="SWF">false</Content> See also FilePlugin Core Container element. . The default wait time is 20 seconds. A value of 0 disables the timeout check.exe process. Contained elements MinIOThreads.5 CONFIGURATION AND ADMINISTRATION GUIDE 145 XML configuration files reference This element contains the type attribute. which you can set to the following values: • • Streams. an idle core is given to exit on its own before it is removed from the server. in seconds. Enabled by default. The default timeout is 30 seconds. Disabled by default. MaxIOThreads. SWF. Example <CoreExitDelay>60</CoreExitDelay> See also CoreGC CoreGC Specifies how often. to check for and remove idle or unused cores. SocketOverflowBuckets CoreExitDelay Specifies how much wait time. The default is 300 seconds. Enables stream file operations. in seconds. Enables operations on SWF files.

or the keyword all. Order Diagnostic Container element. Example <Deny>x. Contained elements Enable . Example <CPUMonitor>1</CPUMonitor> See also ResourceLimits CrossDomainPath Specifies an absolute path on the server to a cross-domain file. The connections are specified as a comma-delimited list of host names.60.133. Example <CrossDomainPath>C:/Security/config/files/fms/crossdomain. The Enable element nested within the Diagnostic section enables the diagnostic log file. The value cannot be set to less than 1 second.com. The default interval is 1 second. domain names. 10. 10.60</Deny> or <Deny>all</Deny> See also Allow.foo. foo. how often the server monitors CPU usage.5 CONFIGURATION AND ADMINISTRATION GUIDE 146 XML configuration files reference Example <CoreTimeout>30</CoreTimeout> See also CoreGC CPUMonitor Specifies.xml</CrossDomainPath> Deny Specifies administrator connections that should be ignored.com. This element lets you specify a list of domains from which a client can access the server. and full or partial IP addresses. Use it for both edge and administration server requests. which allows clients from all domains to access the server.Last updated 3/2/2010 FLASH MEDIA SERVER 3. This element is nested within both the Server element and the AdminServer element. in seconds.1. The default value is *.

The directory containing the web server. The parent folder is specified in the SWFFolder element. The default value is Apache2. Specifying zero scans the parent folder and no subfolders. The elements nested within the ECCP container configure ECCP (Edge Server-Core Server Communication Protocol). Contained elements MinIOThreads. .Last updated 3/2/2010 FLASH MEDIA SERVER 3. MaxIOThreads. Contained elements MinIOThreads.5 CONFIGURATION AND ADMINISTRATION GUIDE 147 XML configuration files reference Directory Located in the Httpd container. SocketOverflowBuckets Edge (ResourceLimits) Container element. SocketTableSize. Contained elements MaxEventQueueThreads. MaxIOThreads. Flash Media Server edge processes and Flash Media Server core processes use ECCP to migrate socket connections and to proxy connections that have not been migrated. Specifying a negative value scans all subfolders. See also SWFFolder ECCP Container element. CoreTimeout Edge Container element. SocketTableSize. The elements nested within the Edge container configure resources for the fmsedge process. Specifying a positive value scans that number of subfolders. SocketOverflowBuckets. The elements nested within the EdgeCore container control the IPC (interprocess communication) message queue used by edge and core processes to communicate with each other. NumSchedQueues EdgeCore Container element. which means that the server scans only one subfolder level. The default value is 1. DirLevelSWFScan Specifies the number of levels of subfolders within a parent folder to scan for SWF files.2. The elements nested within the Edge container configure the RTMP protocol for the fmsedge process. MinEventQueueThreads.

xml uses Enable elements in the Logging container to enable or disable the Access. Example <Access> <enable>true</Enable> </Access> See also Access. MaxQueueSize Enable Server.5 CONFIGURATION AND ADMINISTRATION GUIDE 148 XML configuration files reference Contained elements HeapSize. FileCheckInterval Located in the FLVCache container.and FileIO logs. AuthEvent. . Application. A very large number means the server does not refresh the cache even when there is a file change. There is no maximum value. A value of true enables the logging process. AuthEvent. how often the server reloads the video segment in the cache when there is a file change. Specifies. Diagnostic.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Example <FileCheckInterval>120</FileCheckInterval> FileIO Container element. This element contains elements to configure file operations that are handled by the File plug-in. The Enable element nested within the FileIO container enables logging from the File plug-in. AuthMessage. The default value is true. The minimum value is 1 second. AuthMessage. The default value is true. Note: This setting applies to playback of MP4/F4V files only. Aggregating messages increases server performance. false disables the logging process. Contained elements Enable FilePlugin Container element. Diagnostic. Setting the enabled attribute to false disables the File plug-in. Do not change this value if you want to achieve the highest possible server performance. Application. FileIO EnableAggMsgs Located in the Playback container. in seconds. The default value is 120 seconds.

The recorded media cache size is specified as a percentage of the total available RAM on the system. the freed memory returns to the global pool. The minimum value is 1 minute. If you are receiving “cache full” events in the core log file or want to increase the chance that streams will find the information needed in the cache.5</FreeMemRatio> FreeRatio Located in the MessageCache.5 CONFIGURATION AND ADMINISTRATION GUIDE 149 XML configuration files reference Contained elements MaxNumberOfRequests. decrease the size of the cache. Specifies how often. in which case virtual memory will also be used. Example <FreeMemRatio>0. MaxSize (FLVCache). MaxKeyframeCacheSize FLVCachePurge Located in the ResourceLimits container. The range of this setting is from 0 (0%) to 1 (100%). Specifies the maximum size of the recorded media cache. the default value of 60 is used.5 (50%). to remove unused files from the cache. The default value is 60 minutes. FLVCacheSize Located in the ResourceLimits container. If you specify a value of less than 1minute. Specifies the maximum percentage of total memory that the total pool size may occupy. The default setting for the cache size is 10 (10%).Last updated 3/2/2010 FLASH MEDIA SERVER 3. Use this setting to configure the cache for optimal memory use.125 (12. The default setting is 0. and SegmentsPool containers. SmallMemPool. Example <FLVCacheSize>10</FLVCacheSize> FreeMemRatio Located in the MessageCache. The maximum setting is 100 (100%). The default setting is 0. Contained elements FileCheckInterval. To minimize the amount of memory used in the server process. SmallMemPool. . Content FLVCache Container element. When more free memory is available to a thread than the specified ratio. increase the size of the cache.5%). and SegmentsPool containers. Specifies the percentage of the message cache to be consumed by the free list on a per-thread basis. Contains elements that control the size and features of the recorded media cache. The range of this setting is from 0 (0%) to 1 (100%). in minutes. LargeMemPool. LargeMemPool.

The default is 60 minutes.4</GlobalRatio> HandleCache Container element. and SegmentsPool containers. the freed memory returns to the operating system. The default setting is 0. Specifies the group ID of the process.Last updated 3/2/2010 FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 150 XML configuration files reference Example <FreeRatio>0.4 (40%). Contains elements that configure how to cache handles used for HTTP requests. See also UID GlobalQueue Container element. Specifies the percentage of the message cache to be consumed by the free list on a global basis. When more free memory is available to a thread than the specified ratio. GCInterval . MaxQueueSize GlobalRatio Located in the MessageCache. Example <GCInterval>60</GCInterval> GID Located in the Process containers. SmallMemPool. TrimSize. Contained elements MaxSize (HandleCache). If you do not specify a UID or GID. Specifies in minutes how often to remove idle handles. This element is applicable to Flash Media Server running on Linux systems only. The elements nested within the GlobalQueue container control the IPC message queue used by all processes to communicate with each other. This section is used for connections to Flash Remoting. LargeMemPool. Contained elements HeapSize. Example <GlobalRatio>0. the server or Administration Server runs as root. The range of this setting is from 0 (0%) to 1 (100%). IdleTime.125</FreeRatio> GCInterval Located in the HandleCache container.

Only one port number may be specified in this element. The default is to bind to any available IP on port 1111. which in turn connects to Flash Media Server. they are connecting to Flash Media Administration Server. Example <HostPort>ip:port</HostPort> See also AdminServer HTTP Container element. When administrators connect to the server with the Administration Console.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Default Value 0 >0 >0 -1 -2 Description Allocates the default number of threads. Allocates 2xN threads. Container EdgeCore GlobalQueue Services Default Value 1024 2048 2048 Description If the maximum size of this element is not specified. The elements nested within the HTTP container configure the HTTP connector used to connect to Flash Remoting. The Administration Service is separate from Flash Media Server. Allocates the exact number of threads specified. Allocates 1xN threads. of the shared memory heap used for an IPC (interprocess communication) message queue. the value is 100 KB. The following reference table gives the default values for all thread configurations.5 CONFIGURATION AND ADMINISTRATION GUIDE 151 XML configuration files reference HeapSize Specifies the maximum size. Associates the default value with the number (N) of processors. in kilobytes. The default value for this element varies according to its container. Example <EdgeCore> <HeapSize>1024</HeapSize> </EdgeCore> See also MaxQueueSize HostPort Specifies the IP address and port number that Flash Media Administration Server binds to. .

the SERVER. such as master to core. Contained elements GlobalQueue.HTTPD_ENABLED}". and Service elements to execute the following command lines: $Directory/$Program -d $Directory $Options -k start $Directory/$Program -d $Directory $Options -k stop Note: The value of $Directory can be absolute or relative to $FMSROOT. By default.Last updated 3/2/2010 FLASH MEDIA SERVER 3. When enabled is set to true. Contained elements Directory.5 CONFIGURATION AND ADMINISTRATION GUIDE 152 XML configuration files reference Contained elements MinConnectionThreads. Program. . or core to edge. Service specifies the name used to install the webserver as an NT service. Options.ini file. If no HTTP requests have been made to the host for the length of time specified. some cached handles are cleared.HTTPD_ENABLED variable is set to true in the fms. Flash Media Server uses IPC queues to send messages from one core to another or from one process to another. Flash Media Server starts and stops the web server automatically. The default value is localhost:11110. Unlike protocols. MaxConnectionQueueSize. MaxConnectionThreads. Example <IdleTime>10</IdleTime IpcHostPort The interface and port the server listens on internally for connections from the fmscore process to the Administration Server. Program. -n $Service is appended to both commands. If a value for Service is present. IPCQueues Container element. The default wait time is 10 minutes. queues are used for short or one-time messages that may have more than one target. Flash Media Server uses the settings in the Directory. On Windows only. EdgeCore. Options. Services LargeMemPool Container element. HandleCache Httpd Specifies how the built-in webserver is stopped and started. The elements nested within the IPCQueues container configure the IPC queues. By default the enabled attribute is set to "${SERVER. Service IdleTime Located in the HandleCache container. Specifies the amount of time to wait before releasing cached handles. Linux ignores this section of the command.

The default value is 3600 seconds (60 minutes). Localhost Specifies the IP loopback address. depending on the filename and the operating system.LICENSEINFO}</LicenseInfo> Note: Serial numbers that are added manually (that is. This value should be larger than the value for CheckInterval. added by editing those files directly) to either fms. The server must reference itself locally. may be in another language. Contained elements MaxCacheUnits. UpdateInterval. If the name of the recorded stream is in a language other than English. in seconds. MaxAge. FreeRatio. which caches large chunks of memory within the server to increase the performance of large allocations.Last updated 3/2/2010 FLASH MEDIA SERVER 3. GlobalRatio. the name is written in the log file in that language. LogInterval Specifies how often to log a checkpoint. however.LICENSEINFO}</LicenseInfo> LicenseInfoEx Contains license keys added using the Administration Console. Set the configuration properties of the individual log files in the Logger. even if the server is running on an English-language operating system. this value is a parameter in the fms. the columns x-sname and x-suri-stem show the name of the stream. Field names in the log file are in English. The IP loopback address is usually the default localhost address. See also Checkpoints Logging Container element. FreeMemRatio LicenseInfo The license number. For example. localhost can map to an erroneous interface. If the value is smaller.ini file: <LicenseInfo>${SERVER.xml file.xml file cannot be removed using the Administration Console. the server logs a checkpoint every check interval.5 CONFIGURATION AND ADMINISTRATION GUIDE 153 XML configuration files reference The elements nested within the LargeMemPool container configure the large memory pool. Example <LicenseInfo>${SERVER. in the access. With more than one network interface. Log files are written in English. Some content within the log file.log file. Only serial numbers that are added using the Administration Console can be deleted using the Administration Console. By default. MaxCacheSize. The server uses the default loopback address as the local loopback. MaxUnitSize. . The elements nested within the Logging container configure general logging properties for the server.ini or the LicenseInfo tag of Server.

000. See also Playback MaxAudioSampleDescriptions Located in the Recording container. By default. such as stream files or shared object files. Note: This setting applies to playback of MP4/F4V files only. AuthEvent. CoreExitDelay MaxAge Located in the MessageCache. RetrySleep. This element controls who has read/write access to shared object and stream files on the server. in kilobytes. AuthMessage. Contained elements CoreGC. the creation mask is set to 017 in octal. Therefore.000.5 CONFIGURATION AND ADMINISTRATION GUIDE 154 XML configuration files reference Contained elements Time. FileIO Mask A three-digit octal value used by the Linux umask (user permissions mask) command to set a file creation mask. the file created is assigned permission 0666 & ~022 = 0644 = rw-r--r--. This element defines the maximum reuse count before the cache unit is freed. SmallMemPool. This key is used by umask to set the file creation mask. Diagnostic. The default value is 64. Access. Application. . The default setting for this element is 017 in octal. This element is applicable to Flash Media Server running on Linux systems only. All Flash Media Server object files. RecordsNumber. LargeMemPool. are created on the server side with permission 0666. If the mask is set to 022. all Flash Media Server object files are created with permission 0666 & ~017 = 0660 = rw-rw----. and SegmentsPool containers. The elements nested within the Master container configure the resource limits for the master server.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The user must enter the mask in a three-digit octal format. Example <MaxAge>1000000</MaxAge> MaxAggMsgSize The maximum size of an aggregate message. Master Container element. RetryNumber. The owner and the users who belong to the same group as the owner get read/write permission to the files. The default count is 1.

SmallMemPool. Specifies the maximum number of connection requests that can be pending. MaxCacheSize Located in the MessageCache. For example. each listener has a limit of 10 connections per second. To use the default. Keep in mind that the number of free units may be less than maximum if the value of the MaxCacheSize limit is reached. This element defines the maximum number of free units in the cache.xml configuration file using the HostPort element under the HostPortList container element. However.5 CONFIGURATION AND ADMINISTRATION GUIDE 155 XML configuration files reference Each change in codec for a content type has a sample description. If the element is set to 10 connections per second. A value of 0 or -1 disables the feature. Connections requested at a rate above the value specified in this element remain in the TCP/IP socket queue and are silently discarded by the operating system whenever the queue becomes too long. the server imposes a maximum total combined rate of 30 connections per second.Last updated 3/2/2010 FLASH MEDIA SERVER 3. adding too many descriptions takes up unnecessary space for every file that the server records. and SegmentsPool containers. This element defines the maximum size of the cache in megabytes. The default number of pending requests is 1000. Example <MaxCacheUnits>4096</MaxCacheUnits> MaxConnectionQueueSize Located in the HTTP container. This is a global setting for all socket listeners. The socket listeners are configured in the Adaptor. LargeMemPool. and SegmentsPool containers. If there are three listeners and the MaxConnectionRate is set to 10. The default value is 10. . Note: This setting applies to recording MP4/F4V files only. Specifies the maximum number of incoming connections per second that the server’s socket listener accepts. The default is 100 MB. such as 12. You can set a fractional maximum connection rate. the server stops recording. If the codec type changes more than the number of available descriptions. The default is 4096 units. two different audio codecs each have their own sample description. LargeMemPool. Example <MaxConnectionQueueSize>-1</MaxConnectionQueueSize> MaxConnectionRate Located in the RTMP (Protocol) and Edge containers. Example <MaxCacheSize>100</MaxCacheSize> MaxCacheUnits Located in the MessageCache. SmallMemPool. Connection requests are rejected if this limit is exceeded. specify -1. The server allocates space for sample descriptions when it creates a file.5.

The maximum number of ELST entries in a recording. To use the default. If the encoding format type changes more than the number of available descriptions. The default value is 5. MaxDataSampleDescriptions Located in the Recording container. The server uses ELST entries when there are gaps in content. The default value is -2. The maximum number of seconds to wait before flushing the recording buffer. the default number is 10. recording ends. specify 0. setting this value too high takes up unnecessary space in each recorded file. The maximum number of threads per scheduler queue. The default value is 100. The maximum number of kilobytes to accumulate before flushing the recording buffer. adding too many descriptions takes up unnecessary space for every file that the server records. specify 0. If the server is taking a long time to process connections. Note: This setting applies to recording MP4/F4V files only. MaxELSTEntries Located in the Recording container. To use the default. audio. the default number is 5. The minimum value is 1. MaxFlushSize Located in the RecBuffer container. For example. the server stops recording. For RTMP.5 CONFIGURATION AND ADMINISTRATION GUIDE 156 XML configuration files reference Example <MaxConnectionRate>100</MaxConnectionRate> MaxConnectionThreads Located in the HTTP and RTMP (Connector)containers. Note: This setting applies to recording MP4/F4V files only. raise the value of HTTP/MaxConnectionThreads to 20. The server allocates space for sample descriptions when it creates a file. Specifies the maximum number of threads used to process connection requests. However. The default value is 256. MaxEventQueueThreads Located in the Edge (ResourceLimits) container. Gaps occur during an append to the file or when video. The default value is 10. However. two different data encoding formats each have their own sample description.Last updated 3/2/2010 FLASH MEDIA SERVER 3. If more gaps or appends occur than the value specified in the MaxELSTEntries tag. The minimum value is 32. or data content ends while other such content continues. For HTTP. MaxFlushTime Located in the RecBuffer container. Each change in codec for a content type has a sample description. .

Core. A low value may cause unneeded disconnections. a user might leave the window to idle out. consider the type of applications running on the server. ECCP. Use 0 for the default value. in seconds. before a client is disconnected. the server uses 1200 seconds (20 minutes). This element is used in the verification of SWF files. Admin. Specifies the maximum number of threads that can be created for I/O processing. For example. Example <MaxInitDelay>5</MaxInitDelay> See also SWFVerification MaxIOThreads Located in the RTMP (Connector). if you have an application with which users watch short video clips. If you set a value of 60 or less. • A value greater than 0 allocates the exact number of threads specified. Use 0 for the default value. MaxInitDelay The maximum number of seconds that is used to process SWF files.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Container ACCP Admin Core ECCP Edge RTMP Default Value 10 10 10 10 10 32 Description Use 0 for the default value. Specifies the maximum idle time allowed. Use -1 for the default value. Edge. • A value less than 0 ties the number of connection threads to the number (N) of processors. When you configure this element. The default value for this element varies according to which container protocol it is nested within. Use 0 for the default value. The default value is 3600 seconds (60 minutes). Use the following information to configure all I/O and connection threads processing: • A value of 0 allocates the default number of threads (10). The default value is 5 seconds. and ACCP containers. and so on. Use 0 for the default value. as follows: • -1 means 1 x N threads.5 CONFIGURATION AND ADMINISTRATION GUIDE 157 XML configuration files reference MaxIdleTime Located in the AutoCloseIdleClients container. . • -2 means 2 x N threads. Flash Media Server can receive connections through various protocols.

If an application uses many large recorded media files. The default value is 16777216 (16 MB). (For more information. When messages are sent to a process that is not running. Once MaxNumberofRequests is reached. EdgeCore. which allows unlimited requests. Specifies the maximum number of keyframes in the cache for each recorded media file. If necessary. .xml file.5 CONFIGURATION AND ADMINISTRATION GUIDE 158 XML configuration files reference Example <RTMP> <MaxIOThreads>32</MaxIOThreads> </RTMP> MaxKeyframeCacheSize Located in the FLVCache container. Example <MaxKeyframeCacheSize>0</MaxKeyframeCacheSize> MaxNumberOfRequests Specifies the maximum number of pending requests to the File plug-in. the cache uses less memory. the number of pending requests increases up to the value of MaxNumberofRequests. MaxSampleSize The maximum allowable size of a sample in an F4V/MP4 file.) If you lower MaxKeyframeCacheSize. When the process starts again. the server generates keyframes that are saved in the cache. Use the MaxQueueSize element to limit the number of messages left in the pending queue. MaxQueueSize Located in the GlobalQueue. Services containers. You can increase this value up to 4GB if a file has larger samples. The default value is 2000 keyframes. you can use this value to identify problems with the File plug-in. By default. Specifies the maximum number of pending IPC messages in the queue. you may want to lower this number. Flash Media Server does not count the number of requests made to the File plug-in or responses returned from the File plug-in. The value is specified in kilobytes. When enhanced seeking is enabled. Limiting messages saves shared memory if the process never starts. subsequent requests are rejected.Last updated 3/2/2010 FLASH MEDIA SERVER 3. See also Playback MaxSize (FLVCache) Located in the FLVCache container. it picks up the messages. The default size is 100 KB. Adobe generally recommends keeping the default value of 0. The default value is 0. in kilobytes. see EnhancedSeek in the Application. If the plug-in does not respond to a request from the server. the message can be put in a pending queue for the process.

MaxUnitSize Located in the MessageCache. it can be the maximum number of handles that the operating system can support. The minimum value is 0. The maximum number of tracks allowed in a file. This element is disabled by default. While only one video. increase the value of MaxSize. decrease the value of MaxSize. There is no maximum value. To enable the element. Specifies the maximum gap in milliseconds between two adjacent messages when comparing the message timestamps with the real time. SmallMemPool. The higher the value. Example <MaxTimestampSkew>2</MaxTimestampSkew> MaxTracks Located in the Playback container. audio. The server logs a warning when the timestamps between two adjacent messages are bigger than the difference in real time plus the value set here for MaxTimestampSkew. the longer the data will be held in the buffer before written to disk. files with up to this many tracks can be parsed. The size of the cache limits the number of unique streams the server can publish. This value shares memory with the running process and has a limit of 2 GB in Windows and 3 GB in Linux. More than this amount is a file error. and SegmentsPool containers. The default value is 500 MB. Example <MaxSize>5120</MaxSize> MaxTimestampSkew Located in the RecBuffer container. To decrease the amount of memory the server process uses. the size of the recording buffer affects the play-while-record experience. which means that no handles are cached. and data track may be played. set the value to a positive number. . Specifies the maximum size to which the buffer can grow before messages are committed to file. Example <MaxSize>100</MaxSize> MaxSize (RecBuffer) Located in the RecBuffer container. To increase the probability that a requested stream will be located in the recorded media cache. Specifies the maximum number of handles to cache.5 CONFIGURATION AND ADMINISTRATION GUIDE 159 XML configuration files reference Specifies the maximum size of the recorded media cache in megabytes. A shorter buffer decreases latency between real-time and playback. LargeMemPool. When you add DVR functionality to an application.Last updated 3/2/2010 FLASH MEDIA SERVER 3. but hurts performance. The default value is 200 and the minimum value is 0. MaxSize (HandleCache) Located in the HandleCache container. The default value is 100 handles. The default value is 64.

The server allocates space for sample descriptions when it creates a file. of a memory chunk allowed in a memory pool. Example <MinConnectionThreads>0</MinConnectionThreads> MinEventQueueThreads Located in the Edge (ResourceLimits) container. However. GlobalRatio. MessageCache Container element. in kilobytes. UpdateInterval. The default size is 16 KB. . the server stops recording. To use the default. Flash Media Server has several memory pools (distinct from the recorded media cache) that hold memory in chunks.5 CONFIGURATION AND ADMINISTRATION GUIDE 160 XML configuration files reference Specifies the maximum size. For example. This setting ensures that chunks larger than MaxUnitSize are released to system memory instead of being held in the pool so that large memory chunks are available. If the codec type changes more than the number of available descriptions. For example. Example <MessageCache> <MaxUnitSize>16</MaxUnitSize> </MessageCache> MaxVideoSampleDescriptions Located in the Recording container. MaxCacheSize. MaxUnitSize. MaxAge. Specifies the minimum number of threads in the pool for I/O operations. Note: This setting applies to recording MP4/F4V files only. Contained elements MaxCacheUnits. Recycling them improves the server’s performance. The default value is 10. specify the value 0. The elements nested within the MessageCache container control how the message cache holds onto messages used by the system running Flash Media Server and keeps them in memory for reuse instead of returning them and requesting them from the operating system. if this tag is under the MessageCache tag. The default is 1 multiplied by the number of processors. Messages are the essential communication units of Flash Media Server. adding too many descriptions takes up unnecessary space for every file that the records. two different video codecs each have their own sample description.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Each change in codec for a content type has a sample description. FreeRatio. the server doesn’t cache any messages greater than MaxUnitSize. FreeMemRatio MinConnectionThreads Located in the HTTP and RTMP (Connector) containers.

The default value for this element varies according to which container protocol it is nested within. Use 0 for the default value. The default value of 0 accepts current and all future versions. Use -1 for the default value. The element specifies the minimum number of threads that can be created for I/O operations. The default value is 2. Container ACCP Admin Core ECCP Edge RTMP Default Value 2X number of processors 2X number of processors 2X number of processors 2X number of processors 2X number of processors 2X number of processors Description Use 0 for the default value. Use 0 for the default value. Contained elements Playback. Use 0 for the default value. Use 0 for the default value. F4V. Admin.Last updated 3/2/2010 FLASH MEDIA SERVER 3. MOV. Flash Media Server can receive connections through various protocols. Edge.5 CONFIGURATION AND ADMINISTRATION GUIDE 161 XML configuration files reference The minimum number of threads per scheduler queue. The Mp4 elements configure how the server plays and records MP4. MinGoodVersion Located in the SWFVerification container. and ACCP containers. . The default interval for checking and removing content is 60 seconds. MsgPoolGC Specifies how often the server checks for content in and removes content from the global message pool. Recording. Example <ECCP> <MinIOThreads>0</MinIOThreads> </ECCP> Mp4 Container element. Example <MinGoodVersion>0</MinGoodVersion> MinIOThreads Located in the RTMP (Connector). ECCP. and other MP4 file types. Core. Specifies the minimum accepted version of SWF verification feature that the server allows.

Options Located in the Httpd container. The default value is 1024 bytes. and other data in memory. Specifies the order in which to evaluate the Allow and Deny elements. Example <NumCRThreads>0</NumCRThreads> NumSchedQueues Located in the Edge (ResourceLimits) container. to achieve better disk performance. Example <NetworkingIPv6 enable="false" /> NumCRThreads Located in the RTMP (Connector) container. You can tune the size of each cache. if desired.5 CONFIGURATION AND ADMINISTRATION GUIDE 162 XML configuration files reference NetworkingIPv6 Enables or disables Internet Protocol version 6 (IPv6). Flash Media Server automatically detects the operating system configuration. This is an empty tag. this element can force Flash Media Server to use IPv4 even if IPv6 is available. set: <Order>Allow. The number of scheduler queues. Specifies the number of completion routine threads in Windows 32-bit systems for edge server I/O processing. The operating system network stack should be configured to support IPv6. set: <Order>Deny. depending on the type of content you are delivering. The server caches F4V/MP4 video. Specifies additional switches for the command-line argument that starts and stops the web server. Deny</Order> OtherAutoBufferReadSize Located in the Playback container. Each data type (audio. The minimum size is 1024 bytes. video. audio. Order Located in the AdminServer container. and other) has its own cache.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The default value is 1.Allow</Order> To process the request if in <Allow> and not in <Deny>. . Example To process the request if not in <Deny> or in <Allow>. Caching data allows the server to make fewer disk reads and to perform better.

the server runs as root. The default value is bin/httpd. GID ProcVMSizeMonitorInterval The monitoring interval for process virtual memory use. after the ProcVMSizeWarn threshold has been triggered. MaxTracks. in megabytes. Contained elements FilePlugin. in seconds. The elements nested within the Process element contain the UID and GID elements for all server processes. Program Located in the Httpd container. AllowAnyAACProfile. AllowAnyAVCProfile Plugins Container element. Contained elements UID. OtherAutoBufferReadSize. MaxSampleSize. Protocol Container element. If you do not specify a value for UID and GID. ProcVMSizeNominal The log notification threshold for reverting to a nominal process virtual memory use. one for Flash Media Server and one for Flash Media Administration Server. There are 2 Process elements. all the server processes switch from root to the UID and GID. MOV. EnableAggMsgs. on Linux. UserDefined Process Container element. AudioAutoBufferReadSize. The Playback elements configure how the server plays back MP4. The default value is 1600.Last updated 3/2/2010 FLASH MEDIA SERVER 3. and other MP4 file types. F4V. MaxAggMsgSize.5 CONFIGURATION AND ADMINISTRATION GUIDE 163 XML configuration files reference Playback Container element. The location of the executable file for the web server. The elements are applicable to servers running on Linux systems only. The default value is 60. . The default value is 1800. The elements nested within the Plugins element configure plug-ins. For security reasons. in megabytes. Contained elements VideoAutoBufferReadSize. ProcVMSizeWarn The log warning threshold for high process virtual memory use.

Last updated 3/2/2010 FLASH MEDIA SERVER 3. Contained elements MaxSize (RecBuffer). RecBuffer Container element. The default value is 4096. follow these guidelines: • A value of 0 allocates the default number of threads (10). MaxTimestampSkew.The default value of -1 allows an unlimited number of records. To set the values of all I/O and connection threads processing. MaxAudioSampleDescriptions. If an attempt to open the log fails and the number of records in the queue is greater than or equal to this number. MaxDataSampleDescriptions. MaxFlushTime. MaxVideoSampleDescriptions RecordsNumber The number of records in the log queue. Larger buffers provide better performance for some use cases. The elements in this container configure those protocols and how the connection requests are received. AllowedVideoLag Recording Container element. A shorter buffer decreases latency between real-time and playback. • A value greater than 0 allocates the exact number of threads specified. Contained elements ACCP. Contains elements that configure the buffer for recording. RTMP (Protocol) PublicIP Specifies that if the system has more than two network ports. but hurts performance. the core process is shut down. .5 CONFIGURATION AND ADMINISTRATION GUIDE 164 XML configuration files reference Flash Media Server receives connections through various protocols. use this element to create a public IP address. Contained elements MaxELSTEntries. • A value less than 0 ties the number of connection threads to the number (N) of processors: • -1 means 1 x N threads • -2 means 2 x N threads. MaxFlushSize. The Recording elements configure how the server records F4V/MP4 file types. etc. the size of the recording buffer affects the play-while-record experience. in kilobytes. However. ReadBufferSize The size of the largest I/O read buffers that the server uses. When you add DVR functionality to an application. larger buffers use more memory. ECCP.

Contained elements RTMPE RTMP (Connector) Container element. Relevant when opening a log file fails. The elements nested within the ResourceLimits container specify the maximum resource limits for the server. SmallMemPool. FLVCache.ProcVMSizeNominal. including the HTTP and RTMP protocols. ApplicationGC. RTMP is the protocol used for communication between Flash Player and Flash Media Server. Relevant when opening a log file fails. The following reference table lists the default values for all thread configurations. Connector.5 CONFIGURATION AND ADMINISTRATION GUIDE 165 XML configuration files reference ResourceLimits Container element. ThreadPoolGC. CPUMonitor. IPCQueues. SegmentsPool. RetrySleep Number of milliseconds the server waits before retrying to open a log file. This container holds the elements that configure RTMP (Real-Time Messaging Protocol) for communication between Flash Remoting and Flash Media Server. Master RetryNumber Number of times to retry opening a log file. Contained elements FLVCachePurge. >0 .xml file. Root Container element. The default value is 0. MessageCache. FLVCacheSize. SSLSessionCacheGC. Protocol. MsgPoolGC. The Root element is a container for all the other elements in the Server. SocketGC. This container holds elements that configure which versions of RTMP can be used to connect to the Administration Server. The default value is 100 ms. ProcVMSizeMonitorInterval. LargeMemPool. Default Value 0 Description Allocates the default number of threads (10).Last updated 3/2/2010 FLASH MEDIA SERVER 3. RTMP (AdminServer) Container element. ProcVMSizeWarn. Allocates the exact number of threads specified. RecBuffer.

FreeMemRatio Server Container element. MaxUnitSize. Setting this element to false prohibits RTMPE and RTMPTE from being used. SocketRcvBuff RTMPE Located in the RTMP container. Contained elements Edge. which enables logging for all processes on the server. This container holds the elements that configure RTMP (Real-Time Messaging Protocol). MinConnectionThreads.) The default value is true. Allocates 1xN threads. Contained elements MinIOThreads. FreeRatio. Allocates 2xN threads. (RTMPE also covers RTMPTE. Contained elements MaxCacheUnits. This element determines whether to write a separate log file for each virtual host or to write one log file for the server. Admin. SocketSndBuf.Last updated 3/2/2010 FLASH MEDIA SERVER 3. MaxAge. MaxConnectionQueueSize RTMP (Protocol) Container element. MaxCacheSize. RTMP is the protocol used for communication between Flash Player and Flash Media Server. MaxConnectionThreads. UpdateInterval. The value for this element is server or vhost.5 CONFIGURATION AND ADMINISTRATION GUIDE 166 XML configuration files reference Default Value <0 -1 -2 Description Associates the default value with the number (N) of processors. Specifies whether Encrypted Real-Time Messaging Protocol (RTMPE) can be used to connect to the Administration Server. SegmentsPool Container element. MaxIOThreads. NumCRThreads. The default is server. The elements in this section configure how the segments pool caches segments of video files within Flash Media Server to increase performance of video streaming and keep frequently used video files in memory. . GlobalRatio. Core. Scope Located in the Logging container.

Mask. ReadBufferSize.com</ServerDomain> Service Located in the Httpd container. For security purposes. The server uses this value to set the hostname in the referrer header tag when making a net connection to a remote server.mycompany. MaxAge. which saves small chunks of memory in the server to increase performance of small allocations. FreeMemRatio SocketGC Located in the AdminServer and ResourceLimits containers. Streams. Process. GlobalRatio. MaxQueueSize SmallMemPool Container element. The elements in this section configure the small memory pool.5 CONFIGURATION AND ADMINISTRATION GUIDE 167 XML configuration files reference The elements nested within the Server element contains the elements that configure the server. The default value is 60 seconds. Services Container element. the server checks for and removes inactive sockets. If this element is empty the hostname field is empty in referrer header. UpdateInterval.global. If this element is not set. SWFVerification. some application servers require this information as a part of incoming connection requests. Contained elements NetworkingIPv6. AutoCloseIdleClients. LicenseInfoEx. MaxCacheSize. Specifies how often. FreeRatio. ResourceLimits. MaxUnitSize. AdminServer. The elements in this section control the IPC message queue used by the edge and core processes to communicate with each other. specifies the name used to install the webserver as an NT service. Logging. Example <SocketGC>60</SocketGC> . CrossDomainPath.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Httpd ServerDomain Specifies the host name (with the domain) of the server computer. LicenseInfo. Contained elements MaxCacheUnits. PublicIP. Plugins. On Windows only. Example <ServerDomain>mydomain. SSL. in seconds. Contained elements HeapSize. the host name field is not supplied in the referrer header. Localhost.

ECCP. Specifies the number of overflow buckets if all slots in the socket table are in use. The default value is 0. in bytes. The default number of buckets is 16. ACCP containers. Core. Contained elements SSLRandomSeed. The SSL elements in Server. Setting a high value significantly increases the amount of memory used by each client. in bytes. It is recommended that you do not explicitly set this value.xml configure the server to act as an SSL-enabled client by securing the outgoing connections. which tells the server to use the operating system default values. SSLClientCtx . Example <Admin> <SocketOverflowBuckets>-1</SocketOverflowBuckets> </Admin> SocketRcvBuff The size of the client socket receive buffer.5 CONFIGURATION AND ADMINISTRATION GUIDE 168 XML configuration files reference SocketOverflowBuckets Located in the Edge. ECCP. specify -1 to use the default number of buckets. Admin. Setting a high value significantly increases the amount of memory used by each client. which tells the server to use the operating system default values. SocketSndBuf The size of the client socket send buffer. Core. Specifies the size of the direct-access socket table for quick look-up. You should explicitly set this value only if you have a very high bandwidth connection that requires a large socket buffer. ACCP containers.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Admin. It is recommended that you do not explicitly set this value. The default value is 0. Example <Admin> <SocketTableSize>-1</SocketTableSize> </Admin> SSL Container element. SSLSessionCacheGC. SocketTableSize Located in the Edge. Use -1 for the default value. You should explicitly set this value only if you have a very high bandwidth connection that requires a large socket buffer. The default size is 200.

• Each cipher string can be optionally preceded by the characters !. or cipher suites of a certain type. authentication method. Specifies the suite of encryption ciphers that the server uses to secure communications. For example. SHA1+DES represents all cipher suites containing the SHA1 and DES algorithms. or +. Commas or spaces are also acceptable separators. For example. • It can represent a list of cipher suites containing a certain algorithm. but colons are normally used. block low-strength ciphers. This element is a colon-delimited list of encryption resources. File names must be the hash with “0” as the file extension. This option doesn't add any new ciphers—it just moves matching existing ones. there are special keywords and prefixes. The default cipher list instructs the server to accept all ciphers.Last updated 3/2/2010 FLASH MEDIA SERVER 3. or one of a selected number of aliases for common groupings. then the ciphers are deleted from the list. For example.initialize from the command line. then the ciphers are permanently deleted from the list. Each file in the directory must contain only a single CA certificate. but some or all of the ciphers can be added again later. but block those using anonymous Diffie-Hellman authentication. Specifies the name of a directory containing CA certificates.is used. . In addition. • If + is used. • If . SSLCipherSuite Located in the SSLClientCtx container. • It can consist of a single cipher suite. encryption method. The cipher list consists of one or more cipher strings separated by colons. attempts are made to find CA certificates in the certs directory located at the same level as the conf directory. SSLCACertificatePath Located in the SSLClientCtx container. and SSLv3 represents all SSL v3 algorithms. such as a key-exchange algorithm. then the ciphers are moved to the end of the list. The ciphers deleted can never reappear in the list even if they are explicitly stated. such as RC4-SHA. block export ciphers. The string of ciphers can take several different forms. -. • If ! is used.console . digest type.5 CONFIGURATION AND ADMINISTRATION GUIDE 169 XML configuration files reference SSLCACertificateFile Located in the SSLClientCtx container. Important: Contact Adobe Support before changing the default settings. Each item in the cipher list specifies the inclusion or exclusion of an algorithm or cipher. For Win32 only: If this element is empty. Specifies the name of a file that contains one or more CA (Certificate Authority) digital certificates in PEM (Privacy Enhanced Mail) encryption format. block MD5 hashing. The Windows certificate store can be imported into this directory by running FMSMaster . SHA1 represents all cipher suites using the digest algorithm SHA1. and the prefix ! removes the cipher from the list. • Lists of cipher suites can be combined in a single cipher string using the + character as a logical and operation. the keyword ALL specifies all ciphers. and sort ciphers by strength from highest to lowest level of encryption.

Key exchange algorithm kRSA kDHr kDHd RSA DH EDH ADH Description Key exchange Diffie-Hellman key exchange with RSA key Diffie-Hellman key exchange with DSA key Ephemeral Diffie-Hellman key exchange RSA key exchange Ephemeral Diffie-Hellman key exchange Anonymous Diffie-Hellman key exchange Authentication methods aNULL aRSA aDSS aDH Description No authentication RSA authentication DSS authentication Diffie-Hellman authentication . <SSLCipherSuite>ALL:+SSLv2</SSLCipherSuite> The following is the complete list of components that the server can evaluate. <SSLCipherSuite>ALL:!ADH:!EDH</SSLCipherSuite> These cipher strings instruct the server to accept only RSA key exchange and refuse export or null encryption. <SSLCipherSuite>RSA:!NULL!EXP</SSLCipherSuite> <SSLCipherSuite>RSA:LOW:MEDIUM:HIGH</SSLCipherSuite> This cipher list instructs the server to accept all ciphers but place them in order of decreasing strength.5 CONFIGURATION AND ADMINISTRATION GUIDE 170 XML configuration files reference • If none of these characters is present. with the high being preferred.Last updated 3/2/2010 FLASH MEDIA SERVER 3. then the string is just interpreted as a list of ciphers to be appended to the current preference list. This sequencing allows clients to negotiate for the strongest cipher that both they and the server can accept. The components can be combined with the appropriate prefixes to create a list of ciphers. including only those ciphers the server is prepared to accept.and medium-strength encryption. in the order of preference. <SSLCipherSuite>ALL:+HIGH:+MEDIUM:+LOW:+EXP:+NULL</SSLCipherSuite> This string instructs the server to accept only high. • The cipher string @STRENGTH sorts the current cipher list in order of the length of the encryption algorithm key. Example This cipher string instructs the server to accept all ciphers except those using anonymous or ephemeral Diffie-Hellman key exchange. and reject export-strength versions. <SSLCipherSuite>ALL:+HIGH:!LOW:!EXP:!NULL</SSLCipherSuite> This string instructs the server to accept all ciphers but to order them so that SSLv2 ciphers come after SSLv3 ciphers. • If the list includes any ciphers already present. the server does not evaluate them. The server evaluates both strings as equivalent.

SSLCACertificateFile.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Configures the server to act as an SSL-enabled client by securing the outgoing connections.0 ciphers All ciphers using DSS authentication SSLClientCtx Container element. SSLCipherSuite SSLRandomSeed Located in the SSL container.0 ciphers All SSL version 3. Specifies how often to flush expired sessions from the server-side session cache. Example <SSLRandomSeed>ALL:!ADH:!EDH</SSLRandomSeed> . DES) 128-bit encryption Triple-DES encoding Digest types MD5 SHA1 SHA Description MD5 hash function SHA1 hash function SHA hash function Additional aliases All SSLv2 SSLv3 DSS Description All ciphers All SSL version 2. SSLCACertificatePath. Contained elements SSLVerifyCertificate.5 CONFIGURATION AND ADMINISTRATION GUIDE 171 XML configuration files reference Encryption methods eNULL DES 3DES RC4 RC2 IDEA NULL EXP LOW MEDIUM HIGH Description No encoding DES encoding Triple-DES encoding RC4 encoding RC2 encoding IDEA encoding No encryption All export ciphers (40-bit encryption) Low-strength ciphers (no export. SSLVerifyDepth.

Contained elements Mp4 SWFFolder Located in the SWFVerification container. specify false. Example The following example allows SWF files from either the C or the D directory to be authenticated: <SWFFolder>C:\SWFs. To disable certificate verification. Specifies how often to check for and remove expired sessions from the server-side session cache. Certificate verification is enabled by default. MOV. certificate verification fails. Use a semicolon to separate multiple directories. The default value is 9. and other MP4 file types.D:\SWFs</SWFFolder> .Last updated 3/2/2010 FLASH MEDIA SERVER 3. Example <SSLSessionCacheGC>5</SSLSessionCacheGC> SSLVerifyCertificate Located in the SSLClientCtx container. F4V. Specifies whether the certificate returned by the server should be verified. Specifies a folder containing SWF files that are verified to connect to any application on this server. Note: Disabling certificate verification can result in security problems. Specifies the maximum depth of the certificate chain to accept.5 CONFIGURATION AND ADMINISTRATION GUIDE 172 XML configuration files reference SSLSessionCacheGC Located in the SSL container. The Streams elements configure how the server plays and records MP4. Example <SSLVerifyCertificate>true</SSLVerifyCertificate> SSLVerifyDepth Located in the SSLClientCtx container. Example <SSLVerifyDepth>9</SSLVerifyDepth> Streams Container element. If a self-signed root certificate cannot be found within this depth.

2 (20%). The default setting is local.2</TrimSize> TTL Located in the Cache container. Specifies a percentage of cached handles to remove. Specifies the time field in a log file. Contains elements that configure how SWF files connecting to an application are verified. MaxInitDelay. Can be specified as a number between 0 and 1. MinGoodVersion. The default is CRLF (carriage return and line feed).Cache TerminatingCharacters Located in the Logging container. The default time is 20 minutes. . Specifies the final characters of each log entry in log files. Example <TerminatingCharacters>CRLF</TerminatingCharacters> ThreadPoolGC Located in the ResourceLimits container. The time field in a log file can be specified either as UMT (GMT) or local time. representing 0% to 100%.5 CONFIGURATION AND ADMINISTRATION GUIDE 173 XML configuration files reference SWFVerification Container element. Example <Time>local</Time> TrimSize Located in the HandleCache container. Example <ThreadPoolGC>25</ThreadPoolGC> Time Located in the Logging container. You cannot specify less than 20 minutes. Contained elements SWFFolder. Specifies in minutes how often Flash Media Server checks for and removes unused I/O threads. The default value is 0.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Example <TrimSize>0. DirLevelSWFScan.

For more information. video. UID Located in the Process containers. and decrease the VideoAutoBufferReadSize buffer. and other data in memory. The minimum size is 1024 bytes. if you are delivering audio-only content.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Each data type (audio. the server or Administration Server runs as root.com/go/learn_fms_pluginapi_en. The default value is 153600 bytes. Specifies the maximum time in minutes to wait for the server to scan the SWF folders for updates when there is a miss in the cache. The default value is every 1024 messages. Define elements within the UserDefined element to store data that File plug-ins and Authorization plug-ins can retrieve. The default value is 5 minutes. increase the AudioAutoBufferReadSize buffer. VideoAutoBufferReadSize Located in the Playback container. See also GID UpdateInterval Specifies how often thread statistics are collected. This element contains the server process user ID. The default value is 1440 minutes (24 hours). depending on the type of content you are delivering. This element is applicable to Flash Media Server running on Linux systems only. Example <UpdateInterval>1024</UpdateInterval> UpdateInterval (Cache) Located in the Cache container. The server caches F4V/MP4 video. For example. and other) has its own cache. see the getConfig() method in the Flash Media Interactive Server plug-in API Reference available at www. You can tune the size of each cache. Caching data allows the server to make fewer disk reads and to perform better. If you do not specify a UID or GID. audio. UserDefined Container element.5 CONFIGURATION AND ADMINISTRATION GUIDE 174 XML configuration files reference Specifies in minutes how long each SWF file remains in the SWF verification data cache. . to achieve better disk performance.adobe.

However. Whenever possible. 10.60</Allow> See also Password. see the Users. they are connecting to Flash Media Administration Server.com. You can authorize an administrator to use multiple HTTP commands for access by creating a comma-separated list of the commands. Edit this file to set permissions for Administration API calls to Flash Media Administration Server.60. Example <Allow>foo. adobe. When administrators use the Administration Console to connect to Flash Media Server. Example <Allow>foo.xml file installed with Flash Media Server in the RootInstall/conf/ directory. The HttpCommands container nested within the AdminServer container configures the access level to Flash Media Administration Server.133. Order (User) .yourcompany. The value All authorizes the administrator to use all HTTP commands. To see the element structure and default values.1.1. Deny (HTTPCommands). which in turn connects to the server.60.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 10.com.10. You authorize the administrator’s access by creating a comma-delimited list of the accessible host names or domain names and/or full or partial IP addresses.yourcompany.adobe.133. Edit this file to identify Flash Media Server administrators and set their access permissions.com. The Administration Service is separate from Flash Media Server.5 CONFIGURATION AND ADMINISTRATION GUIDE 175 XML configuration files reference Users. Adobe does not recommend this usage as it creates a security risk. The administrator can only connect to the server from those hosts specified in this Allow element.10.xm file is located at the root level of the RootInstall/conf directory.60</Allow> See also Enable. Contained elements HTTPCommands Allow (HTTPCommands) Lists the Flash Media Administration Server commands that the administrator can access using HTTP. use the IP addresses in the Allow element to improve the server’s performance when processing connection requests.com. AdminServer Container element. Order (HTTPCommands) Allow (User) Lists the specific hosts from which an administrator can connect to Flash Media Administration Server. Deny (User).xml file The Users.

133. This Deny element lists the Flash Media Administration Server commands that an administrator cannot use through HTTP.1. Setting this element enables HTTP requests to execute administrative commands.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Order (HTTPCommands) HTTPCommands Container element. This element lists those hosts from which the administrator is not authorized to connect to Flash Media Administration Server.10.com. <Deny>foo. . do not set this element.10.60</Deny> See also Password.adobe. Example <Deny>Deny. Deny (HTTPCommands).5 CONFIGURATION AND ADMINISTRATION GUIDE 176 XML configuration files reference Deny (HTTPCommands) Flash Media Server uses two elements named Deny: the Deny element in the User container and the Deny element in the HTTPCommands container. Example <Enable>true</Enable> See also Allow (HTTPCommands). To disable administrative access through the use of HTTP requests.60.com. Example This example lists the computers sending connection requests that Flash Media Administration Server will not accept.Allow</Deny> See also Enable.yourcompany. Order (HTTPCommands) Deny (User) Flash Media Server uses two elements named Deny: the Deny element in the User container and the Deny element in the HTTPCommands container. You restrict the administrator’s access by creating a comma-delimited list of those host names or domain names and/or (full or partial) IP addresses. Allow (User). You can deny an administrator the use of multiple HTTP commands to access the Administration Service by creating a comma-separated list of those HTTP commands. Allow (HTTPCommands). Order (User) Enable This element enables or disables the use of HTTP requests to execute administrative commands.

restart the server. Example The sequence Deny. When finished. Deny (HTTPCommands) Order (User) Flash Media Server uses two Order elements: one in the HTTPCommands container. and it is interpreted as an encoded string. the password you see in the file is the encrypted password. Passwords are usually encrypted. The default value is ping. Deny (HTTPCommands). Allow means that administrative access is allowed unless the user is specified in the Deny list of commands and not specified in the Allow list. Deny (User) Password Specifies the password for vhost administrators. Order (HTTPCommands) Order (HTTPCommands) Flash Media Server uses two Order elements: one in the HTTPCommands container and another in the User container. Example The default sequence Allow. Allow (HTTPCommands). In the following example. and the other in the User container.Allow</Order> See also Password. Passwords cannot be empty strings (""). the encrypt attribute instructs the server to encrypt the contents of the password. <Order>Deny.5 CONFIGURATION AND ADMINISTRATION GUIDE 177 XML configuration files reference This section contains the settings for those Flash Media Administration Server commands that can be accessed through HTTP. When the encrypt attribute is set to true. Deny means that administrative access is allowed unless the user is specified in the Allow list of commands and not in the Deny list: <Order>Allow.Deny</Order> The alternative sequence Deny.Allow</Order> The sequence Allow. . Allow (HTTPCommands). Specifies the order in which to evaluate the Deny and Allow commands.Deny</Order> See also Enable. <Order>Deny. Deny means the HTTP command is allowed if it is in the Allow list of commands and not in the Deny list. Specify each Administration API that may be called over HTTP in a commadelimited list.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Contained elements Enable. Specifies the sequence in which Flash Media Server evaluates the Allow and Deny elements for an administrator. <Order>Allow. Allow (User). Allow means the HTTP command is allowed if the command is in the Allow list of commands or not in the Deny list.

You can identify multiple administrators of a virtual host by creating a profile for each administrator.5 CONFIGURATION AND ADMINISTRATION GUIDE 178 XML configuration files reference Example <Password encryt="true"></password> See also Allow (User).xml file resides under a virtual host (to define administrators for that virtual host). Example <Root name="_defaultVHost_"> User This element identifies an administrator of the server. and other parameters.xml file. Deny (User). the location of the virtual host’s application directory. The Vhost.xml file contains elements that define the settings for the virtual host. If the Users.xml file The Vhost. The Root element is a container for all the other elements. Order (User) Vhost. Contained elements User. Example Use the name attribute to identify the login name of a Flash Media Server administrator: <User name="jsmith"></User> See also UserList UserList Container element. The UserList element defines and holds information about server administrators. Order (User) Root Container element. Allow (User).xml configuration file defines an individual virtual host.Last updated 3/2/2010 FLASH MEDIA SERVER 3. . Each virtual host directory on the server contains its own Vhost. Deny (User). These settings include aliases for the virtual host. then this tag must have its name attribute set to the name of the virtual host under which it resides. Password. limits on the resources the virtual host can use.

Example <Alias name="abc">abc. The default value is false.xml file installed with Flash Media Server in the RootInstall/conf/_defaultRoot_/_defaultVhost_ directory. Use the Alias element to shorten long host names. If a client application tries to connect to a virtual host that does not exist.5 CONFIGURATION AND ADMINISTRATION GUIDE 179 XML configuration files reference Each virtual host must have its own directory inside the adaptor directory. then the first match that is found is taken. Each adaptor must contain a _defaultVHost_ directory in addition to the custom virtual hosts that you define.Last updated 3/2/2010 FLASH MEDIA SERVER 3.com</Alias> If the name of this virtual host is “abc.com.com”. To see the element structure and default values in Vhost. the messages will be broken up before being cached.com”. Access Container element. such as streaming. An alias is an alternative short name to use when connecting to the virtual host. The Alias element lets you specify additional names to connect to this virtual host. you can only define one virtual host for the adaptor. then specify the alias abc. that specifies an IP address on the server computer.adobe. Example <AggregateMessages enabled="true" <MaxAggMsgSize>65536</MaxAggMsgSize>> </AggregateMessages> See also EdgeAutoDiscovery. The elements nested within the Access container configure the Access log settings. or if you want to be able to connect to this virtual host with different names.adobe. The name of the directory must be the actual name of the virtual host. You can avoid unexpected behavior by specifying a unique alias for each virtual host. in addition to _defaultVHost_. The Access logs are located in the RootInstall\logs directory.adobe. If you are using a secure port for the adaptor that contains the virtual host. Contained elements AggregateMessages Determines whether aggregate messages are delivered from the edge cache when the virtual host is configured as an edge server.xml. such as a WINS address or a hosts file. Each defined virtual host must be mapped to a DNS (domain name server) entry or another name resolution. the server attempts to connect it to _defaultVHost_. Keep in mind that abc must still map to the same IP address as “abc. . If more than one virtual host on the same adaptor has been defined with the same alias. RouteEntry Alias The Alias element specifies the assumed name(s) of the virtual host. see the Vhost. but you wish to connect by simply specifying “abc”.adobe. If the edge server receives aggregate messages from the origin when this setting is disabled.

.com</Allow> This example allows only connections from the adobe. the only connections allowed are those coming from the same domain. Contained elements AggregateMessages Allow This element is a comma-delimited list of domains that are allowed to connect to this virtual host. it may create a security risk. <Allow>localhost</Allow> This example allows localhost connections only. Both anonymous and explicit proxies intercept and aggregate the clients’ requests to connect to the origin server.yourcompany. If the Allow element is left empty.Last updated 3/2/2010 FLASH MEDIA SERVER 3.com domains. If enabled. <Allow>all</Allow> This example allows connections from all domains.com and yourcompany. edge autodiscovery is performed by default. You can specify an unlimited number of aliases by adding additional Alias elements. Examples <Allow>adobe.com. The default value is false. Here are some key differences between anonymous and explicit proxies: • The identity (IP address and port number) of an anonymous server is hidden from the client. WaitTime Anonymous Configures the virtual host as an anonymous proxy (also called an implicit or transparent proxy) or as an explicit proxy. The elements nested in this section list the alias(es) for this virtual host. The default value is all. Each Alias must map to the IP address of the virtual host.5 CONFIGURATION AND ADMINISTRATION GUIDE 180 XML configuration files reference See also AliasList AliasList Container element. See also Anonymous AllowOverride Specifies whether overriding edge autodiscovery is allowed by specifying the rtmpd protocol. Adobe does not recommend the use of all. Example <AllowOverride>true</AllowOverride> See also Enabled. Setting this element to true creates an implicit proxy to intercept the incoming URIs.

without modification. • The URI for a chain of explicit proxies directs all clients’ connection requests through a specific sequence of edge servers before making the connection to the origin server. MaxSharedObjects AppsDir Specifies the Applications directory for this virtual host. • The routing information in the URI for a chain of explicit proxies specifies the edge servers that are chained together to intercept connection requests to the origin server. • The URI for an explicit proxy specifies the edge server(s) that will intercept connection requests to the origin server.5\applications. MaxEdgeConnections. Streams. Note: If you use this tag to map to a network drive. such as Shared Objects. You can create a chain of proxies by specifying them in the URI. • The routing information in the URI for a chain of explicit proxies specifically identifies the sequence of edge servers in the chain. the routing information in the URI to the next edge server in the chain. You define an application by creating a subdirectory with the application name. The default interval is 1 minute. AggregateMessages AppInstanceGC Specifies how often to check for and remove unused resources for application instances. . RouteTable. MaxStreams. Example <AppInstanceGC>1</AppInstanceGC> See also MaxConnections. the default location is /opt/adobe/fms/applications. EdgeAutoDiscovery.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Example <Anonymous>falsetrue</Anonymous> See also Mode. MaxAppInstances. and Script engines. • The explicit proxy modifies the routing information in the URI by stripping off its token or identifier in the URI before passing the URI on to the next server in the chain. the default AppsDir location is C:\Program Files\Adobe\Flash Media Server 3. The Applications directory is the base directory where all applications for this virtual host are defined. • In Linux. • Any anonymous proxy in the chain passes on. LocalAddress. see “Mapping directories to network drives” on page 34 for additional information. • In Windows.5 CONFIGURATION AND ADMINISTRATION GUIDE 181 XML configuration files reference • The anonymous proxy does not change or modify the routing information in the incoming URI before connecting the client(s) to the origin server. CacheDir.

xml files or for individual applications in Application. Set the enable attribute to true to close idle clients. ResourceLimits.D:\NewApps</AppsDir> You can specify multiple applications directories by separating locations with a semicolon (. A client is active when it is sending or receiving data. the server sends a status message to the NetConnectionobject (the client). If the enable attribute is omitted or set to false.5 CONFIGURATION AND ADMINISTRATION GUIDE 182 XML configuration files reference Example 1 <AppsDir>C:\MyApps. To configure the closing of idle connections. you must enable the feature in the Server.). you can disable the feature for individual virtual hosts in the Vhost. You can specify two locations. MaxIdleTime CacheDir Container element. The values defined in the Vhost. If no location is specified for this element. When a client has been idle longer than the maximum idle time (60 seconds by default). . the feature is disabled. If you change the default location of the AppsDir element. The server also writes a message such as “Client x has been idle for y seconds” in the core and event logs. The Vhost. The Application. Example <AutoCloseIdleClients enable="false"> <MaxIdleTime>600</MaxIdleTime> </AutoCloseIdleClients> See also AppsDir. Use AutoCloseIdleClients to specify how often the server should check for idle clients. The server closes the client connection to the server and writes a message to the access log. Once you enable the feature in the Server.xml configuration file apply to all clients connected to the server. unless the values are defined in the Vhost. Determines whether or not to close idle clients automatically.swf) will be able to connect to the virtual host.xml file.xml.xml file.xml values override the Vhost.xml file.xml file. This ensures that the Administration Console (fms_adminConsole. unless values are defined in the Application. Example 2 The following example shows a mapping to a network drive: <AppsDir>\\myNetworkDrive\share\fmsapps</AppsDir> See also AliasList. The default value is false.xml configuration file apply to all clients connected to the Vhost. the values defined in the Server. the applications directory is assumed to be located in the vhost directory. Subsequently.xml values.Last updated 3/2/2010 FLASH MEDIA SERVER 3. each of which contains application subdirectories. be sure to include a directory named admin in each directory. VirtualKeys AutoCloseIdleClients Container element.xml values.xml values override the Server.

LogInterval DNSSuffix Specifies the primary DNS suffix for this virtual host. The default value is true.xml and Application. VirtualKeys. then this element is used as the domain suffix.xml file. especially for vod (video on demand) applications. This element contains the enable attribute which you can set to true or false. Set this element on an edge server or an intermediate origin server to control the caching behavior. An edge server may connect to another server that is part of a cluster. The default value of the enabled attribute is false. LocalAddress. ResourceLimits. Caching static content can reduce the overall load placed on the origin server. in addition to being cached in memory. . You can disable checkpoints at the vhost and application level in the Vhost. The useAppDir attribute determines whether to separate cache subdirectories by application. the edge server tries to determine which server in the cluster it should connect to (may or may not be the server specified in the URL). and publish-continue. each virtual host should point to its own cache directory. VirtualDirectory EdgeAutoDiscovery Container element. Contained elements CheckInterval. See also AliasList. Checkpoint events log bytes periodically from the start to the end of an event. The default value is false.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Contains elements that configure edge autodiscovery. The contents of the cache change. MaxSize See also RequestTimeout Checkpoints Enables logging checkpoint events. In this case. The following are available as checkpoint events: connect-continue. AppsDir.5 CONFIGURATION AND ADMINISTRATION GUIDE 183 XML configuration files reference This element enables or disables writing recorded streams to disk.xml files. If a server has multiple virtual hosts. Anonymous. RouteTable. play-continue. You can also override the logging interval at the vhost and application levels. Path. You must enable checkpoint events at the server level in the Server. If a reverse DNS look up fails to return the domain as part of the host name. Contained elements Mode. The edge server caches content locally to aid performance. This element controls whether the cached streams are written to disk. Set the enable attribute to true to turn on checkpoint events in logs.

45.com/go/learn_fms_content_en.0.play("vod/someMovie").9. For more information.9. it sends the server a string containing its platform and version information. it is served the stream c:\sorenson\someMovie. see the “Configuring content storage” section of the Configuration and Administration Guide at www.0" 6.0.virtualKey and Stream. you map virtual directories used in URLs to physical directories containing streams.9">B</Key> In the VirtualDirectory element.setVirtualPath() entries in the Server-Side ActionScript Language Reference.0">A</Key> 7. See also VirtualKeys .0. In the following example.0. see the Client. If Enabled is set to true.0. it is served the stream c:\on2\someMovie.0" to="WIN to="WIN to="MAC to="MAC 9. WaitTime Key When Flash Player connects to Flash Media Server. if a client with key A requests a stream with the URL NetStream. You can add Key elements that map Flash Player information to keys.9.0. <VirtualDirectory> <Streams key="A">vod. the edge server tries to determine to which server in a cluster it should connect.c:\on2</Streams> <Streams key="B">vod.5 CONFIGURATION AND ADMINISTRATION GUIDE 184 XML configuration files reference Example <EdgeAutoDiscovery> <Enabled>false</Enabled> <AllowOverride>true</AllowOverride> >WaitTime>1000</WaitTime> </EdgeAutoDiscovery> See also Enabled.9.0">A</Key> 7. Example <Enabled>false</Enabled> See also AllowOverride.0. If a client with key B requests a stream with the URL NetStream.adobe.45. The default value is false.flv.play("vod/someMovie").0.flv. WaitTime Enabled Specifies whether edge autodiscovery is enabled. the keys are A and B: <VirtualKeys> <Key from="WIN <Key from="WIN <Key from="MAC <Key from="MAC </VirtualKeys> 8.0. AllowOverride.9">B</Key> 9.c:\sorenson</Streams> </VirtualDirectory> Note: You can also set these values in a server-side script.Last updated 3/2/2010 FLASH MEDIA SERVER 3.0. The keys can be any alphanumeric value. For more information. In the following example.0" 6.0" 8.

the server logs a checkpoint every check interval. The default number is 15. This strategy is useful when configuring an edge to either transparently pass on or intercept requests and responses.000 application instances. See also Proxy Logging Container element. A chat application. in seconds. then outgoing connections bind to the value of the INADDR_ANY Windows system variable. for example. because each chat room represents a separate instance of the application on the server. .5 CONFIGURATION AND ADMINISTRATION GUIDE 185 XML configuration files reference LocalAddress This element binds an outgoing edge connection to a specific local IP address. A Flash SWF file defines which application instance it is connecting to by the parameters it includes with its ActionScript connect call. Contained elements LogInterval Specifies how often to log a checkpoint. might require more than one instance. The LocalAddress element lets you allocate incoming and outgoing connections to different network interfaces. (Aggregate messages must be enabled. If the LocalAddress element is not specified.536. Example <MaxAggMsgSize>66536</MaxAggMsgSize> See also AggregateMessages MaxAppInstances Specifies the maximum number of application instances that can be loaded into this virtual host. This value should be larger than the value for CheckInterval.Last updated 3/2/2010 FLASH MEDIA SERVER 3. See also MaxAggMsgSize Specifies the size in bytes of aggregate messages returned from the edge cache. Aggregate messages received directly from the origin server are returned as is and their size is determined by the origin server settings for aggregate message size. If the value is smaller. Contains elements that control logging. This setting only applies to messages retrieved from the disk cache.) The default size is 65. The default value is 3600 seconds (60 minutes).

Example <MaxConnections>-1</MaxConnections> See also MaxAppInstances. The default number is -1. MaxEdgeConnections. The default number of shared objects is 50.xml file overrides the value of the MaxIdleTime element in the Server. Example <MaxEdgeConnections>1</MaxEdgeConnections> See also MaxConnections. The maximum number of allowed connections is encoded in the license file. MaxStreams. which represents an unlimited number of connections. MaxSharedObjects. If no value is set for this element in the Vhost. MaxStreams. in seconds. MaxSharedObjects.5 CONFIGURATION AND ADMINISTRATION GUIDE 186 XML configuration files reference Example <MaxAppInstances>15000</MaxAppInstances> See also MaxConnections. A different value can be set for each virtual host.xml file. the server uses the value in the Server. This number is enforced by the license key. AppInstanceGC MaxIdleTime Specifies the maximum idle time allowed. . MaxEdgeConnections. The value for the MaxIdleTime element in the Vhost. MaxSharedObjects. The default idle time is 3600 seconds (60 minutes). the server uses the value 1200 seconds (20 minutes).xml file. AppInstanceGC MaxEdgeConnections Specifies the maximum number of connections that can remotely connect to this virtual host. AppInstanceGC MaxConnections Specifies the maximum number of clients that can connect to this virtual host. MaxStreams. Connections are denied if the specified limit is exceeded. Example <MaxIdleTime>3600</MaxIdleTime> See also AutoCloseIdleClients MaxSharedObjects Specifies the maximum number of shared objects that can be created.xml file.000. If you set a value lower than 60 seconds. MaxAppInstances.Last updated 3/2/2010 FLASH MEDIA SERVER 3. before a client is disconnected.

The default number of streams is 250.Last updated 3/2/2010 FLASH MEDIA SERVER 3. • If the Mode element is undefined. Example <MaxStreams>250000</MaxStreams> See also MaxConnections. A value of -1 specifies no maximum. the virtual host is evaluated as an alias for the default virtual host and assumes its configuration. • When the Mode element is set to local. The Mode element can be set to local or remote. The server does LRU (least recently used) cleanup of the cache to keep it under the maximum size. MaxStreams. EdgeAutoDiscovery Path Specifies the physical location of the proxy cache. By default. Relative paths are ignored and the server uses the default folder. A value of 0 disables the disk cache. • When the Mode element is set to remote. RouteTable. Flash Media Server runs its applications locally and is called an origin server. The default setting is local. the location is RootInstall/cache/.000. MaxSharedObjects. AppInstanceGC MaxSize Specifies the maximum allowed size of the disk cache. MaxAppInstances. MaxEdgeConnections. MaxAppInstances. the server behaves as an edge server that connects to the applications running on an origin server. CacheDir. AppInstanceGC Mode The Mode element configures whether the server runs as an origin server or as an edge server. in gigabytes. LocalAddress. Example <Mode>local</Mode> See also Anonymous. See also MaxStreams Specifies the maximum number of streams that can be created. The value must be an absolute path.5 CONFIGURATION AND ADMINISTRATION GUIDE 187 XML configuration files reference Example <MaxSharedObjects>50000</MaxSharedObjects> See also MaxConnections. The default value is 32 gigabytes. .

If no protocol is specified. content. SSL. Implicit proxies hide the routing information from the clients. . as demonstrated in the following examples. EdgeAutoDiscovery. in seconds. LocalAddress. however. AppInstanceGC. The RouteTable element contains the RouteEntry elements that control where the edge server reroutes requests. MaxStreams. The default value is 2 seconds. and so on. RouteEntry Instructs the edge server to forward the connection request to one server’s IP address and port number [host:port] to a different IP address and port number. it behaves locally as a remote server. See also CacheDir ResourceLimits Container element. MaxSharedObjects. MaxAppInstances. A request can be for metadata. the server waits for a response to a request from an upstream server. Examples This example shows how you can configure the edge to route all connections to the host foo to the host bar. Contained elements MaxConnections. RouteTable. Contained elements Mode. CacheDir. If this virtual host is configured to run in remote mode and you want to configure the properties of an outgoing SSL connection to an upstream server. This value -1 specifies an unlimited amount of time (no timeout). Note: Whenever a virtual host is configured as an edge server.xml file.5 CONFIGURATION AND ADMINISTRATION GUIDE 188 XML configuration files reference See also Proxy Container element. The elements in this section specify the maximum resource limits for this virtual host. MaxEdgeConnections. the SSL connection to upstream servers will use the default configuration specified in the SSL section of the Server. The elements nested in this section configure this virtual host as an edge server that can forward connection requests from applications running on one remote server to another server. Edge servers are configured with the RouteEntry element to direct connections to another destination. The connection syntax for this element is flexible. You can also add the protocol attribute to an individual RouteEntry element to specify how the edge server reroutes requests. RequestTimeout RequestTimeout The maximum amount of time.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Anonymous. AggregateMessages. Flash Media Server applies the protocol specified in the RouteTable element.

the outgoing connection will not be secure. <RouteEntry>*:*. Administrators use these elements to route connections to the desired destination.null</RouteEntry> See also RouteTable RouteTable Container element. • Specifying rtmp instructs the edge not to use a secure outgoing connection. or rtmps for a secure connection.Last updated 3/2/2010 FLASH MEDIA SERVER 3. You can override the security status for a connection mapping by specifying a protocol attribute in a RouteEntry element. The RouteTable element can be left empty or it can contain one or more RouteEntry elements.5 CONFIGURATION AND ADMINISTRATION GUIDE 189 XML configuration files reference <Proxy> <RouteTable protocol=""> <RouteEntry>foo:1935.*:80</RouteEntry> The example instructs the server to route a host:port combination to null. the connection would be routed to foo:1936. By default. and to route connections destined for any host on any port to the same host on port 80. The protocol attribute specifies the protocol to use for the outgoing connection. <RouteEntry>*:*. • If the incoming connection was not secure. Its effect is to reject all connections destined for foo:80. then the outgoing connection will also be secure. Flash Media Server applies the protocol configured in the RouteTable list unless the mapping for a particular RouteEntry element overrides it.The example shows how to route connections destined for any host on any port to port 1935 on the host foo. .*:1936</RouteEntry> The example instructs the server to use the values for host and port on the left side as the values for host and port on the right side. For example. • Specifying rtmps instructs the edge to use a secure outgoing connection.bar:80</RouteEntry> </RouteTable> </Proxy> Use of the wildcard character * to replace host and port. even if the incoming connection was secure. • Specifying "" (an empty string) means preserving the security status of the incoming connection.foo:1935</RouteEntry> The example instructs the server to route connections to any host on any port to the specified host on port 1936. <RouteEntry>foo:80. • If the incoming connection was secure. The attribute is set to "" (an empty string). even if the incoming connection was not secure. <RouteEntry>*:*. rtmp for a connection that isn’t secure. if you were to connect to foo:1935. <RouteTable protocol="rtmp"> or <RouteTable protocol="rtmps"> The RouteEntry elements nested under the RouteTable element specify the routing information for the edge server.

Last updated 3/2/2010 FLASH MEDIA SERVER 3. the SSL information in the vhost. SSLCACertificatePath.xml file is not evaluated. SSLCACertificatePath Specifies the name of a directory containing CA certificates.xml to configure the SSL connection to upstream servers. see SSL. Contained elements SSLCACertificateFile. • If the SSL elements in the Vhost. File names must be the hash with “0” as the file extension. .xml to the corresponding SSL section in the Vhost.console . SSLCipherSuite. • If the SSL elements in an edge’s Vhost.xml file. SSLVerifyDepth SSLCACertificateFile Specifies the name of a file that contains one or more CA (Certificate Authority) digital certificates in PEM (Privacy Enhanced Mail) encryption format. You can also override the configuration for outgoing SSL connections for an individual virtual host in Vhost.initialize from the command line.xml file.xml file match the SSL elements in the Server. • If the SSL elements in the Vhost.xml file to configure the connection.xml file to configure the connection.xml file are not present.xml file. the following sequence of events takes place: • The SSL elements in the Vhost. Flash Media Server uses the default values specified in the SSL section of Server. attempts are made to find CA certificates in the certs directory located at the same level as the conf directory. The Windows certificate store can be imported into this directory by running FMSMaster .xml file override the SSL elements in the Server.xml. For more information on the SSL elements in Server. Flash Media Server uses the default values for SSL in the Server. Each file in the directory must contain only a single CA certificate.xml file are evaluated first. Flash Media Server uses the SSL elements in the Vhost. SSLCipherSuite Specifies the suite of encryption ciphers that the server uses to secure communications.5 CONFIGURATION AND ADMINISTRATION GUIDE 190 XML configuration files reference Contained elements RouteEntry SSL Container element. When Flash Media Server acts as a client to make an outgoing SSL connection. If a virtual host is running in remote mode as an edge server and you want to configure the properties of an outgoing SSL connection to an upstream server.xml by copying the SSL elements in Server. Note: When Flash Media Server is running in local mode as an origin server. then you must enable this section and configure its SSL elements appropriately. For Win32 only: If this element is empty. SSLVerifyCertificate.

The server evaluates both strings as equivalent. • Lists of cipher suites can be combined in a single cipher string using the + character as a logical and operation. but some or all of the ciphers can be added again later. • It can consist of a single cipher suite. and the prefix ! removes the cipher from the list. The string of ciphers can take several different forms. The ciphers deleted can never reappear in the list even if they are explicitly stated.5 CONFIGURATION AND ADMINISTRATION GUIDE 191 XML configuration files reference This element is a colon-delimited list of encryption resources. or +. or cipher suites of a certain type. <SSLCipherSuite>ALL:!ADH:!EDH</SSLCipherSuite> These cipher strings instruct the server to accept only RSA key exchange and refuse export or null encryption. in the order of preference. • If ! is used. authentication method. such as RC4-SHA. • The cipher string @STRENGTH sorts the current cipher list in order of the length of the encryption algorithm key. such as a key-exchange algorithm. For example. • If none of these characters is present. the keyword ALL specifies all ciphers. block export ciphers.is used. The default cipher list instructs the server to accept all ciphers. but block those using anonymous Diffie-Hellman authentication. The cipher list consists of one or more cipher strings separated by colons. • Each cipher string can be optionally preceded by the characters !. Commas or spaces are also acceptable separators. SHA1 represents all cipher suites using the digest algorithm SHA1. block low-strength ciphers. • If the list includes any ciphers already present. Example This cipher string instructs the server to accept all ciphers except those using anonymous or ephemeral Diffie-Hellman key exchange. • If + is used. This option doesn't add any new ciphers—it just moves matching existing ones. • If . the server does not evaluate them. then the string is just interpreted as a list of ciphers to be appended to the current preference list. but colons are normally used. This sequencing allows clients to negotiate for the strongest cipher that both they and the server can accept. and sort ciphers by strength from highest to lowest level of encryption. For example. • It can represent a list of cipher suites containing a certain algorithm.Last updated 3/2/2010 FLASH MEDIA SERVER 3. -. For example. encryption method. then the ciphers are permanently deleted from the list. including only those ciphers the server is prepared to accept. and SSLv3 represents all SSL v3 algorithms. <SSLCipherSuite>RSA:!NULL!EXP</SSLCipherSuite> <SSLCipherSuite>RSA:LOW:MEDIUM:HIGH</SSLCipherSuite> This cipher list instructs the server to accept all ciphers but place them in order of decreasing strength. digest type. Each item in the cipher list specifies the inclusion or exclusion of an algorithm or cipher. or one of a selected number of aliases for common groupings. then the ciphers are moved to the end of the list. there are special keywords and prefixes. <SSLCipherSuite>ALL:+HIGH:+MEDIUM:+LOW:+EXP:+NULL</SSLCipherSuite> . then the ciphers are deleted from the list. Important: Contact Adobe Support before changing the default settings. In addition. block MD5 hashing. The components can be combined with the appropriate prefixes to create a list of ciphers. SHA1+DES represents all cipher suites containing the SHA1 and DES algorithms.

DES) 128-bit encryption Triple-DES encoding .5 CONFIGURATION AND ADMINISTRATION GUIDE 192 XML configuration files reference This string instructs the server to accept only high.and medium-strength encryption. and reject export-strength versions. <SSLCipherSuite>ALL:+SSLv2</SSLCipherSuite> The following is the complete list of components that the server can evaluate. Key exchange algorithm kRSA kDHr kDHd RSA DH EDH ADH Description Key exchange Diffie-Hellman key exchange with RSA key Diffie-Hellman key exchange with DSA key Ephemeral Diffie-Hellman key exchange RSA key exchange Ephemeral Diffie-Hellman key exchange Anonymous Diffie-Hellman key exchange Authentication methods aNULL aRSA aDSS aDH Description No authentication RSA authentication DSS authentication Diffie-Hellman authentication Encryption methods eNULL DES 3DES RC4 RC2 IDEA NULL EXP LOW MEDIUM HIGH Description No encoding DES encoding Triple-DES encoding RC4 encoding RC2 encoding IDEA encoding No encryption All export ciphers (40-bit encryption) Low-strength ciphers (no export.Last updated 3/2/2010 FLASH MEDIA SERVER 3. with the high being preferred. <SSLCipherSuite>ALL:+HIGH:!LOW:!EXP:!NULL</SSLCipherSuite> This string instructs the server to accept all ciphers but to order them so that SSLv2 ciphers come after SSLv3 ciphers.

the stream foo. You can specify multiple virtual directory mappings for streams by adding additional Streams elements—one for each virtual directory mapping. To disable certificate verification. certificate verification fails. Certificate verification is enabled by default. the server adds one. specify false. <Streams>foo. see the “Configuring content storage” section of the Configuration and Administration Guide at www. Examples The following configuration maps all streams whose names begin with foo/ to the physical directory c:\data.flv.flv. the server tries to find a virtual directory mapping for foo/bar.com/go/learn_fms_content_en. .5 CONFIGURATION AND ADMINISTRATION GUIDE 193 XML configuration files reference Digest types MD5 SHA1 SHA Description MD5 hash function SHA1 hash function SHA hash function Additional aliases All SSLv2 SSLv3 DSS Description All ciphers All SSL version 2.0 ciphers All ciphers using DSS authentication SSLVerifyCertificate Specifies whether the certificate returned by the server should be verified. Note: Disabling certificate verification can result in security problems. If a self-signed root certificate cannot be found within this depth. Note: If the virtual directory you specify does not end with a backslash. Since a virtual directory mapping does exist for foo. SSLVerifyDepth Specifies the maximum depth of the certificate chain to accept. The Streams element enables you to specify a virtual directory for stored stream resources used by more than one application.bar maps to the file c:\data\bar\x. If there is no virtual directory for foo/bar. you specify a relative path that points to a shared directory that multiple applications can access. Example <SSLVerifyDepth>9</SSLVerifyDepth> Streams Specifies the virtual directory mapping for recorded streams. For more information. The default value is 9.0 ciphers All SSL version 3. By using a virtual directory.c:\data</Streams> If a stream is named foo/bar/x.Last updated 3/2/2010 FLASH MEDIA SERVER 3.adobe. The stream named foo/bar maps to the physical file c:\data\bar. the server checks for a virtual directory mapping for foo.

C:\flashmediaserver\myapplications\shared\resources\</Streams> If the application “videoConference” refers to an item common/video/recorded/june5 and the application “collaboration” refers to common/video/recorded/june5. Flash Media Server serves the resource from the physical directory. For more information. When the beginning portion of a resource’s URI matches a virtual directory. Note: If you are mapping a virtual directory to a drive on another computer. Virtual directories let you share resources among applications. <Streams>common. This element contains all the configuration elements for the Vhost. see “Mapping directories to network drives” on page 34.5 CONFIGURATION AND ADMINISTRATION GUIDE 194 XML configuration files reference The following configuration maps streams whose paths begin with common/ to the folder C:\flashmediaserver\myapplications\shared\resources.xml file. For more information. Use these elements to deliver streams to clients based on Flash Player version. VirtualKeys Lets you map Flash Player versions to keys. make sure that the computer running Flash Media Server has the right permissions to access the other computer.xml file. see “Mapping virtual directories to physical directories” on page 35. The keys are used in the VirtualDirectory element to map URLs to physical locations on a server. they both point to the same item C:\flashmediaserver\myapplications\shared\resources\video\recorded\june5\. see VirtualKeys.d:\sharedStreams</Streams> </VirtualDirectory> Contained elements Streams See also VirtualKeys VirtualHost Root element of the Vhost. . using the following VirtualDirectory XML. the server would play the file d:\sharedStreams\myVideo. if a client called NetStream. Example For example.flv: <VirtualDirectory> <Streams>vod. You can use the VirtualDirectory element in conjunction with the VirtualKeys element to serve content based on Flash Player version information.play("vod/myVideo").Last updated 3/2/2010 FLASH MEDIA SERVER 3. For detailed information on mapping virtual directories. See also VirtualDirectory VirtualDirectory Specifies virtual directory mappings for resources such as recorded streams.

5 CONFIGURATION AND ADMINISTRATION GUIDE 195 XML configuration files reference Contained elements Key WaitTime Specifies length to wait in milliseconds for edge autodiscovery. Do not set this number too low. collect the UDP responses. perform a UDP broadcast. and return an XML response. AllowOverride . Example <WaitTime>1000</WaitTime> See also Enabled. The number must be long enough to establish a TCP connection.Last updated 3/2/2010 FLASH MEDIA SERVER 3.

lock count %2$S. or users that you can use for debugging. Missing unlock for shared object %1$S. Ignoring message from client during authentication. Failed to create thread (%1$S). Unlock called without matching lock for shared object %1$S. Server stopped %1$S.log. rejecting message (%1$S). Received interrupt signal. IP %2$S. . and httpcache.log.log) record information about server operations. Failed to execute method (%1$S). Command name not found in the message. Nested lock for shared object %1$S. Method not found (%1$S). Server starting. port %3$S: %4$S. p1. edge. service will be stopped.xx. Service Control Manager failed (%1$S: %2$S). Clients not allowed to broadcast message. Asynchronous I/O operation failed (%1$S: %2$S). Error during shutdown process. Message ID 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 Description Received termination signal..xx. Invalid application. pn]). admin. Message IDs can be useful for administrators who want to write error-handling scripts.log.Last updated 3/2/2010 196 Chapter 8: Diagnostic Log Messages Message IDs in diagnostic logs The IDs of messages that appear in the diagnostic log files (master. Failed to stop virtual host (%1$S).xx. invalid parameters: call(methodName[.log. Dropping application (%1$S) message. The call method failed. server shutdown in progress. resultObj.xx. core. see “Access logs” on page 57 and “Application logs” on page 63. lock count %2$S.xx. Failed to stop %1$S listeners for adaptor %2$S. process will be terminated. Service Control Manager reported (%1$S: %2$S). Response object not found (%1$S). Failed to create listener for adaptor %1$S. server shutdown in progress.. Reinitializing server. instances. Server initialization failed. For status codes related to applications. Failed to start the following listeners for adaptor %1$S: %2$S.

Illegal subscriber: %1$S cannot subscribe to %2$S. Resource limit violation. Resource limit violation. Failed to create administrator: %1$S. Script execution is taking too long. Read access denied for shared object %1$S. Failed to remove administrator: %1$S. Virtual host %1$S is not available. connection may be lost (%1$S). . Alive. Failed to start server.Call. Write access denied for shared object %1$S. Read access denied for stream %1$S. Invalid user ID (%1$S). Failed to open configuration file: %1$S.Failed Invalid application name (%1$S). Bad network data. Connect from host (%1$S) not allowed. Parse error at line %1$S: %2$S. Exception while processing message. Invalid proxy object. Failed to start virtual host (%1$S). NetConnection. Unable to create shared object: %1$S. No adaptors defined. Admin request received from an invalid Administration Server. Reserved property (%1$S). Unable to create stream: %1$S. Adaptor already defined with the name %1$S. Write access denied for stream %1$S. terminating connection: %1$S.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Unknown %1$S command issued for stream %2$S (application %3$S). Rejecting connection from %1$S to %2$S. Invalid parameters to %1$S method. Administrator login failed for user %1$S. Failed to change password: %1$S.5 CONFIGURATION AND ADMINISTRATION GUIDE 197 Diagnostic Log Messages Message ID 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 Description Connection to %1$S lost. Connect failed ( %1$S. %2$S ): %3$S.

NetStream deleted (stream ID: %1$S). Failed to play (stream ID: %1$S).Last updated 3/2/2010 FLASH MEDIA SERVER 3. Started playing %1$S.Admin. Stream %1$S has been idling for %2$S second(s). %3$S) : Failed to load application instance %1$S. Client already connected to an application. %1$S is now unpublished. (%2$S. Stopped playing %1$S.CommandFailed Invalid parameters to %1$S method. . Admin user requires valid user name and password. Stopped recording %1$S. Pausing %1$S. Failed to play %1$S (stream ID: %2$S). Audio receiving enabled (stream ID: %1$S). Failed to publish %1$S. Error registering class: name mismatch (%1$S. Failed to load application %1$S. Recording %1$S. New NetStream created (stream ID: %1$S). Connection rejected: maximum user limit reached for application instance %1$S. (%2$S. Play stop failed. Playing and resetting %1$S. Unpausing %1$S. %2$S). stream ID: %1$S. %1$S is now published. Failed to unload application %1$S. %1$S applications unloaded. Failed to restart virtual host (%1$S). Failed to record %1$S. Publishing %1$S. Connection to Flash Media Server has been disconnected. Illegal access property (%1$S). %3$S) : Connection rejected to application instance %1$S. Invalid virtual host alias : %1$S.5 CONFIGURATION AND ADMINISTRATION GUIDE 198 Diagnostic Log Messages Message ID 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 Description NetConnection. Audio receiving disabled (stream ID: %1$S).

Invalid stream name (%1$S). Failed to receive video (stream ID: %1$S). Invalid method name (%1$S).Last updated 3/2/2010 FLASH MEDIA SERVER 3. Video receiving enabled (stream ID: %1$S). Server started (%1$S). Unknown exception caught in %1$S. Failed to seek (stream ID: %1$S). Invalid schedule event format (%1$S). VHost: %2$S. Invalid shared object (%1$S). Failed to seek %1$S (stream ID: %2$S). App: %3$S). (%2$S. Failed to open shared object file (%1$S) for read. Video receiving disabled (stream ID: %1$S). JavaScript engine runtime is low on free memory.5 CONFIGURATION AND ADMINISTRATION GUIDE 199 Diagnostic Log Messages Message ID 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 Description Failed to enable audio receiving (stream ID: %1$S). 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 . Seeking %1$S (stream ID: %2$S). Failed to stop playing (stream ID: %1$S). Check the JavaScript runtime size for this application in the configuration file. Configuration error for adaptor %1$S: IP %2$S and port %3$S are already in use. stream not found. Failed to initialize listeners for adaptor %1$. Connection succeeded. Failed to create adaptor: %1$S. JavaScript runtime is out of memory. Invalid NetStream ID (%1$S). server shutting down instance (Adaptor: %1$S. %3$S): Invalid application name (%1$S). Insufficient admin privileges to perform %1$S command. Failed to play %1$S. Failed to open shared object file (%1$S) for write. Failed to start listeners for adaptor %1$S. Configuration file not found: %1$S Invalid configuration file: %1$S Server aborted. Flash Media Server is already running or other processes are using the same ports. Failed to flush shared object (%1$S). Connection failed. Take action. Set video fps to %1$S (stream ID: %2$S).

Preload application aborted. %3$S): Resource limit violation. NetConnection.AccessDenied NetConnection. NetConnection. (%2$S. Admin command setApplicationState failed for %1$S.Call.5 CONFIGURATION AND ADMINISTRATION GUIDE 200 Diagnostic Log Messages Message ID 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 Description Failed to initialize shared object from persistent store (%1$S). Multiprocessor support available only in Enterprise Edition. Unable to create directory %1$S.Success Unable to locate server configuration file during startup. %3$S/%1$S): Current server bandwidth usage exceeds license limit set. Pause %1$S failed. invalid arguments. Invalid object name (stream ID: %1$S). Rejecting connection. Unable to create new application instance: %1$S. %3$S): Application (%1$S) is currently offline. shared object(%1$S) lock reset to unlocked.Call. Unable to load new application: %1$S. Invalid admin command: %1$S. index file not found or mismatch. Failed to load admin application. (%2$S. Unable to locate script file: %1$S. Server shutting down. Beta expired.Call. (%2$S. %3$S/%1$S): Current virtual host bandwidth usage exceeds max limit set. Breaking potential deadlock. License key specified does not allow multiple virtual host support. %3$S): Application (%1$S) is not defined.Last updated 3/2/2010 FLASH MEDIA SERVER 3.BadValue Publish %1$S failed. Script is taking too long to process the event. Shutting down instance: %1$S. . Rejecting connection. %3$S): Resource limit violation. (%2$S. Command successful. Potential deadlock. Trial run expired. (%2$S. (%2$S. (%2$S. Invalid license key: %1$S License key specified does not allow multiple adaptor support. Failed to play %1$S. Rejecting connection to: %1$S. invalid arguments. %3$S): Resource limit violation. Invalid shared object file (%1$S). Server shutdown failed. shared object (%1$S) has been locked for %2$S sec.

Warning from %1$S:%2$S. Exception while processing message: %1$S. Max Allowed %2$S.Last updated 3/2/2010 FLASH MEDIA SERVER 3. no space left on device. Failed to play %1$S. [Virtual host (%1$S). Exception caught in %1$S while processing streaming data inside %2$S. Generic message code. Failed to initialize cryptographic accelerator: %1$S. Info from %1$S:%2$S. Listener started (%1$S): %2$S. %3$S): Max connections allowed exceed license limit. Rejecting connection to: %1$S. Failed to execute admin command: %1$S. Invalid shared object name (%1$S). System memory load (%1$S) is now below the maximum threshold. Client to server bandwidth limit exceeded. Invalid cryptographic accelerator: %1$S. Out of memory: %1$S. Current %3$S] . (%2$S. Pending queue size limit %1$S reached. Unloaded application instance %1$S. Rejecting connection request Host: %2$S:%3$S. Instance will be unloaded: %1$S. System memory load (%1$S) is high. Failed to seed the pseudorandom number generator. Unknown exception occurred. Attempt to reconnect to Flash Media Server. Error from %1$S:%2$S. An internal version control error has occurred. Adaptor (%1$S) has an SSL configuration error on port %2$S. Failed to remove application: %1$S. Failed login attempt from %1$S at %2$S. adaptor not found: %2$S. Failed to record %1$S. Restarting listener (%1$S): %2$S. Application directory does not exist: %1$S Using default application directory: %1$S Application instance is not loaded: %1$S Error: command message sent before client connection has been accepted. Invalid value set for configuration key: %1$S = %2$S.5 CONFIGURATION AND ADMINISTRATION GUIDE 201 Diagnostic Log Messages Message ID 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 Description License key has expired. using %3$S.

Current %3$S] Adaptor (%1$S) does not exist. %2$S File operation %1$S failed. Max Allowed %2$S. Edge (%1$S) started. arguments: %2$S. as auto commit is set to false. Shared memory heap (%1$S) has exceeded 90 usage. arguments: %2$S. Object is not a file (%2$S). [Virtual host (%1$S).Last updated 3/2/2010 FLASH MEDIA SERVER 3. Switching to Developer Edition. Core (%1$S) is no longer active. Failed to start core: %1$S %2$S. OEM licences cannot be mixed with any other kind. Switching to Developer Edition. 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 . Too many trial licenses detected. File object creation failed (%1$S). File operation %1$S failed. Core (%1$S) started.5 CONFIGURATION AND ADMINISTRATION GUIDE 202 Diagnostic Log Messages Message ID 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 Description Server to client bandwidth limit exceeded. Shared object %1$S has changed and is not being saved. Reason: %1$S. Server memory usage too high. Consider increasing the heap size to prevent future memory allocation failures. Virtual host (%1$S) does not exist. NFR licences cannot be mixed with any other kind. Disconnecting client. Edge (%1$S) is no longer active. Administrator (%1$S) already exists. Missing arguments to %1$S method. Switching to Developer Edition. Switching to Developer Edition. Switching to Developer Edition. Failed to open log file. Personal and Professional licenses cannot be mixed. %1$S failed. Invalid admin stream: %1$S . File is in closed state (%2$S). Duplicate license key: %1$S Expired license key: %1$S No primary license key found. Failed to start edge: %1$S %2$S. File operation %1$S failed. Current version %2$S. Invalid substitution variable: %1$S Resetting service failure action from %1$S to %2$S. Message queue is too large. Switching to Developer Edition. Invalid argument %2$S. Connection rejected by server. Failed to play stream %1$S: Recorded mode not supported. Log aborted. Last saved version %3$S. Commercial and Educational licenses cannot be mixed.

Core (%1$S) disconnected: %2$S. Core (%1$S) failed to establish proxy to edge. Core (%1$S) connection to admin failed. Core (%1$S): Failed to initiate connection to admin. Recovering edge %1$S with %2$S failure[s] after %3$S seconds! Edge (%1$S) %2$S experienced %3$S failure[s]! Core (%1$S) %2$S experienced %3$S failure[s]! Core (%1$S) %2$S is not responding and is being restarted! Core (%1$S) is no longer active.Last updated 3/2/2010 FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 203 Diagnostic Log Messages Message ID 1228 1229 1230 1231 1132 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 Description Failed to create process mutex. Connection from core %1$S accepted. Failed to send connect response to core %1$S. Core (%1$S) socket migration failed. Core (%1$S) failed to connect to admin. Connection to admin received. Recovering core %1$S with %2$S failure[s] after %3$S seconds! Core (%1$S) did not shut down as expected. Proxy to core (%1$S) failed. Core (%1$S) disconnected from edge. Socket migration to core (%1$S) failed. Core (%1$S) shutdown failed. . Core (%1$S) disconnecting from admin. Core (%1$S) connecting to admin. Core (%1$S) connection to admin accepted. Starting admin app on core (%1$S). Core (%1$S) received close command from admin. Core (%1$S) connected to admin. create a new one. Process (%1$S): failed to map view of shared memory (%2$S). Process (%1$S): shared memory (%2$S) init failed. Edge disconnected from core (%1$S). Core (%1$S) sending register command to edge. Command (%1$S) timed out. Killing core now. Registering core (%1$S). Connection from core %1$S received.

disconnecting client. SWF verification failed. SWF verification unsupported by client. OpenProcess(PROCESS_QUERY_INFORMATION) failed for pid (%1$S) with %2$S.5 CONFIGURATION AND ADMINISTRATION GUIDE 204 Diagnostic Log Messages Message ID 1262 1263 1373 1374 1375 Description OpenProcess(PROCESS_TERMINATE) failed with %1$S.Last updated 3/2/2010 FLASH MEDIA SERVER 3. SWF verification timeout. disconnecting client. . disconnecting client.

59 Adaptor. 57. defining 31 Application.xml file description of tags 80 file structure 80 Adaptor.Last updated 3/2/2010 205 Index A access logs 29.xml file description of tags 93 Application.xml tags Access 94 AccumulatedFrames 94 AggregateMessages (Client) 94 AggregateMessages (Queue) 94 Allow 95 AllowDebugDefault 95 AllowHTTPTunnel 95 Application 96 Audio 96 AutoCloseIdleClients 96 AutoCommit 97 AutoSampleAccess 97 Bandwidth 97 BandwidthCap 98 BandwidthDetection 98 Bits 99 BufferRatio 99 Cache 99 CachePrefix 99 CacheUpdateInterval 100 Client 101 ClientToServer (Bandwidth) 101 ClientToServer (BandwidthCap) 101 CombineSamples 102 Connections 102 DataSize 102 Debug 102 DirLevelSWFScan 103 DisallowProtocols 103 Distribute 103 DuplicateDir 104 Duration 104 EnhancedSeek 105 Exception 105 FileObject 106 FinalHashTimeout 106 FirstHashTimeout 106 FlushOnData 106 FolderAccess 106 HiCPU 106 Host 107 HTTP 107 HTTP1_0 107 HTTPTunnel 107 IdleAckInterval 108 IdlePostInterval 108 Interface 109 Interval 109 . 38 application instances about 6 log messages 43 performance 47 reloading 43 view in Administration Console 42 application logs 63 Application object.xml tags Adaptor 80 Allow 80 Deny 81 Edge 81 Enable 81 EnableAltVhost 82 HostPort 82 HostPortList 83 HTTPIdent 83 HTTPIdent2 84 HTTPNull 84 HTTPTunnel 85 HTTPUserInfo 85 IdleAckInterval 86 IdlePostInterval 86 IdleTimeout 86 MaxFailures 87 MaxSize 87 MaxWriteDelay 87 MimeType 88 NeedClose 88 NodeID 88 Order 88 Path 89 RecoveryTime 89 Redirect 89 ResourceLimits 89 RTMP 90 RTMPE 90 SetCookie 90 SSL 90 SSLCertificateFile 91 SSLCertificateKeyFile 91 SSLCipherSuite 91 SSLPassPhrase 92 SSLServerCtx 92 SSLSessionTimeout 92 UpdateInterval 93 WriteBufferSize 93 adaptors about 6 adding 7 configuring 80 creating 8 directory structure 7 administration APIs about 76 allowing use of 30 calling over HTTP 77 calling over RTMP 78 HTTP parameters 77 permissions 76 sample application 78 Administration Console about 40 application log 43 connecting to 40 debug connection 30 refresh rate 41 view applications 42 view server performance 51 Administration Server administrators 49 APIs 40 connecting to 40 default port 40 administrators defining in Administration Console 49 managing 49 Apache HTTP server 37.

155 content storage configuring 33 mapping directories 34 virtual directories 35 core processes assigning 16 configuring 16 distributing 17 maximum number of 18 rolling over 18 cross-domain XML file.5 CONFIGURATION AND ADMINISTRATION GUIDE 206 Index JSEngine 109 KeyFrameInterval 110 LifeTime 110 Live (MsgQueue) 111 Live (StreamManager) 110 LoadOnStartup 111 LockTimeout 111 LoCPU 111 Max 112 MaxAggMsgSize 112 MaxAppIdleTime 112 MaxAudioLatency 112 MaxBufferRetries 113 MaxCores 113 MaxFailures 114 MaxGCSkipCount 114 MaxInitDelay 114 MaxMessagesLosslessvideo 115 MaxPendingDebugConnections 115 MaxProperties 115 MaxPropertySize 115 MaxQueueDelay 116 MaxQueueSize 116 MaxRate 116 MaxSamples 116 MaxSize 116 MaxStreamsBeforeGC 117 MaxTime 117 MaxTimeOut (Connections) 118 MaxTimeOut (JSEngine) 118 MaxUnprocessedChars 118 MaxWait 118 MimeType 119 MinBufferTime (Live) 119 MinBufferTime (Recorded) 119 MinGoodVersion 119 MsgQue 120 NetConnection 120 NotifyAudioStop 120 ObjectEncoding 120 OutChunkSize 121 OverridePublisher 121 Password 121 Port 121 Prioritization 122 Process 122 Proxy 122 PublishTimeout 123 QualifiedStreamsMapping 123 Queue 123 Recorded 123 RecoveryTime 124 Redirect 124 ResyncDepth 124 Reuse 124 RollOver 125 RuntimeSize 125 Scope 125 ScriptLibPath 126 SendDuplicateOnMetaData 126 SendDuplicateStart 127 SendSilence 127 Server 127 ServerToClient (Bandwidth) 127 ServerToClient (BandwidthCap) 127 SharedObjManager 128 StorageDir 128 StreamManager 128 Subscribers 129 SWFFolder 129 SWFVerification 129 ThrottleBoundaryRequest 129 ThrottleDisplayInterval 130 ThrottleLoads 130 TTL 130 Tunnel 130 Type 131 UnrestrictedAuth 131 UpdateInterval 131 UserAgent 131 UserAgentExceptions 131 Username 132 Verbose 132 VideoSampleAccess 132 VirtualDirectory 132 WindowsPerAck 133 WriteBuffSize 133 XMLSocket 133 audio samples.xml 140 symbols in 10 Users.xml) 23.xml 133 Server. using 23 CrossDomainPath (Server. native 32 C CGI programs 39 checkpoint events 29.xml 80 Application.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml 178 connections closing idle 14 limiting 14. in video files 71 Event Viewer (Windows) 67 .xml 93 directory structure 6 editing 9 Logger. combining 13 B backing up log files 56 bandwidth detection. 146 D debug connection 30 diagnostic logs 64 E edge servers cache 73 chain 5 configuring 2 connecting to 4 deploying 1 file cache (on Linux) 74 file cache (Windows) 73 environmental variables 11 Errors.xml 175 Vhost. 57 clients closing idle connections of 14 limiting connections from 14 view active 45 clusters 1 configuration files Adaptor.

checking 69 FLVCachePurge (Server.xml file configuring 55 description of tags 133 file structure 134 Logger. 146 AutoCloseIdleClients 143 Cache 144 CheckInterval 144 Connector 144 Content 144 Core 145 CoreExitDelay 145 CoreGC 145 CoreTimeOut 145 CPUMonitor 146 CrossDomainPath 146 Deny 146 Diagnostic 146 DirLevelSWFScan 147 .xml tags Access 140. See log files M map files 11 mapping virtual directories 35 messages aggregating 13 in diagnostic logs 196 viewing log messages for applications 43 MP4 errors 71 N native bandwidth detection 32 O object properties.Last updated 3/2/2010 FLASH MEDIA SERVER 3. configurable 31 P performance improving 12 monitoring server 51 permissions administration APIs 76 for administrators 175 PublishTimeout (Application. 140 Server. configuring 16 Server. 136.xml) 123 Q QualifiedStreamsMapping (Application.xml file 55. 138 Application 134 AuthEvent 134 AuthMessage 134 Delimiter 135 Diagnostic 135 Directory 135 DisplayFieldsHeader 136 EscapeFields 136 Events 136 Fields 136 FileIO 137 FileName 137 History 137 HostPort 138 Logger 138 LogServer 138 MaxSize 138 QuoteFields 138 Rename 139 Rotation 139 Schedule 139 ServerID 140 Time 140 logs.xml tags Access 134.xml) 149 FLVCheck tool 69 FMSCheck tool 67 fmsmgr utility 74 H HTTP proxying 38 I IPv6 configuring 30 disabling 162 enabling 162 on Linux 84 L licenses 53 Linux and IPv6 84 using with Flash Media Server 74 load balancing clusters 1 log files and IPv6 56 application 55 backing up 56 configuration files for 55 diagnostic 55 managing 55 messages 196 rotating 56 server server access 55 web server 55 Logger. 179 ACCP 140 ActiveProfile 141 Admin 141 AdminElem 141 AdminServer 141 Allow 141 Application 142 ApplicationGC 142 AuthEvent 143 AuthMessage 143.xml) 123 R RecordsNumber 164 refresh rate 41 RetryNumber 165 RetrySleep 165 rotating log files 56 S scripts. on Linux 74 performance 51 starting and stopping 66 testing 67 viewing events 67 server processes. See server-side scripts security and RTMPE 23 and SSL 24 configuring features 19 limiting domain access to 23 SWF verification 19 serial keys adding 53 server checking status of 67 hierarchy 6 log file 54 managing.5 CONFIGURATION AND ADMINISTRATION GUIDE 207 Index F FLV errors 71 FLV files. 135.

172 SSLCACertificateFile 169. 190 SSLCipherSuite 169. 164. 174 Process (Server) 163 Protocol 163 PublicIP 164 RecBuffer 164 RecordsNumber 164 ResourceLimits 165 RetryNumber 165 RetrySleep 165 Root 165 RTMP (AdminServer) 165 RTMP (Connector) 165 RTMP (Protocol) 166 RTMPE 166 Scope 166 SegmentsPool 166 Server 166 ServerDomain 167 Services 167 SmallMemPool 167 SocketGC 167 SocketOverflowBuckets 168 SocketRcvBuff 168 SocketSndBuf 168 SocketTableSize 168 SSL 161.xml tags AdminServer 175 Allow (HTTP Commands) 175 Allow (User) 175 Deny (HTTPCommands) 176 Deny (User) 176 Enable 176 HTTPCommands 176 Order (HTTPCommands) 177 Order (User) 177 Password 177 Root 178 User 178 UserList 178 V variables 11 Vhost. 190 SSLClientCtx 171 SSLRandomSeed 171 SSLSessionCacheGC 172 SSLVerifyCertificate 172. 193 SWFFolder 172 SWFVerification 173 TerminatingCharacters 173 ThreadPoolGC 173 Time 173 TrimSize 173 TTL 173 UID 174 UpdateInterval 174 UpdateInterval (Cache) 174 server-side scripts and configurable object properties 31 setting storage directories 34 shared objects default location of 34 setting location of 34 view active 46 SSL certificates 25 configuring 24 tags in Adaptor. 26 tags in Server.xml 28 storage directories 34 storageDir element 34 streams cache size 12 chunk size 13 view live 44 U Users.xml tags AggregateMessages 179 Alias 179 AliasList 180 Allow 180 AllowOverride 180 Anonymous 180 .Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml file file structure 179 summary of tags 179 Vhost.5 CONFIGURATION AND ADMINISTRATION GUIDE 208 Index ECCP 147 Edge 147 EdgeCore 147 Enable 148 FileCheckInterval 148 FileIO 148 FilePlugin 148 FLVCache 149 FLVCachePurge 149 FLVCacheSize 149 FreeMemRatio 149 FreeRatio 149 GCInterval 150 GID 150 GlobalQueue 150 GlobalRatio 150 HandleCache 150 HostPort 151 HTTP 151 IdleTime 152 IPCQueues 152 LargeMemPool 152 LicenseInfo 153 LicenseInfoEx 153 LocalHost 153 Logging 153 Mask 154 Master 154 MaxAge 154 MaxCacheSize 155 MaxCacheUnits 155 MaxConnectionRate 155 MaxIdleTime 157 MaxInitDelay 157 MaxIOThreads 157 MaxKeyframeCacheSize 158 MaxNumberOfRequests 158 MaxQueueSize 158 MaxSize (FLVCache) 159 MaxSize (HandleCache) 159 MaxSize (RecBuffer) 159 MaxTimestampSkew 159 MaxUnitSize 159 MessageCache 160 MinConnectionThreads 160 MinGoodVersion 161 MinIOThreads 161 MinPoolGC 161 NetworkingIPv6 162 NumCRThreads 162 Order 162 Plugins 163.xml file description of tags 175 file structure 175 permissions for admin APIs 76 summary of tags 175 Users. 28 tags in VHost.xml 27. 168.xml 25. 190 SSLCACertificatePath 169. 163. 193 SSLVerifyDepth 172.

xml) 133 .Last updated 3/2/2010 FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 209 Index AppInstanceGC 181 AppsDir 181 AutoCloseIdleClients 182 CacheDir 183 DNSSuffix 183 EdgeAutoDiscovery 183 Enabled 184 LocalAddress 185 MaxAggMsgSize 185 MaxAppInstances 185 MaxConnections 186 MaxEdgeConnections 186 MaxIdleTime 186 MaxSharedObjects 186 MaxStreams 187 Mode 187 Proxy 188 ResourceLimits 188 RouteEntry 188 RouteTable 189 SSL 190 Streams 193 VirtualDirectory 194 VirtualHost 194 VirtualKeys 194 WaitTime 195 virtual directories 35 virtual hosts about 6 connecting to 41 creating 8 directory structure 6 VirtualDirectory element 35 W WebDAV 39 Windows Event Viewer 67 WindowsPerAck (Application.

Sign up to vote on this title
UsefulNot useful