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

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

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); }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

5 CONFIGURATION AND ADMINISTRATION GUIDE 27 Configuring the server This sample code demonstrates how to configure edge1 to return cert2.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 443. Since there is no Edge tag for edge2.Last updated 3/2/2010 FLASH MEDIA SERVER 3.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. <SSL> <SSLServerCtx> <SSLCertificateFile>cert.pem when a client connects to it on port 444. Secure outgoing connections 1 Open the Server. The edge2 server returns cert. . edge2 will use the default configuration specified in the SSLServerCtx section that is directly under the SSL container tag.pem</SSLCertificateKeyFile> <SSLPassPhrase></SSLPassPhrase> <SSLCipherSuite>ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH</SSLCipherSuite> <SSLSessionTimeout>5</SSLSessionTimeout> </SSLServerCtx> <Edge name="edge1"> <SSLServerCtx> <SSLCertificateFile>cert2.pem</SSLCertificateFile> <SSLCertificateKeyFile>private.pem</SSLCertificateFile> <SSLCertificateKeyFile>private2. 5 Restart the server.

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

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

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

the properties are available for all applications on a virtual host.xml file in an application folder.log files (located in the RootInstall/logs/ directory). To define a property. if necessary) in the server configuration files. the following XML fragment defines the properties user_name and dept_name. The property name corresponds to the tag’s name.xml configuration files.config. If you define properties in an Application. RTMPS.xx. 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.log. Defining Application object properties You can define properties for the server-side Application object in the server’s Application. 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 following xcomment fields from a sample edge log file indicate that the IPv6 stack and the IPv4 stack are available.property. See HTTPIdent2.192. and RTMPE protocols with a network services database and use a service name (or decimal port number. 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. host name.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. and all available IP addresses for the host in the master.property.133.config. For example.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml file. edge. it logs available stack configuration.prop_name application.log. if you are using an IPv4 host name (a host name that resolves to IPv4) on an RTMPT or RTMPTE connection.xx. with the values jdoe and engineering. you should configure the Adaptor.5 CONFIGURATION AND ADMINISTRATION GUIDE 31 Configuring the server rtmp://[fd5e:624b:4c18:ffff:0:5efe:10.xx.133. and the property value corresponds to the tag’s contents. not from application. use the syntax in either of these examples: application.config["prop_name"] Note: The properties you define are accessible from application. .xml appropriately to resolve connections quickly. If you define properties in the default Application. When the server starts.128.xml file. create an XML tag in the JSEngine section of the Application. and admin. Check the logs.

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

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

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

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

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

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

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

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

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

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

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

View information about an application 1 Follow the steps in “Connect to the Administration Console” on page 40. 2 Click View Applications. do one of the following: • Click the Name column header to sort the applications list by name. 2 Click View Applications. 3 Select an application from the list. 2 Click View Applications. all users are disconnected and all instance resources are released. such as total uptime or number of users Sort applications list 1 Follow the steps in “Connect to the Administration Console” on page 40. • Click the Clients column header to sort by client.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. log messages are still received.) . 3 Select the application from the list.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 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. 1 Follow the steps in “Connect to the Administration Console” on page 40. 3 In the applications list. 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. The information in this panel is updated whenever the application instance generates a log message. 4 Click Reload (circular arrow icon to the right of the Performance tab). 2 Click View Applications. (If the console refresh feature is paused. End an application instance When an application instance is ended. 1 Follow the steps in “Connect to the Administration Console” on page 40. 3 Select an application from the list.

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.

data received. 5 Select and deselect checkboxes to customize the information displayed on the graphs. figures appear after the panel is open for 15 seconds. including the total number of clients who connected to the application instance since it started. . The following information is displayed: • Clients: Information about clients connected to this application instance. 2 Click View Applications. 4 Select an application from the list. • Bytes Per Second: The average number of bytes sent per second for this application instance.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 3 Click Performance. When the panel first appears. including data sent. 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.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. and the number of users whose attempts to connect to the application instance were rejected. 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. these figures appear as pending because there is only one data point to start with. and command messages) sent per second. audio packets.) • Lifespan: The length of time the application instance has been running and the date and time it began to run. • CPU and Memory Usage: The percentage of CPU and memory used by Flash Media Server. • Active Connections: The number of users currently connected to the application instance. • Bandwidth: The amount of data that the application instance manages. For example. and the combined amount of data traffic. active clients. in the Bandwidth graph. look at the Live Log panel under View Applications. (To determine why connections may have failed.

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

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

• Review information about the applications located on the server or virtual hosts. • Ping the server to verify that it is running. add serial keys. • Delete a server from the list. you can perform the following actions: • Review the performance statistics for the computer where the applications are running. The Servers panel occupies the left side of the screen in this section of the Administration Console. A series of tabs is displayed along the top of the Manage Servers panel. The panel lists the servers and virtual hosts that you can access and manage.Last updated 3/2/2010 FLASH MEDIA SERVER 3. • Connect to the selected server. The servers are arranged in a tree structure. 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.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. • 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. From here. . • Review the access log and server log. • Review server licenses and. if necessary.

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

xml file cannot be removed using the Administration Console. The panel also displays detailed information for all serial keys authorizing you to run Flash Media Server on the selected server. 3 Click License. Note: Serial numbers that are added manually (that is. 4 Select a server from the list. 2 Click Manage Servers.5 CONFIGURATION AND ADMINISTRATION GUIDE 53 Using the Administration Console 4 Select a server from the list. added by editing configuration files directly) to either fms. Add a serial key Add serial keys in the Administration Console License panel. along with the following information. 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. Only serial numbers that are added using the Administration Console can be deleted using the Administration Console. The name of each application. 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. The lower frame displays information about custom licenses. For each license. 2 Click Manage Servers.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 1 Follow the steps in “Connect to the Administration Console” on page 40. 6 Restart the server. 4 Enter the serial key number in the text boxes at the bottom of the Administration Console. 1 Follow the steps in “Connect to the Administration Console” on page 40.ini or the <LicenseInfo> tag of the Server. so note the capacity totals listed near the bottom of the Administration Console. . 5 Click Add Serial Key. 3 Click License.

1 Follow the steps in “Connect to the Administration Console” on page 40.Last updated 3/2/2010 FLASH MEDIA SERVER 3. type it in the Find text box and click Find Next. 4 Select a server from the list. 5 To locate a specific string. 3 Click Server Log. Use the Find Previous and Clear Log buttons as necessary. .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. 2 Click Manage Servers.

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

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

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

Client seeks in a stream and NetStream. This event occurs if an Authorization plug-in is present to handle the event.inBufferSeek=false. This event occurs if an Authorization plug-in is present to handle the event. The seek position when the client seeks within the buffer when NetStream. Client stops recording a stream. Use the x-sid field (stream id) with the c-client-id field to find the corresponding play event. 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. A virtual host has stopped An application instance has started. the client sends a “seek” event. The stream position is logged in the “c-spos” field.Last updated 3/2/2010 FLASH MEDIA SERVER 3.inBufferSeek=true and the client seeks outside the buffer. A virtual host has started. Client pauses stream. The stream position is logged in the “cspos” field.115. An application instance has stopped.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. Client jumps to a new location within a recorded stream. This command asks the server to transmit more data because the buffer is running low.0 and Flash Media Server 3 and later. The server received a “startTransmit” command. This event occurs if an Authorization plug-in is present to handle the event. Server has started. Client resumes playing stream. Client smart unpauses a stream. Client stops playing or publishing a stream. This type of pause is called a “smart pause”. This event occurs if an Authorization plug-in is present to handle the event. Client begins recording a stream. Also fires when NetStream. Client plays a stream.inBufferSeek=true (called a “smart seek”). Client connects to server. The stream position is logged in the “c-spos” field.0. If a client seeks outside the buffer. The server received a “stopTransmit” command. Server has stopped. This command asks the server to suspend transmission until the client sends a “startTransmit” event because there is enough data in the buffer. Client publishes a live 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 . Smart pause requires Flash Player 9.

” “Pacific Daylight Time. For a complete description of the x-status codes and descriptions. see “Fields in diagnostic logs” on page 64. Application instance name. Time zone information. and xsname fields. Duration of a stream or session event. Time the event occurred. For a stream. Memory usage (as reported by the getServerStats() method). IP address or addresses of the server. the data is wrapped in double quotation marks. Event-dependent context information. auth-record authorization codecchange authorization Fields in access logs Note: When the data for this field contains a space or delimiter. This applies to the tz. this value is the number of seconds the stream has played. Application names. Adaptor name. The double quotation marks surrounding the data are not part of the data. Logs data to the “x-codec-type” and “x-codec” fields. this value is the number of seconds the client has been connected. x-adaptor. Event category. x-status c-ip . Date of the event. This event occurs if an Authorization plug-in is present to handle the event.” 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. Virtual host name. x-vhost. cs-bytes. This event occurs if an Authorization plug-in is present to handle the 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. c-user-agent. s-uri. x-ctx. but are present for better parsing of the data. For a session. Client begins recording a stream. sc-bytes. CPU load. c-referrer. The publisher codec changes during a live event. Server process ID. 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.Last updated 3/2/2010 FLASH MEDIA SERVER 3. This event occurs if an Authorization plug-in is present to handle the event. Client IP address.

The value of sc-stream-bytes can be greater than x-file-size after streaming files not encoded in FLV format. This is a composite field: cs-uri-stem + x-sname + x-file-ext. To calculate the bandwidth usage per stream. Stream type (FLV. MP3. 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. Stream length. Note: The value of sc-stream-bytes is not necessarily the same as the value of the QoS ByteCount property. or MP4). . The query portion of s-uri.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. subtract sc-stream-bytes in the “play” event from sc-stream-bytes in the “stop” event. Client ID. The stem portion of the s-uri field. Query portion of the stream URI specified in play or publish. This field shows the number of bytes transferred from the client to the server per stream. User agent. This information can be used to bill customers per session. such as Flash Player Group: Connection between an edge and an origin server Virtual: Client connection that goes through an edge server. sc-bytes This field shows the number of bytes transferred from the server to the client. Full path of the file representing the x-sname stream.Last updated 3/2/2010 FLASH MEDIA SERVER 3. in seconds. such as MP3 files. URI of the referrer. in bytes. Same as x-sname-query. To calculate the bandwidth usage per session. 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. Stream position. This information can be used to bill customers per session. To calculate the bandwidth usage per stream. subtract cs-stream-bytes in the “publish” event from csstream-bytes in the “unpublish” event. x-service-name Name of the service providing the connection (only applicable to certain connection types). Stream size. This is a composite field: cs-uri-stem + x-sname + x-file-ext + x-sname-query. in milliseconds. This field shows the number of bytes transferred from the client to the server. To calculate the bandwidth usage per session. sc-stream-bytes This field shows the number of bytes transferred from the server to the client per stream. URI of the Flash Media Server application. subtract cs-bytes in the “connect” event from cs-bytes in the “disconnect” event.

play. Codec type of the frame retrieved in the Authorization plug-in’s E_CODEC event. This field is only available in authorization (auth-) events. publish. record stop. This event is visible only in the auth. The transition mode sent by the client in the NetStream. Bad request. This field is empty in the access. An event ID received by Authorization plug-in. Client disconnected due to server shutdown (or application unloaded). The maximum file size of a recorded stream.log file. 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. status_OK record.play2() call. play status_transition status_unavailable status_bad_request 200 210 302 400 A transition between streams has occurred. Connection rejected by application script or access denied by application. The name of the stream that the server transitions from (the original stream). Name of the plug-in. connect. publish. stop connect connect.log file. This event is visible only in the auth. unpublish. the offset value indicates where to resume streaming.log file. The ID of a stream.log file. Client disconnected due to admin command. invalid parameter or client connected to server using an unknown protocol. When a stream is reconnected. This field is empty in the access. stop play. Comments. play.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. connect. This event is visible only in the auth. The URL of the web page in which the client SWF file is embedded. Application currently unavailable. The query stream portion of the stream name for the stream that the server transitions from. Successful. Codec value of the “x-codec-type” retrieved in the Authorization plug-in’s E_CODEC_CHANGE event. The file extension portion of the stream name for the stream that the server transitions from. x-codec-type x-codec Event status codes in access logs The Event status codes are based on HTTP response codes.log file. This field is empty in the access. This ID is unique for the client session but not across sessions. Connection rejected by Authorization plug-in or connection rejected due to invalid URI.Last updated 3/2/2010 FLASH MEDIA SERVER 3.log file. publish status_unauthorized 401 connect status_forbidden 403 . The maximum duration of a recorded stream. The client stream position when a “client-pause” or “client-seek” event is logged.

publish Symbol object_not_found client_disconnect status_conflict Status Code 404 408 409 Description Application or stream not found. Upstream connection closed. Can also mean that a change has been made by the Authorization plug-in. SWF verification failure. Bad gateway.5 CONFIGURATION AND ADMINISTRATION GUIDE 62 Monitoring and Managing Log Files Field connect. play play connect. disconnect the client. play connect server_internal_error bad_gateway 500 502 . Unable to obtain ping response or client states not connected. Client is not connected or client terminated. Client disconnected due to incompatibility with object encoding. Expected response not provided when command was issued. connect play. Stream stopped because client disconnected. License to receive screen sharing video failed. Message queue too large. Unable to process unknown data type. Upstream connection closed because the last client disconnected.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Expected response not provided when issued an admin command. Error handling message. Resource limit exceeded or stream is already being published. Server internal error. Close downstream connection. Unable to process message received when client connection was in pending or closed state. 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. Flash Media Server autoclose feature automatically closed the connection. Client connection invalid. Unsupported media type. Client does not have privilege to broadcast. License limit exceeded. SWF verification timeout. Expected response not provided when command issued. closed due to inactive or idle status. unable to write data.

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

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

as follows: (w) = warning (e) = error (i) = information (d) = debug (s) = trace from server-side script (_) = unknown The next three characters represent category. All message IDs are listed in “Diagnostic Log Messages” on page 196. 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 . x-stx All Event-dependent context information. The first three characters represent severity. The last four characters represent message ID. All categories are listed in “Status categories in diagnostic logs” on page 65. Status code: The code is a 10-character string that represents the severity. and message ID. category.Last updated 3/2/2010 FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 65 Monitoring and Managing Log Files Field x-pid x-status Event(s) All All Description Server process ID.

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

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

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

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

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

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

Warnings are logged to the stdout file in the following format: Date. Warning Message. 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 cannot play back the track.. Found duplicate video track.Last updated 3/2/2010 FLASH MEDIA SERVER 3.. Unsupported DRM scheme. Found duplicate audio track.. Ignoring. Found incomplete track. Flash Media Server ignores (will not play back) tracks that are encoded with unsupported codecs. Track has unsupported sample type. File contains unexpected movie fragments. Invalid chapter time. and File Name. Found duplicate data track. Truncated box. canSeekToEnd is false. Invalid sample size. This warning indicates that a track has an invalid video codec.. -108 MP4 Invalid video codec. Time. Flash Media Server will ignore the error that caused the warning and continue to load and play back the video or audio file. warnings are informative and are not fatal errors. Unrecognized box. . but you may experience problems with playback. Invalid movie time scale. Box is too large. Too many tag boxes. Duplicate box. Invalid box version. File appears to be FLV with wrong extension. FLVCheck warnings Generally. Invalid number of data entries in box.. Max is 64. Error reading MP4 tables. Warning Number.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. Ignoring. Ignoring.. File contains out-of-order movie fragments.

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

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

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

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

bar:456} . use the server address instead of localhost. • Numbers are passed as either integer or floating-point literals."hi"] [10.3. which should be passed without quotation marks.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 3 The server sends the XML results back to the browser: <?xml version="1.34. [1.myCompany.4] ['abcd'.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. the following code calls the addAdmin() method: http://localhost:1111/admin/addAdmin?auser=adminname&apswd=adminpassword&username="joe"&pa ssword="pass123"&vhost="_defaultRoot_/foo. {foo:123. You can use either single quotation marks (') or double quotation marks (").03 -45 Note: When a number is used for an application name.ini file. For example. 245 1.40] • Objects are passed as inline object literals.com" • Strings are passed as literals surrounded by quotation marks. This example uses a web browser because it’s the simplest client and good for testing purposes.20. • Arrays are passed as comma-separated values enclosed in square brackets.Call.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. Substitute your administrator user name and password.[31. which are located in the fms.0" encoding="utf-8" ?> <result> <level>status</level> <code>NetConnection. Parameters passed in an HTTP request must adhere to the following formatting rules: • Name the parameters in the string.2. 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. Note: You can construct an Administration API call from any language that can send HTTP requests.32]. the application name must be included within quotation marks (" ") for methods such as reloadApp() and unload App() to work properly. "Hello World" 'String2' The only exceptions are the auser and apswd parameters.

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

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

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

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

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

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

The IP address can be explicitly configured and does not need to be the IP of the Flash Media Server machine. (This allows RTMPT connections to be redirected to a different server. even if the <HTTPIdent2> tag or the enabled attribute is missing.) If the tag is left empty. 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.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 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). an HTTP 404 response is sent in response to an HTTP GET request. the HTTPNull function is disabled. Example <HTTPIdent2 enabled="true">10. The default value is false. HTTPTunnel. 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. the HTTPIdent2 function must be enabled. If HTTPNull is disabled and the webserver is enabled. If a single RTMPT session consists of multiple socket connections. By default.133. HTTPUserInfo HTTPNull Configures the server to respond to or reject an HTTP GET request for the “/” resource from a client. HTTPTunnel.128. requests for the "/" resource are passed to the webserver. When the enable attribute is set to true. 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). Attributes enable A Boolean value. the IP address is determined automatically.71</HTTPIdent2> See also HTTPNull. RTMPT (Tunnelled Real-Time Messaging Protocol) can have difficulties working with load balancers. Using <HTTPIdent2> enables Flash Player to send a special HTTP request before connecting to Flash Media Server. This function is available when using Flash Player Update 3 or later. each connection may be sent to any one of many Flash Media Servers behind load balancers. Example <HTTPNull enable="false"> . 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. This feature is enabled by default.

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

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

See also HTTPTunnel .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. UpdateInterval MaxWriteDelay The HTTP tunnelling protocol ensures that a server will be able to write every four 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. The default wait time is 40 seconds. when connections close under abnormal conditions. the notification may not reach the server. Anomalous connections are closed after the specified wait time. Example <MaxSize>100</MaxSize> See also Path. the server reduces the cache.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The default number of failures is 2. By default. the value is 100. which may continue to place writes in a queue. When the cache size reaches the maximum size. Occasionally. Example <MaxFailures>2</MaxFailures> See also IdleAckInterval MaxSize Specifies the maximum number of HTTP requests the server keeps in the cache.

and 0-9. The server uses the entry for the MIMEType element only if it is unable to determine the MIME type from the incoming requests. The alternative sequence Deny.Allow indicates that access to a server is allowed unless specified in the Deny element and not specified in the Allow element. 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. The ID must contain URL-safe characters: alphanumerical A-Z. Example The following is the default sequence: <Order>Allow. The server generally uses the MIME type specified by the incoming requests.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. which closes the connections.Deny</Order> The default sequence indicates that access to a server is denied unless it is specified in the Allow element. The following is the default sequence: <Order>Allow. and the special characters $-_. a-z.Deny</Order> . The default value is true. Example <MimeType>application/x-fcs</Mimetype> See also HTTPTunnel NeedClose A Boolean value specifying whether or not HTTP 1.+!*'() See also HTTPTunnel Order Specifies the sequence in which the server evaluates the Allow and Deny elements.Last updated 3/2/2010 FLASH MEDIA SERVER 3.0 non-keepalive connections are closed once the response is written. Example <NeedClose>true</NeedClose> See also MaxWriteDelay NodeID Specifies a unique node identification that supports the implementation of load balancers. If the NodeID element is used.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The default is true. See also SWFVerification FlushOnData Specifies whether the server flushes the message queue when a data message arrives. which allows access to a particular directory. MaxQueueSize. 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. MaxQueueDelay. This allows two levels of permissions: file-level access (a value of false). The VirtualDirectory element nested within this container configures the JSEngine file object settings. 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.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Example <HiCPU>80</HiCPU> . so the server can send out the messages immediately. and folderlevel access (a value of true). The default percentage of utilization is 80. See also Queue.5 CONFIGURATION AND ADMINISTRATION GUIDE 106 XML configuration files reference FileObject Container element. 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. AccumulatedIFrames FolderAccess Configures the level of permission that the Access plug-in can set for accessing streams and shared objects. which allow access to a particular file only. This element is important for streaming data-only messages.

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

IdleAckInterval. MimeType.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. 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. If the IdlePostInterval element is set to a value that lies outside of this range. the server will not be able to send any data to the client for the selected duration. The interval cannot be set to a negative value. This interval implies that the client may not be able to reach the server for the selected duration.Last updated 3/2/2010 FLASH MEDIA SERVER 3. The interval for an idle post ranges from 0 to 4064 milliseconds. Example <IdlePostInterval>512</IdlePostInterval> . MimeType. Example <IdleAckInterval>512</IdleAckInterval> See also IdlePostInterval. Idle posts are sent when Flash Player has no data to send. the default value of 512 milliseconds is used. 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. 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. Note: At times.

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

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

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

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

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

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

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

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

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

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

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

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

See also Host. See also Host. Note that older clients might not support chunk sizes larger than 1024 bytes. The server breaks stream content into chunks of this size.Last updated 3/2/2010 FLASH MEDIA SERVER 3. MsgQueue. SendDuplicateOnMetaData Password Specifies the password for connecting to the proxy. If the chunk setting is larger than these clients can support. The default value is 4096.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. BandwidthDetection. see the PublishTimeout element. Example <OutChunkSize>4096</OutChunkSize> See also Bandwidth. Type. 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. The default value is false. If set to true. Username Port Specifies the proxy port to connect to if the port is not specified as part of the host in the Host element. Tunnel. Larger values reduce CPU usage but cause larger writes that can delay other content on lower bandwidth connections. MaxMessageSizeLosslessVideo OverridePublisher Deprecated. SendDuplicateStart. This can have a minimum value of 128 bytes and a maximum value of 65536 bytes. BandwidthCap. Tunnel. Username . the chunk setting is capped at 1024 bytes. Port. Type. Live (StreamManager). Example <OverridePublisher>true</OverridePublisher> See also Audio. HTTPTunnel. Password. add application logic to avoid stream name collision.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The default value is Apache2. SocketOverflowBuckets Edge (ResourceLimits) Container element. MaxIOThreads. SocketTableSize.5 CONFIGURATION AND ADMINISTRATION GUIDE 147 XML configuration files reference Directory Located in the Httpd container.Last updated 3/2/2010 FLASH MEDIA SERVER 3. DirLevelSWFScan Specifies the number of levels of subfolders within a parent folder to scan for SWF files. The elements nested within the ECCP container configure ECCP (Edge Server-Core Server Communication Protocol). Contained elements MaxEventQueueThreads. MaxIOThreads. SocketTableSize. See also SWFFolder ECCP Container element. The parent folder is specified in the SWFFolder element. Specifying zero scans the parent folder and no subfolders.2. . MinEventQueueThreads. The default value is 1. Specifying a negative value scans all subfolders. Contained elements MinIOThreads. Contained elements MinIOThreads. The elements nested within the Edge container configure the RTMP protocol for the fmsedge process. The elements nested within the Edge container configure resources for the fmsedge process. SocketOverflowBuckets. CoreTimeout Edge Container element. 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. 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. NumSchedQueues EdgeCore Container element. The directory containing the web server. which means that the server scans only one subfolder level. Specifying a positive value scans that number of subfolders.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The value for this element is server or vhost. FreeRatio. MaxIOThreads. Setting this element to false prohibits RTMPE and RTMPTE from being used. Specifies whether Encrypted Real-Time Messaging Protocol (RTMPE) can be used to connect to the Administration Server. . RTMP is the protocol used for communication between Flash Player and Flash Media Server. This element determines whether to write a separate log file for each virtual host or to write one log file for the server.Last updated 3/2/2010 FLASH MEDIA SERVER 3. MaxUnitSize. Contained elements Edge. FreeMemRatio Server Container element. SocketRcvBuff RTMPE Located in the RTMP container. 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. MinConnectionThreads. Contained elements MinIOThreads.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. MaxAge. Admin. MaxCacheSize. Scope Located in the Logging container. (RTMPE also covers RTMPTE. NumCRThreads. SocketSndBuf. MaxConnectionThreads. MaxConnectionQueueSize RTMP (Protocol) Container element. which enables logging for all processes on the server. The default is server. Core. This container holds the elements that configure RTMP (Real-Time Messaging Protocol). GlobalRatio. UpdateInterval.) The default value is true. Allocates 1xN threads. Allocates 2xN threads. SegmentsPool Container element. Contained elements MaxCacheUnits.

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

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

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

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

SSLVerifyDepth. SSLCACertificatePath.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.Last updated 3/2/2010 FLASH MEDIA SERVER 3. SSLCipherSuite SSLRandomSeed Located in the SSL container. Specifies how often to flush expired sessions from the server-side session cache. Contained elements SSLVerifyCertificate.0 ciphers All SSL version 3.0 ciphers All ciphers using DSS authentication SSLClientCtx Container element. 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. Example <SSLRandomSeed>ALL:!ADH:!EDH</SSLRandomSeed> . Configures the server to act as an SSL-enabled client by securing the outgoing connections. SSLCACertificateFile.

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

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

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

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

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.10.10. <Deny>foo.133. .60</Deny> See also Password.yourcompany. Example This example lists the computers sending connection requests that Flash Media Administration Server will not accept. This element lists those hosts from which the administrator is not authorized to connect to Flash Media Administration Server. Allow (HTTPCommands). Deny (HTTPCommands).com. Example <Enable>true</Enable> See also Allow (HTTPCommands). 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.1.Allow</Deny> See also Enable.com. Order (HTTPCommands) HTTPCommands Container element.adobe. do not set this element. 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. This Deny element lists the Flash Media Administration Server commands that an administrator cannot use through HTTP. Order (User) Enable This element enables or disables the use of HTTP requests to execute administrative commands. To disable administrative access through the use of HTTP requests.60. Example <Deny>Deny.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Allow (User).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. Setting this element enables HTTP requests to execute administrative commands.

Contained elements Enable.Last updated 3/2/2010 FLASH MEDIA SERVER 3. <Order>Allow.Allow</Order> See also Password. <Order>Deny. 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. Allow (User). Deny means the HTTP command is allowed if it is in the Allow list of commands and not in the Deny list. In the following example. When finished. Passwords are usually encrypted. Example The sequence Deny. Specify each Administration API that may be called over HTTP in a commadelimited list. the encrypt attribute instructs the server to encrypt the contents of the password. Deny (HTTPCommands).Deny</Order> See also Enable. the password you see in the file is the encrypted password. and it is interpreted as an encoded string. Passwords cannot be empty strings (""). .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. 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. Specifies the order in which to evaluate the Deny and Allow commands. Specifies the sequence in which Flash Media Server evaluates the Allow and Deny elements for an administrator.Deny</Order> The alternative sequence Deny. restart the server. Allow (HTTPCommands).Allow</Order> The sequence Allow. Deny (User) Password Specifies the password for vhost administrators. The default value is ping. Deny (HTTPCommands) Order (User) Flash Media Server uses two Order elements: one in the HTTPCommands container. Order (HTTPCommands) Order (HTTPCommands) Flash Media Server uses two Order elements: one in the HTTPCommands container and another in the User container. <Order>Deny. Allow (HTTPCommands). When the encrypt attribute is set to true. Allow means the HTTP command is allowed if the command is in the Allow list of commands or not in the Deny list. and the other in the User container. Example The default sequence Allow.

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

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

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

MaxEdgeConnections. see “Mapping directories to network drives” on page 34 for additional information. • 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. Note: If you use this tag to map to a network drive. RouteTable.Last updated 3/2/2010 FLASH MEDIA SERVER 3. You define an application by creating a subdirectory with the application name. the default AppsDir location is C:\Program Files\Adobe\Flash Media Server 3. • In Linux. You can create a chain of proxies by specifying them in the URI.5\applications. MaxAppInstances. Streams. MaxStreams.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. • In Windows. LocalAddress. • The URI for an explicit proxy specifies the edge server(s) that will intercept connection requests to the origin server. The default interval is 1 minute. such as Shared Objects. • 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. and Script engines. The Applications directory is the base directory where all applications for this virtual host are defined. without modification. AggregateMessages AppInstanceGC Specifies how often to check for and remove unused resources for application instances. CacheDir. EdgeAutoDiscovery. • Any anonymous proxy in the chain passes on. • 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 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. . Example <Anonymous>falsetrue</Anonymous> See also Mode. Example <AppInstanceGC>1</AppInstanceGC> See also MaxConnections. the default location is /opt/adobe/fms/applications.

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

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

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

The default value is 3600 seconds (60 minutes). . 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. A chat application. See also MaxAggMsgSize Specifies the size in bytes of aggregate messages returned from the edge cache.) The default size is 65.536. Contains elements that control logging. This value should be larger than the value for CheckInterval. because each chat room represents a separate instance of the application on the server. the server logs a checkpoint every check interval. This strategy is useful when configuring an edge to either transparently pass on or intercept requests and responses. The LocalAddress element lets you allocate incoming and outgoing connections to different network interfaces. for example. If the LocalAddress element is not specified. then outgoing connections bind to the value of the INADDR_ANY Windows system variable. in seconds. This setting only applies to messages retrieved from the disk cache.000 application instances. Example <MaxAggMsgSize>66536</MaxAggMsgSize> See also AggregateMessages MaxAppInstances Specifies the maximum number of application instances that can be loaded into this virtual host. If the value is smaller. 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. The default number is 15.Last updated 3/2/2010 FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE 185 XML configuration files reference LocalAddress This element binds an outgoing edge connection to a specific local IP address. (Aggregate messages must be enabled. See also Proxy Logging Container element. might require more than one instance.

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

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

LocalAddress. 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. Anonymous. Note: Whenever a virtual host is configured as an edge server. You can also add the protocol attribute to an individual RouteEntry element to specify how the edge server reroutes requests. however. This value -1 specifies an unlimited amount of time (no timeout).Last updated 3/2/2010 FLASH MEDIA SERVER 3. the SSL connection to upstream servers will use the default configuration specified in the SSL section of the Server. The default value is 2 seconds. EdgeAutoDiscovery. the server waits for a response to a request from an upstream 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. A request can be for metadata. in seconds. RequestTimeout RequestTimeout The maximum amount of time. MaxEdgeConnections. MaxSharedObjects. Contained elements MaxConnections.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. RouteTable. The RouteTable element contains the RouteEntry elements that control where the edge server reroutes requests. and so on. The connection syntax for this element is flexible. MaxStreams. If no protocol is specified. Flash Media Server applies the protocol specified in the RouteTable element. AggregateMessages. content. Contained elements Mode. SSL. AppInstanceGC. . See also CacheDir ResourceLimits Container element. Examples This example shows how you can configure the edge to route all connections to the host foo to the host bar. 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. CacheDir. it behaves locally as a remote server. MaxAppInstances. as demonstrated in the following examples. Edge servers are configured with the RouteEntry element to direct connections to another destination. Implicit proxies hide the routing information from the clients.xml file.

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

Note: When Flash Media Server is running in local mode as an origin server.xml file override the SSL elements in the Server.xml file to configure the connection. Flash Media Server uses the SSL elements in the Vhost. The Windows certificate store can be imported into this directory by running FMSMaster .initialize from the command line. Flash Media Server uses the default values for SSL in the Server. . 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. 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. SSLVerifyCertificate. the following sequence of events takes place: • The SSL elements in the Vhost.Last updated 3/2/2010 FLASH MEDIA SERVER 3. You can also override the configuration for outgoing SSL connections for an individual virtual host in Vhost.xml file.xml by copying the SSL elements in Server. For Win32 only: If this element is empty.xml file. • If the SSL elements in the Vhost.xml file are evaluated first. Contained elements SSLCACertificateFile.xml to configure the SSL connection to upstream servers.xml file are not present.xml file to configure the connection. When Flash Media Server acts as a client to make an outgoing SSL connection. see SSL. Each file in the directory must contain only a single CA certificate.xml file is not evaluated. • If the SSL elements in an edge’s Vhost. For more information on the SSL elements in Server.xml. SSLCACertificatePath. SSLCACertificatePath Specifies the name of a directory containing CA certificates. 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. SSLCipherSuite. the SSL information in the vhost. File names must be the hash with “0” as the file extension. 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. • If the SSL elements in the Vhost. then you must enable this section and configure its SSL elements appropriately.xml to the corresponding SSL section in the Vhost.xml file.xml file match the SSL elements in the Server.console .

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

Last updated 3/2/2010 FLASH MEDIA SERVER 3. <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. and reject export-strength versions. with the high being preferred.5 CONFIGURATION AND ADMINISTRATION GUIDE 192 XML configuration files reference This string instructs the server to accept only high. DES) 128-bit encryption Triple-DES encoding . <SSLCipherSuite>ALL:+SSLv2</SSLCipherSuite> The following is the complete list of components that the server can evaluate.and medium-strength 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 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.

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

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

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

Failed to start the following listeners for adaptor %1$S: %2$S. Server starting. The call method failed. Failed to stop virtual host (%1$S).xx. Dropping application (%1$S) message. IP %2$S.log. Method not found (%1$S). Message IDs can be useful for administrators who want to write error-handling scripts. Ignoring message from client during authentication.. Missing unlock for shared object %1$S.log) record information about server operations. Nested lock for shared object %1$S.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.log. service will be stopped. edge.xx. rejecting message (%1$S). and httpcache. Service Control Manager reported (%1$S: %2$S). Unlock called without matching lock for shared object %1$S. server shutdown in progress.xx. Error during shutdown process. port %3$S: %4$S. server shutdown in progress. Service Control Manager failed (%1$S: %2$S). Reinitializing server. Received interrupt signal. Command name not found in the message. invalid parameters: call(methodName[. Failed to execute method (%1$S). Asynchronous I/O operation failed (%1$S: %2$S). Failed to create listener for adaptor %1$S.log. resultObj. admin. Invalid application. core. Failed to create thread (%1$S). Server stopped %1$S. see “Access logs” on page 57 and “Application logs” on page 63. p1. or users that you can use for debugging. 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. For status codes related to applications. lock count %2$S.. Server initialization failed. Clients not allowed to broadcast message. . process will be terminated. Response object not found (%1$S). Failed to stop %1$S listeners for adaptor %2$S. pn]). instances.xx.log. lock count %2$S.xx.

Parse error at line %1$S: %2$S. Unknown %1$S command issued for stream %2$S (application %3$S). Rejecting connection from %1$S to %2$S. Read access denied for stream %1$S. Unable to create shared object: %1$S. Administrator login failed for user %1$S. Failed to start server. Failed to start virtual host (%1$S). Resource limit violation. Invalid user ID (%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. Failed to open configuration file: %1$S. No adaptors defined. Failed to change password: %1$S. Connect failed ( %1$S. NetConnection. Alive. Exception while processing message. Connect from host (%1$S) not allowed. Read access denied for shared object %1$S. Write access denied for stream %1$S. Unable to create stream: %1$S.Call. Invalid proxy object.Failed Invalid application name (%1$S). . %2$S ): %3$S. Adaptor already defined with the name %1$S. Virtual host %1$S is not available. Resource limit violation. Write access denied for shared object %1$S. Reserved property (%1$S). Failed to remove administrator: %1$S. Failed to create administrator: %1$S.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Invalid parameters to %1$S method. Illegal subscriber: %1$S cannot subscribe to %2$S. Admin request received from an invalid Administration Server. connection may be lost (%1$S). Script execution is taking too long. terminating connection: %1$S. Bad network data.

Failed to unload application %1$S. Started playing %1$S. Stream %1$S has been idling for %2$S second(s). Unpausing %1$S. stream ID: %1$S.CommandFailed Invalid parameters to %1$S method. Audio receiving enabled (stream ID: %1$S). Connection rejected: maximum user limit reached for application instance %1$S. %1$S is now unpublished. Error registering class: name mismatch (%1$S. Failed to record %1$S.Admin. %1$S is now published.Last updated 3/2/2010 FLASH MEDIA SERVER 3. %3$S) : Failed to load application instance %1$S. NetStream deleted (stream ID: %1$S). Pausing %1$S. Illegal access property (%1$S). Publishing %1$S. %2$S). Invalid virtual host alias : %1$S. (%2$S. Failed to load application %1$S. . Stopped playing %1$S. Failed to play %1$S (stream ID: %2$S). Admin user requires valid user name and password. Failed to play (stream ID: %1$S). Failed to publish %1$S. Recording %1$S. %3$S) : Connection rejected to application instance %1$S. Connection to Flash Media Server has been disconnected. Audio receiving disabled (stream ID: %1$S). %1$S applications unloaded. New NetStream created (stream ID: %1$S). Client already connected to an application. Stopped recording %1$S. Playing and resetting %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. (%2$S. Play stop failed. Failed to restart virtual host (%1$S).

Unknown exception caught in %1$S. Video receiving enabled (stream ID: %1$S). Invalid method name (%1$S). Failed to open shared object file (%1$S) for write. Failed to receive video (stream ID: %1$S). Flash Media Server is already running or other processes are using the same ports. VHost: %2$S. Configuration error for adaptor %1$S: IP %2$S and port %3$S are already in use. Invalid NetStream ID (%1$S). Failed to initialize listeners for adaptor %1$. Video receiving disabled (stream ID: %1$S). Failed to flush shared object (%1$S). Failed to open shared object file (%1$S) for read. Take action. Connection succeeded. JavaScript engine runtime is low on free memory. Invalid schedule event format (%1$S). Server started (%1$S). %3$S): Invalid application name (%1$S). Check the JavaScript runtime size for this application in the configuration file. stream not found. JavaScript runtime is out of memory. App: %3$S). Seeking %1$S (stream ID: %2$S). Failed to seek %1$S (stream ID: %2$S). Failed to create adaptor: %1$S.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Failed to start listeners for adaptor %1$S. Connection failed. server shutting down instance (Adaptor: %1$S. Invalid stream name (%1$S). Failed to seek (stream ID: %1$S). Insufficient admin privileges to perform %1$S command. (%2$S. Set video fps to %1$S (stream ID: %2$S). Configuration file not found: %1$S Invalid configuration file: %1$S Server aborted.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). Failed to play %1$S. 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 . Invalid shared object (%1$S). Failed to stop playing (stream ID: %1$S).

Invalid license key: %1$S License key specified does not allow multiple adaptor support.Success Unable to locate server configuration file during startup. Invalid admin command: %1$S. Script is taking too long to process the event. (%2$S. (%2$S. shared object(%1$S) lock reset to unlocked. Failed to load admin application.AccessDenied NetConnection. invalid arguments. (%2$S. %3$S): Resource limit violation.Call. %3$S): Resource limit violation. Rejecting connection. Unable to load new application: %1$S. Server shutting down. shared object (%1$S) has been locked for %2$S sec.Call. Multiprocessor support available only in Enterprise Edition. . Invalid shared object file (%1$S). %3$S/%1$S): Current server bandwidth usage exceeds license limit set. (%2$S.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). (%2$S. Server shutdown failed. %3$S): Resource limit violation. Shutting down instance: %1$S. Beta expired. Unable to create directory %1$S. Unable to locate script file: %1$S. Preload application aborted.Last updated 3/2/2010 FLASH MEDIA SERVER 3.BadValue Publish %1$S failed. Failed to play %1$S. %3$S): Application (%1$S) is not defined. Potential deadlock. Admin command setApplicationState failed for %1$S. Invalid object name (stream ID: %1$S). Breaking potential deadlock. %3$S): Application (%1$S) is currently offline. Unable to create new application instance: %1$S.Call. Trial run expired. index file not found or mismatch. License key specified does not allow multiple virtual host support. NetConnection. Rejecting connection. (%2$S. NetConnection. invalid arguments. %3$S/%1$S): Current virtual host bandwidth usage exceeds max limit set. Rejecting connection to: %1$S. (%2$S. Command successful. Pause %1$S failed.

System memory load (%1$S) is now below the maximum threshold. System memory load (%1$S) is high.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Out of memory: %1$S. %3$S): Max connections allowed exceed license limit. Listener started (%1$S): %2$S. Failed to execute admin command: %1$S. Invalid value set for configuration key: %1$S = %2$S. Unloaded application instance %1$S. Info from %1$S:%2$S. Failed to initialize cryptographic accelerator: %1$S. Rejecting connection to: %1$S. Error from %1$S:%2$S. Attempt to reconnect to Flash Media Server. Unknown exception occurred. adaptor not found: %2$S. Client to server bandwidth limit exceeded. Instance will be unloaded: %1$S. Failed to seed the pseudorandom number generator. Exception caught in %1$S while processing streaming data inside %2$S. using %3$S. (%2$S. [Virtual host (%1$S). Generic message code.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. Exception while processing message: %1$S. Pending queue size limit %1$S reached. Max Allowed %2$S. Rejecting connection request Host: %2$S:%3$S. Failed login attempt from %1$S at %2$S. Current %3$S] . Restarting listener (%1$S): %2$S. Adaptor (%1$S) has an SSL configuration error on port %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. Failed to remove application: %1$S. Invalid shared object name (%1$S). Warning from %1$S:%2$S. Failed to play %1$S. Invalid cryptographic accelerator: %1$S. Failed to record %1$S. no space left on device. An internal version control error has occurred.

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

Core (%1$S) disconnected: %2$S. Connection from core %1$S received. Process (%1$S): failed to map view of shared memory (%2$S). Core (%1$S) disconnected from edge. Command (%1$S) timed out. Core (%1$S) failed to establish proxy to edge. Registering core (%1$S). Starting admin app on core (%1$S). Connection from core %1$S accepted. Killing core now. 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. Socket migration to core (%1$S) failed. Core (%1$S) sending register command to edge. Core (%1$S) connection to admin accepted. Core (%1$S) connecting to admin. Core (%1$S) disconnecting from admin. Core (%1$S) socket migration failed. Recovering core %1$S with %2$S failure[s] after %3$S seconds! Core (%1$S) did not shut down as expected. Edge disconnected from core (%1$S). Process (%1$S): shared memory (%2$S) init failed. Core (%1$S) failed to connect to admin. .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.Last updated 3/2/2010 FLASH MEDIA SERVER 3. Connection to admin received. Core (%1$S) connected to admin. Core (%1$S) connection to admin failed. Core (%1$S) shutdown failed. Core (%1$S) received close command from admin. create a new one. Core (%1$S): Failed to initiate connection to admin. Failed to send connect response to core %1$S. Proxy to core (%1$S) failed.

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

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 . defining 31 Application.xml file description of tags 93 Application.xml file description of tags 80 file structure 80 Adaptor.Last updated 3/2/2010 205 Index A access logs 29. 57. 38 application instances about 6 log messages 43 performance 47 reloading 43 view in Administration Console 42 application logs 63 Application object. 59 Adaptor.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.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml 140 symbols in 10 Users. 57 clients closing idle connections of 14 limiting connections from 14 view active 45 clusters 1 configuration files Adaptor. using 23 CrossDomainPath (Server.xml 178 connections closing idle 14 limiting 14.xml 93 directory structure 6 editing 9 Logger. in video files 71 Event Viewer (Windows) 67 . native 32 C CGI programs 39 checkpoint events 29. combining 13 B backing up log files 56 bandwidth detection.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 175 Vhost.xml) 23.xml 80 Application. 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 133 Server.

xml tags Access 134.xml tags Access 140.5 CONFIGURATION AND ADMINISTRATION GUIDE 207 Index F FLV errors 71 FLV files. configuring 16 Server.xml file 55. 135. checking 69 FLVCachePurge (Server. 179 ACCP 140 ActiveProfile 141 Admin 141 AdminElem 141 AdminServer 141 Allow 141 Application 142 ApplicationGC 142 AuthEvent 143 AuthMessage 143. 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 . 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.xml file configuring 55 description of tags 133 file structure 134 Logger. 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. 136. on Linux 74 performance 51 starting and stopping 66 testing 67 viewing events 67 server processes. configurable 31 P performance improving 12 monitoring server 51 permissions administration APIs 76 for administrators 175 PublishTimeout (Application.Last updated 3/2/2010 FLASH MEDIA SERVER 3.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. 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) 123 R RecordsNumber 164 refresh rate 41 RetryNumber 165 RetrySleep 165 rotating log files 56 S scripts.xml) 123 Q QualifiedStreamsMapping (Application. 140 Server.

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. 172 SSLCACertificateFile 169.xml 25. 190 SSLClientCtx 171 SSLRandomSeed 171 SSLSessionCacheGC 172 SSLVerifyCertificate 172.xml tags AggregateMessages 179 Alias 179 AliasList 180 Allow 180 AllowOverride 180 Anonymous 180 . 26 tags in Server. 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. 190 SSLCACertificatePath 169.xml file description of tags 175 file structure 175 permissions for admin APIs 76 summary of tags 175 Users.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 163. 164.xml 28 storage directories 34 storageDir element 34 streams cache size 12 chunk size 13 view live 44 U Users. 28 tags in 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. 168.xml file file structure 179 summary of tags 179 Vhost. 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. 193 SSLVerifyDepth 172.xml 27. 190 SSLCipherSuite 169.

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.xml) 133 .

Sign up to vote on this title
UsefulNot useful