P. 1
flashmediaserver_3.5_config_admin

flashmediaserver_3.5_config_admin

|Views: 685|Likes:
Published by TrixxRO

More info:

Published by: TrixxRO on Mar 12, 2011
Copyright:Attribution Non-commercial

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as PDF, TXT or read online from Scribd
See more
See less

03/12/2011

pdf

text

original

Sections

  • Chapter 1: Deploying the server
  • Deploying servers in a cluster
  • Deploying edge servers
  • Chapter 2: Configuring the server
  • Provisioning the server
  • Configuration folder structure
  • Working with configuration files
  • Configuring performance features
  • 1 “Configure the recorded media cache” on page 12
  • Enable closing idle connections
  • Configuring security features
  • Performing general configuration tasks
  • Configuring content storage
  • Mapping virtual directories to physical directories
  • Configuring Apache HTTP Server
  • Chapter 3: Using the Administration Console
  • Connecting to the Administration Console
  • Connect to the Administration Console
  • Inspecting applications
  • View applications
  • Viewing log messages for an application
  • Manage administrators
  • Add administrators
  • Managing the server
  • Chapter 4: Monitoring and Managing Log Files
  • Working with log files
  • Access logs
  • Application logs
  • Diagnostic logs
  • Chapter 5: Administering the server
  • Start and stop the server
  • Checking server status
  • Checking video files
  • Clearing the edge server cache
  • Managing the server on Linux
  • Chapter 6: Using the Administration API
  • Working with the Administration API
  • Chapter 7: XML configuration files reference
  • Adaptor.xml file
  • Allow
  • Deny
  • Enable
  • EnableAltVhost
  • HostPort
  • HostPortList
  • <HostPortList>
  • </HostPortList>
  • </HTTPIdent>
  • HTTPIdent2
  • HTTPNull
  • HTTPTunnel
  • HTTPUserInfo
  • IdleAckInterval
  • IdlePostInterval
  • IdleTimeout
  • MaxSize
  • MaxWriteDelay
  • MimeType
  • NeedClose
  • NodeID
  • Order
  • Path
  • RecoveryTime
  • Redirect
  • </Redirect>
  • ResourceLimits
  • RTMP
  • RTMPE
  • SetCookie
  • SSLCertificateFile
  • SSLCertificateKeyFile
  • SSLCipherSuite
  • SSLPassPhrase
  • SSLServerCtx
  • SSLSessionTimeout
  • UpdateInterval
  • WriteBufferSize
  • Application.xml file
  • Access
  • Access (Logging)
  • AccumulatedIFrames
  • AggregateMessages (Client)
  • AggregateMessages (Queue)
  • AllowDebugDefault
  • AllowHTTPTunnel
  • Audio
  • AutoCloseIdleClients
  • AudioSampleAccess
  • AutoCommit
  • Bandwidth
  • BandwidthCap
  • BandwidthDetection
  • Bits
  • BufferRatio
  • Cache
  • CachePrefix
  • CacheUpdateInterval
  • Checkpoints
  • Client
  • ClientToServer (Bandwidth)
  • ClientToServer (BandwidthCap)
  • CombineSamples
  • Connections
  • DataSize
  • Debug
  • Diagnostic
  • DirLevelSWFScan
  • Distribute
  • DuplicateDir
  • Duration
  • Enabled
  • EnhancedSeek
  • EraseOnPublish
  • Exception
  • FileObject
  • FinalHashTimeout
  • FirstHashTimeout
  • FlushOnData
  • FolderAccess
  • HiCPU
  • Host
  • HTTP
  • HTTP1_0
  • Interface
  • Interval
  • JSEngine
  • <JSEngine>
  • KeyFrameInterval
  • LifeTime
  • Live (StreamManager)
  • Live (MsgQueue)
  • LoadOnStartup
  • LockTimeout
  • LoCPU
  • LogInterval
  • MaxAggMsgSize
  • MaxAppIdleTime
  • MaxAudioLatency
  • MaxBufferRetries
  • MaxCores
  • MaxDuration
  • MaxDurationCap
  • MaxGCSkipCount
  • MaxFailures
  • MaxInitDelay
  • MaxLatency
  • MaxMessageSizeLosslessVideo
  • <MaxMessageSizeLosslessVideo>0</MaxMessageSizeLosslessVideo>
  • MaxPendingDebugConnections
  • <MaxPendingDebugConnections>50</MaxPendingDebugConnections>
  • MaxProperties
  • MaxPropertySize
  • MaxQueueDelay
  • MaxQueueSize
  • MaxRate
  • MaxSamples
  • MaxSize (AccumulatedIFrames)
  • MaxSize (Recording)
  • MaxSizeCap
  • MaxStreamsBeforeGC
  • MaxTime
  • MaxTimeOut (Connections)
  • MaxTimeOut (JSEngine)
  • MaxUnprocessedChars
  • MinBufferTime (Live)
  • MinBufferTime (Recorded)
  • MinGoodVersion
  • MsgQueue
  • NetConnection
  • ObjectEncoding
  • OutChunkSize
  • OverridePublisher
  • Password
  • Port
  • Prioritization
  • Proxy
  • PublishTimeout
  • QualifiedStreamsMapping
  • Queue
  • Recorded
  • ResyncDepth
  • Reuse
  • RollOver
  • RuntimeSize
  • Scope
  • ScriptLibPath
  • SendDuplicateOnMetaData
  • SendDuplicateStart
  • SendSilence
  • Server
  • ServerToClient (Bandwidth)
  • ServerToClient (BandwidthCap)
  • SharedObjManager
  • StartClockOnPublish
  • StorageDir
  • StreamManager
  • Subscribers
  • SWFFolder
  • SWFVerification
  • ThrottleBoundaryRequest
  • ThrottleDisplayInterval
  • ThrottleLoads
  • Tunnel
  • Type
  • UnrestrictedAuth
  • UserAgent
  • UserAgentExceptions
  • <UserAgentExceptions>
  • Username
  • Verbose
  • VideoSampleAccess
  • VirtualDirectory
  • XMLSocket
  • <XMLSocket>
  • </XMLSocket>
  • Logger.xml file
  • Delimiter
  • Directory
  • DisplayFieldsHeader
  • EscapeFields
  • Events
  • Fields
  • FileName
  • History
  • LogServer
  • QuoteFields
  • Rename
  • Rotation
  • Schedule
  • ServerID
  • Time
  • Server.xml file
  • ACCP
  • Admin
  • AdminElem
  • AdminServer
  • AllowAnyAACProfile
  • AllowAnyAVCProfile
  • AllowedVideoLag
  • Application
  • ApplicationGC
  • AudioAutoBufferReadSize
  • AuthEvent
  • AuthMessage
  • </AutoCloseIdleClients>
  • CheckInterval
  • Connector
  • Content
  • Core
  • CoreExitDelay
  • CoreGC
  • CoreTimeout
  • CPUMonitor
  • CrossDomainPath
  • ECCP
  • Edge
  • Edge (ResourceLimits)
  • EdgeCore
  • EnableAggMsgs
  • FileCheckInterval
  • FileIO
  • FilePlugin
  • FLVCache
  • FLVCachePurge
  • FLVCacheSize
  • FreeMemRatio
  • FreeRatio
  • GCInterval
  • GlobalQueue
  • GlobalRatio
  • HandleCache
  • HeapSize
  • Httpd
  • IdleTime
  • IPCQueues
  • LargeMemPool
  • LicenseInfo
  • LicenseInfoEx
  • Localhost
  • Logging
  • Mask
  • Master
  • MaxAge
  • MaxAudioSampleDescriptions
  • MaxCacheSize
  • MaxCacheUnits
  • MaxConnectionQueueSize
  • MaxConnectionRate
  • MaxConnectionThreads
  • MaxDataSampleDescriptions
  • MaxELSTEntries
  • MaxEventQueueThreads
  • MaxFlushSize
  • MaxFlushTime
  • MaxIdleTime
  • MaxIOThreads
  • MaxKeyframeCacheSize
  • MaxNumberOfRequests
  • MaxSampleSize
  • MaxSize (FLVCache)
  • MaxSize (HandleCache)
  • MaxSize (RecBuffer)
  • MaxTimestampSkew
  • MaxTracks
  • MaxUnitSize
  • <MessageCache>
  • </MessageCache>
  • MaxVideoSampleDescriptions
  • MessageCache
  • MinConnectionThreads
  • MinEventQueueThreads
  • MinIOThreads
  • MsgPoolGC
  • NetworkingIPv6
  • NumCRThreads
  • NumSchedQueues
  • Options
  • OtherAutoBufferReadSize
  • Playback
  • Plugins
  • Process
  • ProcVMSizeMonitorInterval
  • ProcVMSizeNominal
  • ProcVMSizeWarn
  • Program
  • Protocol
  • PublicIP
  • ReadBufferSize
  • RecBuffer
  • Recording
  • RecordsNumber
  • RetryNumber
  • RetrySleep
  • RTMP (AdminServer)
  • RTMP (Connector)
  • RTMP (Protocol)
  • SegmentsPool
  • Service
  • Services
  • SmallMemPool
  • SocketGC
  • SocketOverflowBuckets
  • SocketRcvBuff
  • SocketSndBuf
  • SocketTableSize
  • SSLCACertificatePath
  • SSLClientCtx
  • SSLRandomSeed
  • SSLSessionCacheGC
  • SSLVerifyCertificate
  • SSLVerifyDepth
  • Streams
  • TerminatingCharacters
  • ThreadPoolGC
  • TrimSize
  • UpdateInterval (Cache)
  • UserDefined
  • VideoAutoBufferReadSize
  • VideoAutoBufferReadSize buffer
  • Users.xml file
  • Allow (HTTPCommands)
  • Allow (User)
  • Deny (HTTPCommands)
  • Deny (User)
  • HTTPCommands
  • Order (HTTPCommands)
  • Order (User)
  • User
  • UserList
  • Vhost.xml file
  • AggregateMessages
  • </AggregateMessages>
  • AliasList
  • AllowOverride
  • Anonymous
  • AppInstanceGC
  • AppsDir
  • CacheDir
  • EdgeAutoDiscovery
  • LocalAddress
  • MaxAppInstances
  • MaxConnections
  • MaxEdgeConnections
  • MaxSharedObjects
  • MaxStreams
  • Mode
  • RequestTimeout
  • RouteEntry
  • </RouteTable>
  • RouteTable
  • SSLCACertificateFile
  • <VirtualDirectory>
  • </VirtualDirectory>
  • VirtualKeys
  • WaitTime
  • Chapter 8: Diagnostic Log Messages
  • Message IDs in diagnostic logs
  • Index

ADOBE FLASH MEDIA SERVER 3.

5 Configuration and Administration Guide
® ®

Last updated 3/2/2010

© 2009 Adobe Systems Incorporated. All rights reserved.
Copyright

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

Last updated 3/2/2010

iii

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

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

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

Performing general configuration tasks Configuring Apache HTTP Server

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

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

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

Clearing the edge server cache Managing the server on Linux

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

Last updated 3/2/2010

FLASH MEDIA SERVER 3.5 CONFIGURATION AND ADMINISTRATION GUIDE iv
Contents

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Last updated 3/2/2010 FLASH MEDIA SERVER 3. 5 Restart the server.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</SSLCertificateFile> <SSLCertificateKeyFile>private2.pem when a client connects to it on port 443.pem when a client connects to it on port 444.pem</SSLCertificateFile> <SSLCertificateKeyFile>private.5 CONFIGURATION AND ADMINISTRATION GUIDE 27 Configuring the server This sample code demonstrates how to configure edge1 to return cert2. The edge2 server returns cert. Since there is no Edge tag for edge2. 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. <SSL> <SSLServerCtx> <SSLCertificateFile>cert.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. Secure outgoing connections 1 Open the Server. .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Last updated 3/2/2010

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

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

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

See also
VideoSampleAccess

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

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

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

Last updated 3/2/2010

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

Contained elements
ClientToServer (Bandwidth), ServerToClient (Bandwidth)

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

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

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

MaxRate

DataSize

MaxWait

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

Last updated 3/2/2010

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

Contained elements MaxRate, DataSize, MinBufferTime (Live)

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

See also
UserAgent

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

See also
Server

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

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

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

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

Last updated 3/2/2010

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

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

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

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

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

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

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

See also
StorageDir, DuplicateDir, CacheUpdateInterval

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

See also
StorageDir, DuplicateDir, CachePrefix

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

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

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

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

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

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

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

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. MimeType. IdleAckInterval. WriteBufferSize IdlePostInterval Specifies how long Flash Player should wait before sending an idle post to the server. The default interval is 512 milliseconds. Note: At times. MimeType. Example <IdlePostInterval>512</IdlePostInterval> . Example <IdleAckInterval>512</IdleAckInterval> See also IdlePostInterval. the server will not be able to send any data to the client for the selected duration. but posting is necessary to provide the server with an opportunity to send data downstream to the client.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 interval cannot be set to a negative value. The server may respond sooner than the value of this element if it has data to send back to the client or if some other client is being blocked by the current idle request. The interval for an idle post ranges from 0 to 4064 milliseconds. This interval implies that the client may not be able to reach the server for the selected duration. the default value of 512 milliseconds is used. Idle posts are sent when Flash Player has no data to send. If the IdlePostInterval element is set to a value that lies outside of this range.Last updated 3/2/2010 FLASH MEDIA SERVER 3.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Last updated 3/2/2010 FLASH MEDIA SERVER 3. and reject export-strength versions. <SSLCipherSuite>ALL:+HIGH:!LOW:!EXP:!NULL</SSLCipherSuite> This string instructs the server to accept all ciphers but to order them so that SSLv2 ciphers come after SSLv3 ciphers. 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. 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 .and medium-strength encryption. <SSLCipherSuite>ALL:+SSLv2</SSLCipherSuite> The following is the complete list of components that the server can evaluate.

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

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

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

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

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

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

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

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

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

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

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

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

59 Adaptor.xml file description of tags 80 file structure 80 Adaptor. 57.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 .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.xml file description of tags 93 Application. 38 application instances about 6 log messages 43 performance 47 reloading 43 view in Administration Console 42 application logs 63 Application object.Last updated 3/2/2010 205 Index A access logs 29. defining 31 Application.

57 clients closing idle connections of 14 limiting connections from 14 view active 45 clusters 1 configuration files Adaptor. 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. in video files 71 Event Viewer (Windows) 67 . using 23 CrossDomainPath (Server.xml 80 Application.xml 175 Vhost.Last updated 3/2/2010 FLASH MEDIA SERVER 3.xml 178 connections closing idle 14 limiting 14.xml 93 directory structure 6 editing 9 Logger.xml) 23.xml 140 symbols in 10 Users. native 32 C CGI programs 39 checkpoint events 29.xml 133 Server. combining 13 B backing up log files 56 bandwidth detection. 146 D debug connection 30 diagnostic logs 64 E edge servers cache 73 chain 5 configuring 2 connecting to 4 deploying 1 file cache (on Linux) 74 file cache (Windows) 73 environmental variables 11 Errors.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 file configuring 55 description of tags 133 file structure 134 Logger. configurable 31 P performance improving 12 monitoring server 51 permissions administration APIs 76 for administrators 175 PublishTimeout (Application.xml file 55. on Linux 74 performance 51 starting and stopping 66 testing 67 viewing events 67 server processes.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.5 CONFIGURATION AND ADMINISTRATION GUIDE 207 Index F FLV errors 71 FLV files.xml tags Access 140.xml) 123 R RecordsNumber 164 refresh rate 41 RetryNumber 165 RetrySleep 165 rotating log files 56 S scripts. 179 ACCP 140 ActiveProfile 141 Admin 141 AdminElem 141 AdminServer 141 Allow 141 Application 142 ApplicationGC 142 AuthEvent 143 AuthMessage 143. 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. 136. checking 69 FLVCachePurge (Server. 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. 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 . 135. 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.Last updated 3/2/2010 FLASH MEDIA SERVER 3. configuring 16 Server. 140 Server.xml tags Access 134.xml) 123 Q QualifiedStreamsMapping (Application.

xml tags AggregateMessages 179 Alias 179 AliasList 180 Allow 180 AllowOverride 180 Anonymous 180 . 28 tags in VHost. 190 SSLCipherSuite 169.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.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.Last updated 3/2/2010 FLASH MEDIA SERVER 3. 26 tags in Server. 172 SSLCACertificateFile 169. 174 Process (Server) 163 Protocol 163 PublicIP 164 RecBuffer 164 RecordsNumber 164 ResourceLimits 165 RetryNumber 165 RetrySleep 165 Root 165 RTMP (AdminServer) 165 RTMP (Connector) 165 RTMP (Protocol) 166 RTMPE 166 Scope 166 SegmentsPool 166 Server 166 ServerDomain 167 Services 167 SmallMemPool 167 SocketGC 167 SocketOverflowBuckets 168 SocketRcvBuff 168 SocketSndBuf 168 SocketTableSize 168 SSL 161.xml 25.xml file description of tags 175 file structure 175 permissions for admin APIs 76 summary of tags 175 Users. 193 SSLVerifyDepth 172.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. 163.xml 28 storage directories 34 storageDir element 34 streams cache size 12 chunk size 13 view live 44 U Users.xml 27. 190 SSLClientCtx 171 SSLRandomSeed 171 SSLSessionCacheGC 172 SSLVerifyCertificate 172. 164. 168. 190 SSLCACertificatePath 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 .

You're Reading a Free Preview

Download
scribd
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->