ETS Installation Guide
Contents
1. 7 Actin View am EX y mon 59 MAS 1 Console Root EH Internet Information Server ES Default FTP Site Stopped All Unassigned 4fi220b 169 www example com Stopped AllUnassigned g Default FTP Site Stopped B Administration Web Site Stopp All Unassigned www example com Stopped 19 ETS Stopped All Unassigned Administration Web Site Stopped ETS Stopped m Default SMTP Site Stopped Microsoft Transaction Server 84 Default SMTP Site Stopped All Unassigned Figure 2 ETS on Port 80 Installation Requirements To successfully use ETS your Windows based machine requires the following Operating System Windows 2000 XP or NT 4 0 with Service Pack 6 0 IIS 4 0 or 5 0 Disk Space 50 MB RAM Memory 64 MB RAM Downloading the Executable Files The ETS files are available as downloadable files through the Akamai Developer Net work ADN located at http developer akamai com If you cannot access the ADN or the executable file is not visible contact your Akamai representative Running the ETS installer It is recommended that you exit all Windows applications before proceeding with the installation procedures Also the Microsofi Management Console should not be running 1 Open the folder where you downloaded the ETS exe file 2 Double dick filename exe The version information may vary but the filename will be ETS NNNN Windows exe whe2. Akamai resources on using ESI and the other services referenced in this guide include the following documents available to customers on EdgeControl at https www control akamai com The ESI Developers Guide is the user manual for ESI It provides an overview and detailed explanation of the ESI language usage The Edge Server Configuration Guide details the configuration and control options and parameters used for sites and objects in ESI The ESI Development Tool contains the information on the debugger ESID The EdgeScape and EdgeScape Pro Users Guide has information on the GEO con tent targeting data Edge Server Handling of Edge Control amp Other HTTP Headers a discussion of the use of HTTP request and response headers in the Akamai environment Time to Live in Cache Methods and Considerations This discusses the various methods for determining caching properties of objects on Akamai edge servers ETS Installation Guide 5 ETS and ESI Enabled Content ETS serves two key functions it parses and processes the ESI markup and it serves as a reverse proxy for the origin test server To illustrates ETS ETS is listening on the same port as the test origin Request made for nome htm1 is handled by ETS While ETS is shown as a separate server it could in fact be on the same machine Origin Web Server ETS makes a request to the origin test server to retrieve template
3. ESI Test Server Installation Guide May 22 2009 Trusted Proven Innovative Akamai Technologies Inc Akamai Customer Care 1 877 425 2832 or for routine requests email ccare akamai com Akamai EdgeControl for customers and resellers http control akamai com US Headquarters 8 Cambridge Center Cambridge MA 02142 Tel 617 444 3000 Fax 617 444 3001 US Toll free 877 4AKAMAI 877 425 2624 For a list of offices around the world see http www akamai com html about locations html ESI Test Server Installation Guide Copyright 2001 2009 Akamai Technologies Inc All Rights Reserved Reproduction in whole or in part in any form or medium without express written permission is prohibited While every precaution has been taken in the preparation of this document Akamai Technologies Inc assumes no responsibility for errors omissions or for dam ages resulting from the use of the information herein The information in these documents is believed to be accurate as of the date of this publication but is subject to change without notice The information in this document is subject to the confidentiality provisions of the Terms amp Conditions governing your use of Akamai services Akamai the Akamai wave logo EdgeControl EdgeSuite and EdgePlatform are trademarks or service marks of Akamai Technologies Inc Other trademarks contained herein are the property of their respective owners and are not used to imply endorseme
4. 8 ifi ee N Lo qui ETS then processes the ESI tags in home html and retrieves fragments such as tasks html and inserts them into the template ETS assembles the content and delivers the result back to the browser ETS is configured with the IP address and port for the origin test server thus allowing it to transparently forward requests and retrieve content without disruption to the origin test server or web browser functions Edge Server Features Not Implemented in ETS For specific information on differences between ETS and the current production ver V sion of ESI please see the release notes that accompany the ETS software Generally ETS does not implement ESI extensions that require gathering information from or caching objects in the live network including the following e The Akamai custom variable TRAFFIC INFO and custom named variables representing values extracted from cookies or other elements are not supported e Caching of template and fragments is not supported The maxwait attribute is not supported HTTPS origin servers are supported on Linux and Solaris but not on Windows Akamai Technologies Inc 6 CHAPTER 2 Installing the Linux or Unix ETS Installing and Configuring ETS 8 In This Chapter MJ 3 TM Starting Stopping and Restarting ETS e 12 Command Line Reconfiguration 13 mod esi Reconfiguration e 17 Starting Stopping and Restarting ETS e 12 Uninstalling ETS
5. Metadata dca akamaizer tag filter type typestr tags tagnames regex regex A sample Metadata dca akamaizer tag filter type include tags img src regex 1 Note that the quotes inside the filter specification need to be escaped with slashes to prevent them from being interpreted when the configuration file is read by ETS ETS Installation Guide 19 Uninstalling ETS To uninstall ETS stop the server and remove the entire ETS installation by typing the following two commands 4 usr local ETS bin apachectl stop rm rf usr local ETS Akamai Technologies Inc 20 CHAPTER 3 Installing the Windows ETS i About the Windows ETS e 21 In This Chapter MN Running the ETS installer e 22 Reconfiguring and Fine Tuning e 25 Uninstalling ETS 26 This chapter provides instructions for installing and configuring ETS as well as for starting stopping restarting reconfiguring and removing ETS MEN Note The Windows version is no longer offered for download and it is strongly encouraged to use the Linux version instead The documentation remains for those who already have and use the Windows version About the Windows ETS ETS is installed on Windows machines as an ISAPI extension that acts as a reverse proxy to forward web page requests to the origin server It runs on Windows 2000 or Windows XP and you must be running a server version of the operating system to have ETS listen on more than one
6. 20 This chapter provides instructions for installing and configuring ETS as well as for starting stopping restarting reconfiguring and removing ETS WD Note The Solaris Unix version is no longer offered for download and it is strongly encouraged to use the Linux version instead The documentation remains for those who already have and use the Solaris version Installation Requirements To run ETS the following is required Operating System Linux with a 2 2 kernel or higher OR Solaris 2 6 or higher Disk Space 50 MB RAM Memory 64 MB RAM Apache ETS is a standard Apache server installation plus an Apache module for ESI called mod_esi The install program will install the standard Apache distribution and configure it to use mod_esi The Apache server is a readily available source code implementation of the HTTP web server Additional information about the server can be found at http httpd apache org ETS has been designed to work with all types of origin test servers including Apache IIS and the Netscape iPlanet servers After Initial Installation Two Configuration Methods The initial installation and configuration is menu driven After initial installation there are two different re configuration methods you can use on ETS e Menu driven the same menu used during installation but accessed from the command line using ets_config and called the config command method e Direct edit of the mod es
7. Install directory usr local ETS 3 Origin hosts localhost foo example com i Install ETS e Exit without installing ti TS Please select an option to modify i to install ETS or e to exit 1 2 3lile N Well refer to the above menu the Main ETS Installation menu freguently in the V coming pages 4 Doone of the following If youre ready to install go to the steps shown under Completing the Installation on page 11 Ifyou want to review or reconfigure before installation proceed to the fol lowing section Note that you also can reconfigure after installation Optional Changing the Configuration Before Completing Installation The Main ETS Installation menu shown in the previous step allows you to modify ETS configuration settings before completing the installation process This is optional and you can also change configuration settings after installation The steps that you follow are described under Command Line Reconfiguration on page 13 The only difference is that you don t need to open the Main ETS Installa tion menu from the command line because the menu is already available Also you cannot modify the mod esi module from this menu which means that you this menu does not provide access to the additional configuration options available through using mod esi That must be by direct edit from the command line after ini tial installation For more information see
8. page 17 Akamai Technologies Inc 10 Completing the Installation 1 On the Main ETS Installation menu type i and press Enter The following mes sages display in the window Installing ETS Installing binary distribution into directory local usr ETS Copying the configuration script ETS had successfully been started W Do you want to start the server y or n y 2 Complete one of the following options Ifyou do not want to start the server type n and press Enter To accept the default and start the server press Enter ETS is started and the following message displays in the window ETS has successfully been started To start ETS at a later time use the command usr local ETS bin apachectll start gt To restar t ETS at a later time use the command usr local ETS bin apachectll restart To stop ETS use the command usr local ETS bin apachectll stop To reconfigure ETS use the command usr local ETS bin ets config ETS Installation Guide 11 Starting Stopping and Restarting ETS Since Apache ETS is a standard Apache installation configured to use mod esi administering ETS is the same as administering a normal Apache installation See http httpd apache org for detailed information To start ETS type the command 4 directory bin apachectl start To start ETS with HTTPS origins or clients ty
9. 5 ETS Administration Web Site ETS Installation Guide 25 To change the configuration 1 Accessed the ETS Administration Web Site by browser using a URL that con forms to the following format http hostname port etsadmin 2 Change the settings then click the Update button It is poz be necessary to stop and restart your web server to complete the changes The settings you can change on this site are as follows Uninstalling ETS Origin server host and port The server and port ETS will contact to request templates and fragments Log Level The level of logging ETS will use to create its log file The settings are in order of increasing verbosity None Error Warning Informational Debugging Log File Name The file name ETS is to use for its error logging ESI Debugging Enables the ESI Development Tool the Debugger to get a debug report on responses See Troubleshooting on page 27 for more information Chase Redi Specifies whether ETS will chase redirects 302 and 301 rects return codes when fetching templates and fragments Surrogate Specifies data necessary to set up ETS s use of the Surrogate Header name Capability header See page 18 for more information about and value this option GEO Informa tion These data are described in the EdgeScape and EdgeS cape Pro User Guide Metadata Up to ten metadata settings can be specified Consult your Akamai representative fo
10. B paw TE E a 27 JavaScript Problems eass ua ase erigat kanta aa d eene i e e a te E deal as 27 Windows Setup Issues i e d ia il ac na e ia a d bei dob pe ba d rula a 27 4 Akamai Technologies Inc CHAPTER 1 About the ESI Test Server Welcome to the ESI Test Server Installation Guide This guide provides the information you need to install configure and use the ESI Test Server ETS ETS is an application that works as a reverse proxy web server capable of processing ESI tags As a reverse proxy ETS transparently receives web page requests from an end user browser forwards the request to another web server and receives that web server s response As an ESI processor ETS processes ESI tags contained within the web page returned by the other web server thereby letting you view and test ESI Before using ETS it is recommended that you have the following background e Understanding of web page authoring HTML and Edge Side Includes ESI tag syntax e Familiarity with web servers Three Servers Linux is Preferred Over Unix or Windows Akamai has historically provided three flavors of the ETS server Linux Unix for Solaris and Windows Linux is the one that provides the closest emulation of the production environment a Linux environment which is then preferred for ESI test ing The use of the Solaris and Windows versions is not encouraged They are docu mented here for those who already use them Key Document Resources
11. ader name is Surrogate Capability and the value is ESI 1 0 the resulting header will be Surrogate Capability akam ESI 1 0 Warning Using ets_config the menu driven configuration application program will settings for this tag It can modified only by direct edit of httpd conf CacheParseTrees This directive enable the caching of ESI parse tree in ETS Caching these trees can reduce the time necessary for processing ESI pages The caching is controlled by the ParseTreeMaxage and ParseTreeCacheSize directives The value can be either On or off with a default of off Warning Using ets_config the menu driven configu ration application program will settings for this tag It can modified only by direct edit of httpd conf ParseTreeMaxage This directive determines the maximum age in seconds of cached parse trees The default is 120 seconds The value is a number of seconds Warning Using ets_config the menu driven configuration application program will settings for this tag It can modified only by direct edit of httpd conf Warning Using ets_config the menu driven configuration application program will settings for this tag It can modified only by direct edit of httpd conf ParseTreeCacheSize This directive determines the size of the parse tree cache Large parse tree caches can consume considerable memory The default is 200 elements The value is a number of elements Warning Using ets_config the menu driven configuration a
12. ays at the prompt Type the new information at the prompt and press Enter Repeat the process if you want to change other settings After you modify any of these settings the Individual Origin Host Configuration menu is updated and displayed 3 At the Individual Host Configuration menu type a and press Enter to accept the settings The Main Origin Host Configuration menu displays in the window 4 Type a and press Enter to accept the changes The Main ETS Configuration menu displays in the window 5 Types and press Enter to save the changes 6 Restart the server if youre ready to apply the change s Adding an Origin Host From the Main ETS Configuration Menu type 2 to open the Main Origin Host Configuration menu see page 13 1 Type and press Enter 2 Type the new information at the prompt and press Enter 3 Type a and press Enter to accept the settings The Main Origin Server Configu ration menu displays 4 Type a and press Enter to accept the changes The Main ETS Configuration menu displays in the window 5 Types and press Enter to save the changes 6 Restart the server if you re ready to apply the change s ETS Installation Guide 15 Deleting an Origin Host From the Main ETS Configuration Menu type 2 to open the Main Origin Host Configuration menu see page 13 1 Type the number for the origin server you want to delete For example type 2 to delete the origin host listed a
13. com S Save changes and exit e Exit without saving changes Please select an option to modify s to save changes or e to exit without saving 1 2 3lsle From this menu you can modify the ETS port or you can type 2 to open a secondary menu the Main Origin Hosts Configuration menu to modify other settings The Main Origin Hosts Configuration menu looks like this example Main Origin Hosts Configured origin hosts Configuration Menu 1 localhost 2 foo example com Add a host a Accept changes Please select a host to modify or delete to add a host or a to accept changes 1 2 3 la 3 Modify the configuration as described in one of the following eight procedures listed in this chapter ETS Installation Guide 13 4 When youre done you are prompted to re start the server press Enter to restart or type n and press Enter not to restart at this time Note that you must re start the server to activate the new configuration settings Modifying the ETS Port Number At the Main ETS Configuration Menu see page 13 1 Type 1 and press Enter 2 Type the new port number and press Enter The new configuration is displayed in the window Types and press Enter Restart the server if you re ready to apply the change s Modifying the Origin Hostname Port ESID or GEO Settings From the Main ETS Configuration Menu type 2 to open the Main Origin Host Configuration menu see page 13 1 Type the numbe
14. dy have a configuration file you want to use Otherwise youd generate a new one Both option involve the process of copying the files while providing for your review of the settings Generating a New Configuration File Setting the Origin Server Name and Port Origin Server Name If you choose to generate a new configuration file you ll set the origin server and Port name Hostname and port for the origin server The Origin Server dialog lets you specify where ETS should forward the requests Once done you ll save the configuration file and go on to Review Settings on page 24 Use Existing Configuration File Should you choose to use an existing configuration file you ll browse and choose the file review the settings as discussed on page and then save the file as another file name Review Settings 6 Review the settings Whether you chose to use a new or existing configuration file the Start Copying Files dialog lets you check the destination folder ETS port and configuration file paths before copying ETS files to your machine Completing the 7 Restart IIS Installation You can choose to wait until later but IIS must be re started for the configura tion to take effect Akamai Technologies Inc 24 Reconfiguring and Fine Tuning If you need to modify the ETS setup it is recommended that you use the ETS Administration Web site rather than a text editor to edit the ETS configuration file An example o
15. e ER EAR PROC E E eC p OR TEN EORR ieee ACR 13 Using eis config Opening the Main Menus isses ek erac m ra a ER ERRORS ORC ai a CR e 13 Maim ETS Configuration MU Lisa pack Viennese Ap cuo ee cob qa paa P rat pi bte 13 Main Origin Hosts Configuration Ment 52e Ret rese KKI ea Ra aaa A 13 Modifying the ETS Port Number s ode aie aa aro tea a ee b Rotile ai da alti a dedos 14 Modifying the Origin Hostname Port ESID or GEO Settings eee 14 Adding an Origin EIOSE ones aa sea sola de al Aaa o ln CER e Rd aU E T 15 Deleting an Oi Host once ae tee ee hee Kd ae e le al E dal DE ta debili Ka 16 mod esi Reconfiguration MEE 17 Accept ESI MD 1 a ti ieseni At tea Kt al gal Ga ues et 17 Directoty proxy gt iis cee a e dee yes p RR E RU RUE a E OP et Bea Co d ed dd 17 E SIDE DU EG UE asian dob Esi a i Ra i i alt dc ea dda ast ba bra abi dep dia a 17 ESTO gS ING P 17 Meta ata ss gid sik Soils oe astia aise Wee cena IAs Ween a ioe 0 dae ena aa 17 Proxy Pass i once ai siege hp ee ei pee odie age bb jek a ee san 17 EOS et anapoda Pea cac ee renati a oda pci i aie MPs Kees PPR RE a ror Rees 18 BurrapateblesdlBEs oos coco ada od a RR LASS vdd A abc i basa t v t 18 enc og al ante 18 o SR D MC Q 18 CRT S T Ur PR 18 Chase KOS s ois EX wt gb D don eye AR eyed e a dh po e da t c n dl bc 18 MaxRedirectCount so ta oper pr E HIP ERE ELE EE Kk E PEE EC HH Lee dede 19 DCAProcessin gc ia sia cree ee
16. ename tar Step 2 Running the Installation Program 1 Openacommand prompt window 2 From the directory that holds the extracted installation files start the install pro gram by typing 4 install The License Agreement displays in the window 3 Press Enter to accept the License Restrictions and other sections of the agree ment then type yes to accept the terms 4 You re asked where ETS should be installed Complete one of the following options Akamai Technologies Inc 8 a To accept the default usr local ETS press Enter b To change the default type the installation directory path and press Enter Step 3 Setting Configuration Parameters 1 After setting the installation directory you are asked to set configuration options 1 Set the following options by pressing Enter to accept the default or entering a new value Option Meaning Defaul t ETS port The port on which ETS should listen for requests Nor 80 mally this is the same as the Origin Port the port on which the origin server normally listens the actual ori gin server port will be re set to 81 by default Origin host The origin test server hostname Since ETS transparently local forwards content requests to the origin test server it host must know which server to contact There can be multi ple origin servers after configuring the first one you can configure additional servers Origin port The port on which the origin server list
17. ens 81 Enable ESID ESI The ESI Development Tool aka the Debugger or ESID Off Debugger provides a way to test view and debug web pages containing ESI code see Chapter Troubleshooting for more information Enable GEO This allows running EdgeScape Content Targeting n no data For more information on EdgeScape see the EdgeScape and EdgeScape Pro Users Guide The Current Settings menu displays in the window An example Current settings for origin host localhost 1 Origin host localhost 2 Origin port 81 3 ESI Debugging ESID on 4 GEO settings georegion 246 country code US region code CA City SANJOSE dma 807 pmsa 7400 areacode 408 county SANTACLARA fips 06085 lat 37 935 long 121 8938 ETS Installation Guide 9 timezone PST network type dialup a Accept settings d Delete host Please select an option to modify host settings a to accept settings or d to delete host 1 2I 3l 4lald 2 To accept the settings type a and press Enter 3 You are asked if you want to configure additional hosts a To configure additional hosts type y and complete the options in Step 1 b Ifyoute done with configuration for now type n You ll see the Main ETS Installation menu an example of which is shown here Main ETS Installation Current settings for ETS to be written to usr local ETS Menu conf http conf 1 ETS port 80 2
18. f file is similar to the following example ESI module directives lt IfModule mod_esi c gt ProxyPass http real test example com 80 ESIDebugging off ESILogging off Accept Esi 1 0 MetaData dca max output size 20000 MetaData dca disable function errors on lt Directory proxy gt Order allow deny Allow from all lt Directory gt IfModule Additional information about httpd con can be found at http httpd apache org The following configuration options can be modified by directly editing httpd conf Note that there are more options available using mod esi than are available using the Using the ets config program will delete any setting you have for certain tags as indicated in the list starting with the HostHeader Accept ESI The Accept ESI directive configures ETS to add the indicated value for the Accept ESI header to the reguest sent to the origin server Directory proxy gt The Directory proxy gt section is used to set access permissions See the Apache documentation for more information ESIDebugging The ESIDebugging directives configures the ESID tool so that it is either On or Off ESILogging The ESILogging directive allows information about the containers and fragments that ETS processes to be logged in the Apache error log file This information can be useful for debugging ETS problems MetaData The MetaData directive configures the specified metadata value Only metadata val ues with On O
19. f this site ESI Test Server 4 8 1 4 Administration Microsoft Internet Explorer File Edit view Favorites Tools Help Back gt G A A Asearch Sjravorites meda E 5 MM SRD Address http jiiocathostisijetsadmin ss eee ESI Test Server 4 8 1 4 Administration Update Origin origin example com RET Log Level Warning Log FileName CAETS log ets log Surrogate Header name Surrogate Header value ESIDebugging Chase Redirects M GEO Information M georegion pa t CSS country code s region code i city SANFRANCISCO dma 607 maba pmsa 3650 areacode ase lat 77783 oo long 122488 county SANFRANCISCO fips 06075 0601 timezone sT network ibm network type I throughput joe ESI Metadata name 1 gt value 1 gt name 2 gt value 2 name 3 SY value 3 name 4 value 4 name 5 i value 5 name 6 value 6 name 7 is value 7 1 name 8 value 8 II name 9 value 9 name 10 value 10 Akamaizer Specifications Akamaizer 1 Akamaizer 2 Akamaizer 3 Akamaizer 4 DCA Specifications DCAType None Pah Action incude v Akamaizer None DCA Type None v Path 1 Action Include Akamaizer None 3 DCA Type None Path E Action Include X Akamaizer None 3 DCA Type None v Path 7 Action Include Akamaizer None ee hae ee ee EI ELA ggremee 5 Figure
20. ff numeric or simple string values are supported Since ETS only processes ESI and does not cache any page requests or responses metadata affecting page caching will have no effect Only metadata that influences dynamic content assembly will have an effect ProxyPass The ProxyPass directive configures the Apache server to work as a reverse proxy allowing it to forward requests to the origin test server The first ProxyPass argument ETS Installation Guide 17 is always while the second argument is the origin test servers hostname In the example the origin test server s hostname is real test example com while its port is 80 WARNING Usingets_config the menu driven configuration application program will 8 S gu PP prog delete any setting you have for these tags The configuration tags below can only be modified by directly editing httpd conf HostHeader This directive allows you to set a specific host header on container and fragment requests to the origin This value can be any valid host header value Warning Using ets config the menu driven configuration application program will settings for this tag It can modified only by direct edit of httpd conf SurrogateHeader This directive allows you to specify the value for the Surrogate Capability sent to the origin server The format is SurrogateHeader name value The actual header sent will be constructed by wrapping the surrogate header value with akam value If the he
21. i module in the httpd conf configuration file N V Certain configuration options are available only through modifying the mod esi module BUT you need to exercise caution because if you use the config command ETS Installation Guide 7 method and save the file AFTER you have edited the mod esi certain mod esi configurations will be deleted This is discussed on page 17 Getting Started Downloading the Executable Files The ETS installation files are available as downloadable files through the Akamai Developer Network ADN located at http developer akamai com If you cannot access the ADN or the executable file is not visible contact your Akamai representative Installing and Configuring ETS Standard installation of the ETS involves the following steps Extracting the installation files from the tar file Running the ETS installation program to copy all needed files to your machine Setting configuration parameters Optional Additional configuration or modification before installation Woe Ge C A Completing installation Step 1 Extracting the Installation Files 1 Copy the downloaded file to a directory where you want to extract the installa tion files 2 Extract the files to the current directory using one of these commands The actual ETS file name will depend on the version and operating system Linux tar xzvf ETS filename Solaris uncompress ETS filename tar gz tar xvf ETS fil
22. mon Issues ESI Enabled Content This can be from any number of reasons including syntax errors Use the Debugger Not Assembled ESID to examine why the ESI content is not being assembled 500 Internal Server Occasionally a 500 Internal Server Error is returned to the client due to incorrect Error ESI syntax Once again use ESID to fine the line s with the syntax errors Unable To Start ETS The install program or the ets config program may report that ETS was unable to start This is usually caused by a problem with the configuration of ETS The most common configuration problem is starting ETS on a port that is already in use To correct the problem reconfigure ETS to run on an unused port JavaScript Problems When ETS debugging is enabled some pages that use JavaScript may not work correctly If you re having problems with JavaScript pages turn off ESID and try again ETS Adds its debugging information inside SCRIPT tags which breaks some JavaScript ETS debugging is only intended to show the results of ESI processing on a page and may not be completely transparent Windows Setup Issues On Windows ETS should always be set up the same as the origin server it is replacing If ETS and the test origin server are sharing a machine ETS should listen on port 80 and the test origin server should listen on another port ETS Installation Guide 27 Akamai Technologies Inc 28
23. nt of Akamai or its services Contents CHAPTER 1 ABOUT THE ESI TEST SERVER 5 Three Servers Linux is Preferred Over Unix or Windows naos a te d a honk eee cone ions 5 Key Document Resources ig kaa 430 muona eee kuna ain p evant pe eet eben ewes 5 ETS and ESI Enabled Content nosece CHEER CREE ce a eens JU P AK e ie p hens kee e di 6 Edge Server Features Not Implemented in ETS ie a e piatza le pss KES NSA ERROR ey eens S DEA 6 CHAPTER 2 INSTALLING THE LINUX OR UNIX ETS 7 Installation Requirements i 4a race dos dO de OR RAD KEKE KE E RO a a Eo eon a REGE P dca E D 7 After Initial Installation Two Configuration Methods cc 7 Getting Started Downloading the Executable Files eee 8 Installing and Configuring ETS 225 ce 00 kua Eae Pb ES Fes e b cr Xd i bdo KE ASSA 8 Step 1 Fxtracting the Installation Files uu abra ad RA ORE p a RaSh a n MIES p D 8 Step 2 Running the Installation Proprate 1i s 1000 CERRO EUER ERU ERO RO dE doa RW AC each 8 Step 3 Setting Configuration Parameters 1i de ai te ro Wee EE e EK ER EROR RC Utt 9 Main ETS Installation Ment 22 233 0594 aia Mane idco add alea KSK a dida Pa Rd A 10 Optional Changing the Configuration Before Completing Installation ooo nnen 10 Completing the Installation ssi vs ea e ai Ehe EP vau ddr d bp did deu d ia 11 Starting Stopping and Restarting EUS satut skada DRE ve t e pie prins tenes 030 12 Commaid Line Reconfig ration aea ce acr
24. pe the command directory bin apachectl startssl To stop ETS type the command 4 directory bin apachectl stop To restart ETS run the command 4 directory bin apachectl restart If ETS is unable to start it will log the reason to the Apache error log in directory logs error log For example if you installed ETS to usr local ETS then the log will be in usr 1ocal ETS logs error log Akamai Technologies Inc 12 Command Line Reconfiguration You can modify the Apache ETS after installation using the ets_config command or by manually editing the mod esi module the latter of which is discussed starting on page 17 The ets config command uses the same menu system as was used in installation and can be used to modify the following ETS Port Number e Origin Host Name Port ESID status and GEO settings Adding or Deleting an Origin Host Using ets config Opening the Main Menus 1 Openacommand prompt window 2 Type the following command 4 directory bin ets config where directory is the path to the ETS installation For example if usr local ETS bin is the directory then you reconfigure ETS by typing 4 usr local ETS bin ets config The Main ETS Configuration Menu displays in the window as shown in the following example Main ETS Current settings for ETS found in usr local ETS conf Configuration Menu http conf 1 ETS port 80 2 Origin hosts localhost foo example
25. port or to have ETS and the origin server on the same machine Non server versions of IIS only allow IIS to listen on one port at a time Basic installation involves setting up ETS to run on port 80 while moving the origin server host port to 81 It is highly recommended that if the origin is currently set to port 80 that you move it to 81 before you begin this installation Figure I displays the Microsoft Management Console for a company whose default Web site is www example com running on port 80 f Microsoft Management Console iis Console Root Interet Information Server 4fj220b T Console Window Help En 6 7 Action v View amp em IEN mnis u s ZI Console Root 5 0 Intenet Information Server S Default FTP Site Stopped All Unassigned Afj220b k www example com Stopped All Unassigned amp iS Default FTP Site Stopped B Administration Web Site Stopp All Unassigned m www example com Stopped n N x 0 Default SMTP Site Stopped ALU d 13 48 Administration Web Site Stopped efslopped zii Basa Default SMTP Site Stopped H Microsoft Transaction Server Figure 1 Origin Server on Port 80 ETS Installation Guide 21 Figure 2 displays the Microsoft Management Console after the origin server is moved to port 81 and ETS is running on port 80 Th Microsoft Management Console iis Console Root Internet Information Serveri 4fj220b T Console Window Help SE 0
26. pplica tion program will settings for this tag It can modified only by direct edit of httpd conf ChaseRedirects This directive allows ETS to automatically chase HTTP redirects 301 or 302 result codes If this directive is enabled ETS will follow redirects up to MaxRedirectCount times after which a 404 will be returned The value can be either On or off with a default of off Warning Using ets_config the menu driven configuration appli cation program will settings for this tag It can modified only by direct edit of httpd conf Akamai Technologies Inc 18 MaxRedirectCount This directive determines the maximum number of times ETS will follow a redirect result before returning a 404 The default is five times The value is an integer Warn ing Using ets config the menu driven configuration application program will settings for this tag It can modified only by direct edit of httpd conf DCAProcessing This directive allows you to determine what DCA processor to use for containers and fragments Warning Using ets config the menu driven configuration applica tion program will settings for this tag It can modified only by direct edit of httpd conf The format is DCAProcessing dcaType include exclude url The dcaType can be one of these esi akamaizer noop These represent the processor types ESI the EdgeAkamaizer or None The include or exclude indicates whether to include the specified ur1 in the URLS p
27. r eee CIR ev RR ere he Eg aaa a e e ehna 19 Uninstalling ETS PNE Tm 20 ETS Installation Guide 3 CHAPTER 3 INSTALLING THE WINDOWS ETS e 21 About the Windows ETS oed ex rad e eb re eli Pes RU eti Pa d Pea ded ees 21 Installation DequitematifS Savva Eb tiie thik ded bended lea cn ele o diced 22 Downloading the Executable Fila uad dedere rii ap data phai desde b pad au boa pias 22 Ranting the ETS istet EA senat peace e x abe RO DA re Roe o cabe Ko aa er EE keen EUR OTE bs bores 22 ETS DOE ask e SERRE a OI P 94 ie Ed il EAD KOS exe ea si Ie pd d 23 New or Existing Configuration File e t bed sia on OR ip ORE CUR E QR d 24 Origin Server Name and Port i ciae kac dea ola eso acp Ed RIO ER RR RODEO deret eaa 24 Review SEHR as been enar eel Earned wat ac dob ae aoreet Roe Rath ee eae 24 Completing the Installatie a acea ca ok ae oa da iaca a aint ae d alz ipd alie M eq 24 Reconfiguring and Fine Tuning 21 6 pP a ot EPET E UU PA E Tad sad er Raus e adds Edd qa 25 Uninstalling ETS i e es mea e dispont it KEEN al i a RR E ER a d 26 CHAPTER 4 TROUBLESHOOTING 27 Use ESID aba th Debugger ea sa oo exea dar ese aa tiana abu E paced dci i 27 Common ISSUES 5 ssa n hee a ae Ree 45 3 E ER A ie CAL dn E ae I A i aa E ae 27 ESI Enabled Content Not Assembled suussa aa e e ea aa rhe ari ara a a CR e 27 500 Internal Server Error se as op kd ea e eo era b E Den CR Ge Ries e a e nat d bl pa EA 27 Unable or Start ETS aci aec cas exon ce acad Ea il tie c
28. r for the origin server whose configuration settings you want to modify The Individual Origin Host Configuration menu displays in the win dow as shown in the following example Current settings for origin host localhost 1 Origin host localhost 2 Origin port 81 3 ESI Debugging ESID on 4 GEO settings georegion 246 country code US region code CA Qty SANJOSE dma 807 pmsa 7400 areacode 408 county SANTACLARA fips 06085 lat 37 335 long 121 8938 timezone PST network type a Accept settings d Delete host Please select an option to modify host settings dialup a to accept settings or d to delete host 1 21 3l 4lald Akamai Technologies Inc 14 2 Type the number for the setting you want to modify TO MODIFY Do THIS Origin Host Type 1 and press Enter When the name is displayed type the new Name host name and press Enter Origin Port Type 2 and press Enter When the port number is displayed type the new number and press Enter ESID Status Type 3 and press Enter When the ESID status is displayed type on or off and press Enter GEO Settings Type 4 and press Enter When the GEO settings are displayed type the number for the GEO setting that you want to modify and press Enter The selected information displays at the prompt For example if you typed 1 and pressed Enter the georegion information displ
29. r information using these fields Akamaizer Specifications Up to four specifications for the EdgeAkamaizer may be specified Consult your Akamai representative for infor mation on this feature DCA Specifica tions Allows users to determine how ESI processes specific templates and fragments See page 19 for more infor mation about this option and consult your Akamai rep resentative for further information To uninstall ETS run the ETS exe file An uninstall dialog will open that allows you to remove ETS from your machine Akamai Technologies Inc 26 CHAPTER 4 Troubleshooting Use ESID aka the The ESI Development Tool ESID lets you test view and debug web pages Debugger containing ESI code To use it you need to set the ESID configuration value to On in the ETS configuration After the option is set to on the ESI debugging information can be viewed in the web page source code You should turn ESID on and off as needed because it can slow the display and interfere with some non ESI processing That is once any ESI issues are resolved debugging should be turned off ESID can also be enabled for each request by setting an HTTP cookie in the request made to ETS If a cookie with the format Cookie Akamai EncDebug is sent in the request ESID will be enabled for that request only This and other instructions and descriptions of what ESID reports see the user guide the ESI Development Tool Com
30. re NNNN is the version information The InstallShield Wizard extracts the installation files to a tempo rary directory Akamai Technologies Inc 22 3 After accepting the license agreement you ll be asked to choose a destination folder the ETS installation directory The default is C ETS but you can choose or create another folder NOTE The installation folder cannot be located on a remote drive ETS Port 4 Specify the ETS Port The ETS is configured as a Web site that runs on a specific port specified in the following setup ETS InstallShield Wizard ETS Website Create the ETS website ristalls hela Figure 3 ETS Web site It is recommended that ETS run on port 80 while setting the origin server to run on port 81 or another port If the origin server is currently running on port 80 you will need to exit the ETS installation program move the origin server to another port then start the ETS installation process again After you click Next the Configuration Dialog appears An example ETS InstallShield Wizard Configuration Specify a configuration file for ETS Irstallstieldi Figure 4 Choosing New or Existing Configuration File ETS Installation Guide 23 New or Existing 5 Choose whether to create a new configuration file or use an existing one Configuration File You can use an existing file if you re updating to a new ETS version or re install ing and you alrea
31. rocessed by that processor or to exclude it The url should not include the proto col host or port but may include to match zero to many characters Include exclude statements are processed in the order they are found in the config uration file until a match is found Each statement is checked at most once for a URL If an include statement matches the url the processor type is set to the indicated type If a subsequent exclude matches the url the processor is reset to the default and checking the include and exclude statements continues If at the end no processor matches the include exclude statements the URL is determined based on the rules from the older ESI versions with the default being ESI processing Here is a sample set of rules DCAProcessing noop include default to noop DCAProcessing noop exclude files esi exclude files esi from noop DCAProcessing esi include files esi include files esi in esi processing DCAProcessing esi exclude files esi akamaizer include files esi from noop DCAProcessing akamaizer include files esi akamaizer include files esi in esi processing The EdgeAkamaizer replacements are by a tag dca akamaizer tag filter Multi g P y a tag ple instances of this filter will be chained in the same way the standard metadata works The format of the tag is slightly different from the standard metadata format to make reading the ETS config file clearer Here is the format
32. s 2 The Individual Origin Host Configuration menu displays in the window as shown in the following example Current settings for origin host localhost 1 Origin host localhost Origin port 81 3 ESI Debugging ESID on 4 GEO settings georegion 246 country code US region code CA city SANJOSE dma 807 pmsa 7400 areacode 408 County SANTACLARA fips 06085 lat 37 335 long 121 8938 timezone PST network type dialup a Accept settings d Delete host Please select an option to modify host settings a to accept settings or d to delete host 1 2 3 4lald 2 Type dand press Enter The Main Origin Server Configuration menu displays in the window 3 Type a and press Enter to accept the settings The Main Origin Server Configu ration menu displays 4 Type a and press Enter to accept the changes The Main ETS Configuration menu displays in the window Type s and press Enter to save the changes 6 Restart the server if you re ready to apply the change s Akamai Technologies Inc 16 mod_esi Reconfiguration Apache ETS is a standard Apache installation configured to use mod esi which is the Apache module that processes ESI tags The mod esi configuration information is specified in the Apache config file httpd conf which by default is located in the usr local ETS config directory The ETS specific portion of the Apache server httpd con
Download Pdf Manuals
Related Search