Ensim WEBppliance Pro for Windows 2000 (Upgrade) Technical Reference Guide

Transcription

1 Ensim WEBppliance Pro for Windows 2000 (Upgrade) Technical Reference Guide October 14, 2003 About this guide Introduction... v Intended audience... v Printer-friendly version... v Required skills... vi Related documentation... vi Document conventions... vi Feedback and support... vii Chapter 1 Customizing the interface using skins Introduction What are skins About WEBppliance skins Mercury skin Classic skin Downloading and decompressing a skin Chapter 2 Applying the skins Introduction Applying the skins Reverting to the default interface Switching between skins ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE I

2 Chapter 3 Modifying the current skin Introduction Replacing the existing interface images Finding and replacing existing image files Adding new images Customizing the left navigation bar Modifying the Shortcuts page Chapter 4 Automating the application of skins Introduction Batch file for applying the Mercury skin to the default interface Batch file for reverting to the default interface Batch file for applying the Classic skin over the Mercury skin Chapter 5 Customizing domains Introduction Customizing domains Creating custom batch files Setting up additional files and directories for new domains Customizing WEBppliance Pro features for new domains Inserting custom Web site welcome pages Inserting links in the Web site welcome pages Chapter 6 Using Command Line Interface scripts Adding a name-based domain using an existing plan Adding an IP-based domain using an existing plan Adding a name-based domain without using an existing plan Adding an IP-based domain without using an existing plan Editing a domain s properties Sample examples Deleting a domain II ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

3 Index Index-1 Legal and copyright notice ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE III

4 IV ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

5 About this guide Introduction This guide provides information about customizing the interface using skins, customizing domains, and Command Line Interface (CLI) commands for Ensim WEBppliance Pro for Windows 2000 (Upgrade release). Note: This guide is intended only for the upgrade release of WEBppliance Pro. If you are using a fresh installation of WEBppliance Pro, refer to Ensim WEBppliance Pro for Windows 2000 Technical Reference Guide. You can access the latest version of this document at For simplicity, we will refer to WEBppliance Pro for Windows 2000 (Upgrade) as WEBppliance Pro throughout this document. Intended audience This guide is meant for advanced users of WEBppliance Pro, including system administrators and technical support staff of Internet service providers (ISPs) who are using WEBppliance Pro. Printer-friendly version This document is presented in HTML and PDF formats. If you are viewing this document in HTML format and want to print it in a book style with numbered pages, access the Adobe PDF version. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE V

6 ABOUT THIS GUIDE Required skills To use this guide, you need to be familiar with the working of WEBppliance Pro. In addition, you should have some or all of the following skills. Using the Windows 2000 command prompt Understanding of HTML and DTML Creating and modifying graphics Related documentation For additional information about installation issues and help with product functions refer to the following documents. Ensim WEBppliance Pro for Windows 2000 Upgrade Guide Online Help for appliance, reseller, site, and user levels of administration for WEBppliance Pro You can access the online Help from the interface after installing WEBppliance Pro. To open the online Help for a particular level: a Log on to WEBppliance Pro at the respective level; for example, log on as the Appliance Administrator. b Click Help on the left navigation bar of the interface. You can access these documents from Document conventions Throughout this guide, specific fonts are used to identify computer input, output, and interface elements. Table 1 lists the typographic conventions used in this guide. Table 1. Typographic conventions Appearance of text Narrow bold text (sans serif font) Bold, italic text (serif font) Courier (typewriter-style) font How it is used Used for button names, column names, field names, file names, keystrokes, menu items, and path names. Example: From the File menu, choose Delete, then click OK. Used for information you type. Example: Type cd <directory name> on the command line. Used for system messages and screen text. Example: The following message is displayed: The server has been added. VI ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

7 ABOUT THIS GUIDE Key information is sometimes displayed using special headings and formats to make it stand out from regular text. The following special headings are used in this guide: Tip: Information to help you perform procedures Note: Supplemental information about tasks or concepts Important: Supplemental information that is more important than a note Caution: Warnings about potential damage to data or systems Feedback and support To take advantage of Ensim s support services or to find technical information quickly, visit the Ensim support page at If you need additional online support or if you would like to provide feedback about Ensim documentation, visit the Ensim online support page at ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE VII

8 ABOUT THIS GUIDE VIII ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

9 CHAPTER 1 Customizing the interface using skins Introduction This chapter includes information about using skins for WEBppliance Pro. Topics in this chapter include: What are skins on page 1-1 About WEBppliance skins on page 1-2 Downloading and decompressing a skin on page 1-4 Important: To use or modify skins, you must have a working knowledge of HTML, DTML, and Python. What are skins Skins are customizable interfaces that allow you to change the look and feel of your WEBppliance Pro control panel. Using skins, you can change the appearance of the WEBppliance Pro Graphical User Interface (GUI) and re-arrange links on various pages of the interface. You can also modify the Home page. Important: The appearance of the forms generated by WEBppliance Pro for various options (for example, adding a domain) cannot be changed. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 1-1

10 About WEBppliance skins Ensim provides two skins for WEBppliance Pro Mercury and Classic. Both skins are available from Ensim and packaged as ZIP files (mercury.zip and classic.zip). The zip files contain the necessary files required to change the interface. For information about obtaining the skins, see Downloading and decompressing a skin on page 1-4. Once you apply a skin, you will see changes in the left navigation bar of the administrative interface and the Shortcuts page (known as the Home page in WEBppliance Pro). You can apply the skin at a single level or across all levels. The selected level(s) will display the modifications, while the other level(s) will display the default interface. Ensure that you back up the old files before applying the new skin so that you can revert back to the default interface. Important: Resellers who have customized the navigation bar of their interfaces may have to reapply their customization to match the links of the Mercury and Classic skins after you apply any of the skins to WEBppliance Pro. WEBppliance Pro offers the following skin choices: Mercury skin Classic skin 1-2 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

11 Mercury skin The following figure shows the Appliance Administrator Home page for the Mercury skin of the WEBppliance Pro interface. Figure 1-1. The Appliance Administrator Home page for the Mercury skin Classic skin The following figure shows the Appliance Administrator Home page for the Classic skin of the WEBppliance Pro interface. Figure 1-2. The Appliance Administrator Home page for the Classic skin ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 1-3

12 Downloading and decompressing a skin The skins are packaged as ZIP files and are available for download from After downloading a skin file, decompress the zip file into a separate directory using WinZip or any other compression-decompression utility. Once you decompress the zip file, you will see folders with the following directory structure. Figure 1-3. Directory structure for the Classic skin after decompressing the classic.zip file 1-4 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

13 CHAPTER 2 Applying the skins Introduction This chapter provides instructions about applying the skins, changing from one skin to another, and reverting to the default interface. Topics in this chapter include: Applying the skins on page 2-1 Reverting to the default interface on page 2-5 Switching between skins on page 2-6 Applying the skins The procedure for applying the skins is the same for both the skins. You can apply the skins either for a single level or for all levels. You can also revert back to the original interface at any time after disabling the existing skin. Procedure: To apply a skin: 1 Ensure that you have downloaded the skin file (ZIP) and decompressed it to a temporary directory. During decompression, the directory structure corresponding to the WEBppliance installation is automatically created. This helps you copy the files correctly to their proper locations. For information about downloading and decompressing the skin files, see Downloading and decompressing a skin on page Connect to the WEBppliance server through the console or terminal services and log on as the administrator. 3 Open a command prompt window (Click Start -> Run -> type cmd -> OK), and change to the directory where you have decompressed the skin files (the customizeskins.vbs and disableskins.vbs files). ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 2-1

14 4 Stop the WEBppliance virtualhosting service by typing the following command at the command prompt. net stop virtualhosting Note: Stopping the virtualhosting service will make the WEBppliance administrative interface inaccessible until it is restarted again. 5 To apply the skin for a particular level, enter the following command at the command prompt. cscript customizeskins.vbs <level_name> where <level_name> can be AA, RA, SA, or UA for the Appliance Administrator, Reseller Administrator, Site Administrator, or User Administrator levels. Example: To enable the skin for the Appliance Administrator level: cscript customizeskins.vbs AA Example: To enable the skin for all levels: cscript customizeskins.vbs AA RA SA UA 6 Replace the following py, dtml, and image files. Important: Before you replace these files, make sure you have backed up all these files to a safe location. Doing so enables you to revert back to the default interface whenever required. The paths listed below assume that WEBppliance is installed in the default location on C:. For WEBppliance hosted on the ServerXchange platform, replace the path C:\Program Files\Ensim\WEBppliance with C:\Webgui. 2-2 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

15 Styles skinimages.py style.dtml in the folder C:\Program Files\Ensim\WEBppliance\base\common. Images All image files (*.gif and *.jpg) located in the folder C:\Program Files\Ensim\WEBppliance\images Login pages admin_welcome.dtml siteuser_welcome.dtml in the folder C:\Program Files\Ensim\WEBppliance\base\rollout. login.dtml in the folder C:\Program Files\Ensim\WEBppliance\published Appliance Administrator level files top.dtml frame.dtml navbar.dtml view_shortcuts.dtml in the folder C:\Program Files\Ensim\WEBppliance\published\webhost. Reseller Administrator level files top.dtml frame.dtml navbar.dtml view_shortcuts.dtml in the folder C:\Program Files\Ensim\WEBppliance\published\webhost\reseller. Site Administrator level files top.dtml frame.dtml navbar.dtml view_shortcuts.dtml in the folder C:\Program Files\Ensim\WEBppliance\published\webhost \services\winvirtualhosting\siteadmin. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 2-3

16 User Administrator level files top.dtml frame.dtml navbar.dtml in the folder C:\Program Files\Ensim\WEBppliance\published\webhost \services\winvirtualhosting\useradmin. 7 Add reference to the Verdana font in the font-list variable for the following files: blue-display.ini brown-display.ini green-display.ini grey-display.ini To do this: a Click Start > Search >For Files or Folders. b In the Search for files or folders named: text box, type blue-display.ini, browndisplay.ini, green-display.ini, grey-display.ini. c In the Look in: text box, enter the drive name where WEBppliance Pro is installed. d Click Search Now. The list of files found is displayed in the right pane. e Open each file in a text editor such as Notepad. f Search for the text string font-list. g Add verdana to the list of fonts. This should be the first font in the list. 8 Start the virtualhosting service by typing the following command. net start virtualhosting 2-4 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

17 Reverting to the default interface You can revert back to the default interface by disabling the current skin and restoring the old, backed up files. Procedure: To revert back to the default interface: 1 Connect to the WEBppliance server through the console or terminal services and log on as the administrator. 2 Open a command prompt window (click Start -> Run -> type cmd -> OK). 3 Stop the virtualhosting service by typing the following command. net stop virtualhosting 4 To disable skins for a particular level, enter the following command. cscript disableskins.vbs <level_name> where <level_name> can be either AA, RA, SA, or UA for the Appliance Administrator, Reseller Administrator, Site Administrator, or User Administrator levels. Example: For example, to disable the skins for the Appliance Administrator level: cscript disableskins.vbs AA Example: To disable the skins for all levels: cscript disableskins.vbs AA RA SA UA 5 Restore all the backed up files to their proper locations. For the list of files to be backed up, see step 6 in Applying the skins on page Start the virtualhosting service by typing the following command. net start virtualhosting ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 2-5

18 Switching between skins After applying a skin, you can switch to the other skin without reverting to the default interface. Procedure: To switch between skins: Important: The files included with each skin are unique to the skin (for example, skinimages.py), so you must ensure that you copy all the files for that skin into the required folder. 1 Connect to the WEBppliance server through the console or terminal services and log on as the administrator. 2 Open a command prompt window (click Start -> Run -> type cmd -> OK). 3 Change to the directory where you have decompressed the skin files (that contain the customizeskins.vbs and disableskins.vbs files). 4 Stop the virtualhosting service by typing the following command. net stop virtualhosting Note: Stopping the virtualhosting service will make the WEBppliance administrative interface inaccessible until it is restarted again. 5 Copy all the files from the directory of the skin that you wish to apply to the respective directories specified in Step 6 of Applying the skins on page 2-1. For information about the directory structure of the skin, see Figure 1-3, Directory structure for the Classic skin after decompressing the classic.zip file, on page Start the virtualhosting service by typing the following command. net start virtualhosting 2-6 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

19 CHAPTER 3 Modifying the current skin Introduction This chapter provides information on modifying the current skin. Topics in this section include: Replacing the existing interface images on page 3-1 Customizing the left navigation bar on page 3-8 Modifying the Shortcuts page on page 3-9 Replacing the existing interface images You can replace the existing interface images with your own custom images in one of two ways: Finding and replacing existing image files Adding new images Finding and replacing existing image files Every image used in the WEBppliance Pro interface has a name that is referenced by WEBppliance Pro. This name may be different than the actual image file name. Before replacing the images you need to find out the names of the images used in the WEBppliance Pro interface. Important: We recommend that you back up the existing images before you proceed with the replacement changes. This will allow you to revert back to the default interface if needed. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 3-1

20 Finding the name of an image used in the WEBppliance Pro interface Procedure: To find the name of an image used in the WEBppliance Pro interface: 1 Log on to the respective administrative level for which you want to change the image. For example, to change an image in the Site Administrator level interface, log on as the Site Administrator. 2 Right-click on the image and select Properties from the menu. For example, right-click on the image named Configure Mail Server and select Properties. The properties for the image display. The image name is contained in the Address (URL) field, which contains the published path of the image. The image name is the last part of this string. For example, in the address string webhost/services/winvirtualhosting/siteadmin/icon_sites_gif, the image name is icon_sites_gif. Important: The image name is used by WEBppliance Pro to display the image in the interface and may not be the same as the actual image file name. Once you find the name of an image, you can replace the image with your new image. 3-2 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

21 Replacing the existing image Procedure: To replace the existing image: 1 Find the name of the image you want to replace. For information about finding the image name, see Finding the name of an image used in the WEBppliance Pro interface on page Connect to the WEBppliance Pro server using the console or terminal services and log on as the administrator. 3 Open a Windows Explorer window and navigate to the directory C:\Program Files\Ensim\WEBppliance\base\common (assuming WEBppliance Pro is installed in the default location). 4 Locate the file skinimages.py, right-click on its name, and select Edit. The file opens in the Python editor. This file contains the details of the images and the image file name corresponding to the image name. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 3-3

22 5 Locate the reference to the image name (as described in step 1) within the skinimages.py file by using the editor s Find command (Edit -> Find). For example, to find all references to the file icon_sites_gif, click Edit -> Find, type icon_sites_gif, and click Find Next. The image name is highlighted and the cursor moves to that position in the file. The file skinimages.py contains the image names used by WEBppliance Pro in the interface, their corresponding file names, and image sizes. In each row, the left side contains the image name and the right side contains the image name followed by the file name and size. Note down the file name and size. For example: icon_sites_gif', BORDER=0, WIDTH=75, HEIGHT= ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

23 6 Create a new image with the same file name and size as the image that you want to replace. Important: Ensure that you keep the size of your custom image the same as the original. If you want an image of different size, you must change the size mentioned in the skinimages.py file corresponding to the image name. For example, if your new image icon_sites_gif is of size 50 x 30 pixels, you must change the size definition in the skinimages.py file to read WIDTH=50, HEIGHT=30. 7 Replace the existing image file in the directory C:\Program Files\Ensim\WEBppliance\images. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 3-5

24 8 Stop and start the virtualhosting service by typing the following commands. net stop virtualhosting net start virtualhosting Tip: To replace multiple images, complete steps 5 through 7 for all images and then restart the virtualhosting service rather than restarting it for each image. 9 Log on to the administrative interface for which you changed the image, for example, the Site Administrator, and confirm that the interface uses your new image. Adding new images Alternatively, you can add new images to the interface by creating new image files. These can be used for new links that you add to the Home page. For instructions about adding links to the Home page, see Modifying the Shortcuts page on page 3-9. Procedure: To add new images: 1 Connect to the WEBppliance Pro server using the console or terminal services and log on as the administrator. 2 Copy the new image to the directory C:\Program Files\Ensim\WEBppliance\images (assuming WEBppliance Pro is installed in the default location). 3 Open a Windows Explorer window and change to the directory C:\Program Files\Ensim\WEBppliance\base\common (assuming WEBppliance Pro is installed in the default location). 3-6 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

25 4 Locate the file skinimages.py, right-click its name, and select Edit. The file opens in the Python editor. The file skinimages.py contains the image names used by WEBppliance Pro in the interface, their corresponding file names, and image sizes. In each row, the left side contains the image name and the right side contains the image name followed by the file name and size. 5 Copy the details for an existing image and paste it at the end of the file. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 3-7

26 6 Replace the image name in the left and right columns with a new name and the name of the image file (.gif) by your own file name. Change the image size definition to match your own image. 7 Stop and start the virtualhosting service by typing the following commands. net stop virtualhosting net start virtualhosting 8 Log on to the administrative interface for which you changed the image, for example, the Site Administrator, and confirm that the interface uses your new image. Customizing the left navigation bar If you have customized the left navigation bar of the WEBppliance interface and you apply a skin after upgrading to WEBppliance Pro, some of the links in the navigation bar may get distorted. To correct this problem, you must reapply your customizations by using the Customization > Navigation Bar option of WEBppliance Pro. The Navigation Bar option allows you to upload a custom navigation bar. For more information and instructions about uploading a custom navigation bar, see the Appliance Administrator online Help. Click Help in the left navigation bar to open the online Help. 3-8 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

27 Modifying the Shortcuts page You can modify the Shortcuts page (now called the Home page in WEBppliance Pro) for each level by modifying the corresponding view_shortcuts.dtml file. The User Administrator level does not have a Shortcuts page. The view_shortcuts.dtml file is located in the following paths corresponding to each level (assuming that WEBppliance Pro is installed in the default location). Note: Please backup the files before you modify them so that you can revert back in case of any problems. For the ServerXchange version of WEBppliance Pro, replace C:\Program Files\Ensim\WEBppliance with C:\Webgui. Appliance Administrator C:\Program Files\Ensim\WEBppliance\published\webhost Reseller Administrator C:\Program Files\Ensim\WEBppliance\published\webhost\reseller Site Administrator C:\Program Files\Ensim\WEBppliance\published\webhost\services\ winvirtualhosting\siteadmin Procedure: To modify the Home page: 1 Modify the view_shortcuts.dtml file. This page contains the links arranged in table cells. You can rearrange the links or add your own link by modifying this table. Take care not to modify any variables or code elements other than the HTML tags used for positioning. 2 Save the view_shortcuts.dtml file. 3 To see the changes, stop and start the virtualhosting service by using the following commands from the command prompt. net stop virtualhosting net start virtualhosting ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 3-9

28 3-10 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

29 CHAPTER 4 Automating the application of skins Introduction This chapter includes information about using a batch file to automate the application of skins to WEBppliance Pro. If you need to change between skins or apply the skin to a number of servers, using a batch file may save time and cut down on errors. The batch files given in this chapter are intended to be used only as examples. You may have to modify these files to suit your WEBppliance Pro environment. Important: It is recommended that before applying the skins, you back up the files that will be replaced. For information about the files replaced and their location, see step 6 in Applying the skins on page 2-1. This chapter contains the following sample batch files: Batch file for applying the Mercury skin to the default interface Batch file for reverting to the default interface Batch file for applying the Classic skin over the Mercury skin Download and uncompress the skin file before running any of the batch files. For information about downloading and uncompressing the skin file, see Downloading and decompressing a skin on page 1-4. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 4-1

30 Batch file for applying the Mercury skin to the default interface For the following example, it is assumed that WEBppliance Pro is installed in the default location, namely, C:\Program Files\Ensim\WEBppliance, and the skin files are located in the directory C:\skintest\mercury. This file applies the skin to all levels of the WEBppliance Pro administrative off net stop virtualhosting cscript customizeskins.vbs AA RA SA UA copy "C:\skintest\mercury\base\common\*.*" "C:\Program Files\Ensim\WEBppliance\base\common" copy "C:\skintest\mercury\base\rollout\*.*" "C:\Program Files\Ensim\WEBppliance\base\rollout" copy "C:\skintest\mercury\images\*.*" "C:\Program Files\Ensim\WEBppliance\images" copy "C:\skintest\mercury\published\login.dtml" "C:\Program Files\Ensim\WEBppliance\published" xcopy "C:\skintest\mercury\published\webhost\*.*" "C:\Program Files\Ensim\WEBppliance\published\webhost" /s /y net start virtualhosting Important: If your folder names contain spaces, you must enclose the complete string in quotes (for example, <path>, where <path> is the complete path of the folder). 4-2 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

31 Batch file for reverting to the default interface For the following example, it is assumed that WEBppliance Pro is installed in the default location, namely, C:\Program Files\Ensim\WEBppliance, and the backup files are located in the directory C:\skintest\backup. This file applies the skin to all levels of the WEBppliance administrative off net stop virtualhosting cscript disableskins.vbs AA RA SA UA copy "C:\skintest\backup\base\common\*.*" "C:\Program Files\Ensim\WEBppliance\base\common" copy "C:\skintest\backup\base\rollout\*.*" "C:\Program Files\Ensim\WEBppliance\base\rollout" copy "C:\skintest\backup\images\*.*" "C:\Program Files\Ensim\WEBppliance\base\common" xcopy "C:\skintest\backup\published\webhost\*.*" "C:\Program Files\Ensim\WEBppliance\published\webhost" /s /y net start virtualhosting Batch file for applying the Classic skin over the Mercury skin This file applies the Classic skin for all levels overwriting the Mercury skin. For the following example, it is assumed that WEBppliance Pro is installed in the default location, namely, C:\Program Files\Ensim\WEBppliance, and the skin files are located in the directory off net stop virtualhosting copy "C:\skintest\classic\base\common\*.*" "C:\Program Files\Ensim\WEBppliance\base\common" copy "C:\skintest\classic\base\rollout\*.*" "C:\Program Files\Ensim\WEBppliance\base\rollout" copy "C:\skintest\classic\images\*.*" "C:\Program Files\Ensim\WEBppliance\images" copy "C:\skintest\classic\published\login.dtml" "C:\Program Files\Ensim\WEBppliance\published" xcopy "C:\skintest\classic\published\webhost\*.*" "C:\Program Files\Ensim\WEBppliance\published\webhost" /s /y net start virtualhosting ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 4-3

32 4-4 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

33 CHAPTER 5 Customizing domains Introduction This chapter includes information about customizing the domains that you create using WEBppliance Pro and customizing WEBppliance Pro features for these domains. Chapters in this guide include: Customizing domains on page 5-1 Customizing WEBppliance Pro features for new domains on page 5-3 Customizing domains You can customize new domains that you create using WEBppliance Pro by: Creating custom batch files Setting up additional files and directories for new domains Creating custom batch files You can create the following custom batch files to customize new or existing domains. CustomVirtDomain.bat This batch file is located in <sitedata_install_dir>\webppliance\conf\custom\appliance where <sitedata_install_dir> is C:\Program Files\Ensim\SiteData if WEBppliance Pro is installed in the default location. The batch file is invoked when the Appliance Administrator creates a domain. CustomDelVirtDomain.bat This batch file is located in <sitedata_install_dir>\webppliance\conf\custom\appliance where <sitedata_install_dir> is C:\Program Files\Ensim\SiteData if WEBppliance Pro is installed in the default location. The batch file is invoked when the Appliance Administrator removes a domain. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 5-1

34 CustomVirtDomain_<xxx>.bat Here, <xxx> is the reseller name. This batch file must be located in <sitedata_install_dir>\webppliance\conf\custom\reseller where <sitedata_install_dir> is C:\Program Files\Ensim\SiteData if WEBppliance Pro is installed in the default location. The batch file is invoked when the Reseller Administrator creates a domain. CustomDelVirtDomain_<xxx>.bat Here, <xxx> is the reseller name. This batch file must be located in <sitedata_install_dir>\webppliance\conf\custom\reseller where <sitedata_install_dir> is C:\Program Files\Ensim\SiteData if WEBppliance Pro is installed in the default location. The batch file is invoked when the Reseller Administrator removes a domain. The batch files are invoked differently for new and existing domains. For new domains The customizations specified in the custom batch files are automatically applied to all new domains created or removed by the Appliance or Reseller Administrator depending on the type of batch file. For existing domains Existing domains are not affected by the customization unless you manually execute the custom batch files from the command line by passing the following arguments. domainname - The name of the domain to be customized siteadminname - The name of the Site Administrator for the domain resellername - The name of the reseller for the domain The resellername argument is empty when the Appliance Administrator creates or removes domains. 5-2 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

35 Setting up additional files and directories for new domains To set up additional files and directories for new domains, you need to create the desired files and directories in the path: <install_dir>\base\services\winvirtualhosting\filesystemtemplate where, <install_dir> is C:\Program Files\Ensim\Webppliance if WEBppliance Pro is installed in the default location. When a new domain is created, it will automatically have all the files and directories present in the path: <install_dir>\base\services\winvirtualhosting\filesystemtemplate. Important: Do not remove any existing directories from the path: <install_dir>\base\services\winvirtualhosting\filesystemtemplate as it can affect the functioning of WEBppliance Pro. Also, the directories wwwroot, log, and home should never be created under the path inetpub\ftproot for any domain. Customizing WEBppliance Pro features for new domains You can customize new domains created using WEBppliance Pro by: Inserting custom Web site welcome pages Inserting links in the Web site welcome pages Inserting custom Web site welcome pages When you create a new Web site, WEBppliance Pro assigns a default welcome page to it. To replace the default page with your own welcome page, replace the default.htm file in the directory <install_dir>\base\services\winvirtualhosting\filesystemtemplate\ inetpub\wwwroot with your own default.htm file. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 5-3

36 Inserting links in the Web site welcome pages To make logging on quick and convenient for administrators, you can add links in the Web site welcome page that link to the login screens for the Site Administrators and User Administrators. Important: The User Administrator level is available only if you have installed a mail server and mail server add-on on the WEBppliance Pro server. For more information about obtaining and installing a mail server, contact Ensim Support. For information on support options, see Feedback and support on page -vii. To insert a link to the Site Administrator login screen: Add the following code to the custom welcome page in the file <install_dir>\base\services\winvirtualhosting\filesystemtemplate\inetpub\ wwwroot\default.htm. Access to your Site Administrator: <a href= ENSIM_DOMAINNAME/admin/ > When you create the domain, WEBppliance Pro will replace the variable ENSIM_DOMAINNAME with the name of the domain. To insert a link to the User Administrator login screen: Add the following code to the custom welcome page in the file <install_dir>\base\services\winvirtualhosting\filesystemtemplate\inetpub\ wwwroot\default.htm. Access to your User Administrator: <a href= ENSIM_DOMAINNAME/user/ > When you create the domain, WEBppliance Pro will replace the variable ENSIM_DOMAINNAME with the name of the domain. Note: The default welcome page already includes links to the Site Administrator and User Administrator login screens. 5-4 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

37 CHAPTER 6 Using Command Line Interface scripts This chapter presents the Command Line Interface scripts that you can use to create, edit, and delete domains/sites on your WEBppliance Pro server. Topics in this chapter include: Adding a name-based domain using an existing plan on page 6-2 Adding an IP-based domain using an existing plan on page 6-3 Adding a name-based domain without using an existing plan on page 6-4 Adding an IP-based domain without using an existing plan on page 6-9 Editing a domain s properties on page 6-15 Deleting a domain on page 6-16 To use this API, use a Terminal Services Client to create a session on a Microsoft Windows server running WEBppliance Pro. In your terminal services session, start a command window, then type in any of the commands described in this chapter. All command lines return zero (0) on normal termination and a non-zero value on failure. Note: All the arguments are in XML (extensible Markup Language) format. You have two available options to create, edit, and delete your domains: the -f option and the -s option. These two options are mutually exclusive so you can use either one. The -f option allows you to specify the complete path where the XML file resides, while the -s option allows you to enter the XML as a string. We recommend that you use the command line to first create the XML file using a standard text editor, then use the -f option to specify the name of this file. If you use the string -s option, remember that you cannot use line breaks, and the entire XML has to be on a single line. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 6-1

38 Adding a name-based domain using an existing plan To add a name-based domain using an existing plan, use the command: adddomain -f <filepath> or where <filepath> is the complete path where the XML file resides. adddomain -s <string> where <string> is a string that uses the XML format specified below. The string must be enclosed in quotes. Important: All fields are required. They are also case sensitive and must be entered as specified in this document. <xml> <type>namebased</type> specifies that the domain is a name-based domain. <domain>domain.com</domain> the name of the domain you want to create. <setdns>1</setdns> a flag indicating whether the local DNS server should be updated with information about this newly created domain. 0 means do not add DNS records and 1 means add DNS records. Use this if you are using WEBppliance Pro as your authoritative name server for this domain. <reseller></reseller> the name of the reseller to whom this domain belongs. If not specified, this domain will belong to the Appliance Administrator. <style_name>brown-display</style_name> the name of the color scheme for the Site Administrator interface for this domain. Possible values are: blue-display for the Cerulean Blue color scheme, brown-display for the Classic Lavender color scheme, green-display for the Serene Green color scheme, and grey-display for the Soothing Grey color scheme. <templatename>defaultplan</templatename> the plan you are using to choose domain settings. <datadrive>c:</datadrive> the drive where the data for this domain will be stored. <user>username</user> the name of the admin user. <password>ensim</password> password for the admin user. < >someone@somewhere.com</ > an address where alerts for this domain can be sent. 6-2 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

39 <send >0</send > when the domain is added should the appliance send notification to the site admin of the newly created site. 0 means do not send and 1 means send . <from>somebody@ensim.com</from> the address of the Appliance Administrator which appears in the From field of the notification sent to the Site Administrator when the domain is created. < content>hello</ content> the content of the notification sent to the Site Administrator when the domain is created. <subject>hello</subject> the subject of the notification sent to the Site Administrator when the domain is created. </xml> Adding an IP-based domain using an existing plan To add an IP-based domain using an existing plan, use the command: adddomain -f <filepath> or where <filepath> is the complete path where the XML file resides. adddomain -s <string> <xml> where <string> is a string that uses the XML format specified below. The string must be enclosed in quotes. <type>ipbased</type> specifies that the domain is an IP-based domain. <domain>domain.com</domain> the name of the domain you want to create. <ip> </ip> the IP address of the newly created domain. <setdns>1</setdns> a flag indicating whether the local DNS server should be updated with information about this newly created domain. 0 means do not add DNS records and 1 means add DNS records. Use this if you are using WEBppliance Pro as your authoritative name server for this domain. <reseller></reseller> the name of the reseller to whom this domain belongs. If not specified, this domain will belong to the Appliance Administrator. <style_name>brown-display</style_name> the name of the color scheme for the Site Administrator interface for this domain. Possible values are: blue-display for the Cerulean Blue color scheme, brown-display for the Classic Lavender color scheme, green-display for the Serene Green color scheme, and grey-display for the Soothing Grey color scheme. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 6-3

40 <templatename>defaultplan</templatename> the plan you are using to choose domain settings. <datadrive>c:</datadrive> the drive where the data for this domain will be stored. <user>username</user> the name of the admin user. <password>ensim</password> password for the admin user. an address where alerts for this domain can be sent. <send >0</send > when the domain is added should the appliance send notification to the site admin of the newly created site. 0 means do not send and 1 means send . <from>somebody@ensim.com</from> the address of the Appliance Administrator which appears in the From field of the notification sent to the Site Administrator when the domain is created. < content>hello</ content> the content of the notification sent to the Site Administrator when the domain is created. <subject>hello</subject> the subject of the notification sent to the Site Administrator when the domain is created. </xml> Adding a name-based domain without using an existing plan To add a name-based domain without using an existing plan, use the command: adddomain -f <filepath> or where <filepath> is the complete path where the XML file resides. adddomain -s <string> <xml> where <string> is a string that uses the XML format specified below. The string must be enclosed in quotes. <type>namebased</type> specifies that the domain is a name-based domain. <datadrive>c:</datadrive> the drive where the data for this domain will be stored. 6-4 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

41 <maxusers>25</maxusers> maximum number of users that can be created in this domain. This is valid only if a mail server and mail server add-on is installed on the WEBppliance server. <style_name>brown-display</style_name> the name of the color scheme for the Site Administrator interface for this domain. Possible values are: blue-display for the Cerulean Blue color scheme, brown-display for the Classic Lavender color scheme, green-display for the Serene Green color scheme, and grey-display for the Soothing Grey color scheme. <setdns>1</setdns> a flag indicating whether the local DNS server should be updated with information about this newly created domain. 0 means do not add DNS records and 1 means add DNS records. Use this if you are using WEBppliance Pro as your authoritative name server for this domain. <reseller></reseller> the name of the reseller to whom this domain belongs. If not specified, this domain will belong to the Appliance Administrator. <diskquota>100</diskquota> disk quota for this domain, in MB. Set to 0 for unlimited. <user>username</user> the name of the admin user. <password>ensim</password> password for the admin user. <domain>domain.com</domain> the name of the domain. <send >0</send > when the domain is added should the appliance send notification to the Site Administrator of the newly created site. 0 means do not send and 1 means send . < >someone@somewhere.com</ > an address where alerts for this domain can be sent. <from>somebody@ensim.com</from> the address of the Appliance Administrator which appears in the From field of the notification sent to the Site Administrator when the domain is created. < content>hello</ content> the content of the notification sent to the Site Administrator when the domain is created. <subject>hello</subject> the subject of the notification sent to the Site Administrator when the domain is created. <services> <frontpage>1</frontpage> if this is 1, then FrontPage is available for this domain. <php>1</php> if this is 1, then PHP is available for this domain. <mssqlodbc>0</mssqlodbc> if this is 1, then MS SQL is available for this domain. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 6-5

42 <mysql>1</mysql> since MySQL depends on whether ODBC is enabled or not, this value should always be 1. <winanalog>1</winanalog> if this is 1, then the Analog service is available for this domain. <perl>1</perl> if this is 1, then Perl is available for this domain. <odbc>1</odbc> if this is 1, then the domain is allowed to open an ODBC connection. <urchin>1</urchin> if this is 1, then Urchin is available for this domain. However, this would be applicable only if Urchin and the Urchin add-on is installed on the WEBppliance server. WEBppliance does not install Urchin by default. <winfiles>1</winfiles> whether file manager is enabled for the site. 1 means file manager is enabled so that site admin can view his files using the GUI based file manager. 0 means file manager is not enabled. <msftpsvc> this section sets parameters for the FTP service. <connectiontimeout>900</connectiontimeout> value, in seconds, when the FTP server closes an idle connection. <maxconnections>50</maxconnections> the largest allowed number of simultaneous FTP connections to this domain. <maxconnectionsunlimited>1</maxconnectionsunlimited> if this is 1, then the domain supports unlimited simultaneous FTP connections (the previous tag is ignored). <accessread>1</accessread> read/download access allowed to users of the site. 1 means allowed, 0 means not allowed. <accesswrite>1</accesswrite> whether upload access is allowed for the site users. 1 means allowed, 0 means not allowed. <allowanonymous>1</allowanonymous> if this is 1, then anonymous logins are allowed. <logtype>1</logtype> whether IIS logging should be enabled or disabled for the site. 0 means disabled 1 means enabled. <msdosdiroutput>1</msdosdiroutput> how directory listing should appear in FTP. Should the directory listing be in UNIX style or should it be in DOS style? 1 means DOS style; 0 means UNIX style. <exitmessage>goodbye</exitmessage> message given to clients when their session terminates. <greetingmessage>hello</greetingmessage> message given to clients after login. 6-6 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE

43 <maxclientsmessage>too many users. Try again later. </maxclientsmessage> message given to clients when the maximum connection limit is exceeded. <msftpsvc>1</msftpsvc> whether FTP service is enabled or disabled for a site. When this value is 0 then FTP is not enabled for the site; 1 means it is enabled for the site. </msftpsvc> <w3svc> <ssi>1</ssi> if this is 1, then IIS supports Server Side Include scripts. <sslc>0</sslc> because SSL is not supported for name-based sites, this value should always be set to 0. <maxconnectionsunlimited>1</maxconnectionsunlimited> if this is 1, then IIS will allow unlimited simultaneous connections. <maxconnections>100</maxconnections> the maximum allowed number of simultaneous connections to the IIS server. <allowkeepalive>1</allowkeepalive> allows a client to maintain an open connection with the server, rather than re-opening the client connection with each new request. 0 means disabled; 1 means enabled. <appisolated>2</appisolated> this decides whether an application launched from IIS will be part of the IIS application pool ( shared pool with a low security level or dedicated pool with a high security level). Allowed values are 1 for dedicated pool and 2 for shared pool. <enablereversedns>1</enablereversedns> decides whether IIS should look up the DNS name for the IP address of an incoming connection for use with logging.1 means reverse DNS lookup is enabled; 0 means that is not enabled. <enablecpuquota>1</enablecpuquota> if this is 1, then the CPU quota of the site will be restricted as described in the following tag. <cpuquota>100</cpuquota> this specifies the % of CPU time the process is allowed to consume. This tag is used only when the <enablecpuquota> tag is set to 1. <accessread>1</accessread> decides whether site users can read files from the site.1 means that it is allowed; 0 means that it is not allowed. <accesswrite>0</accesswrite> decides whether to allow users to upload files and their associated properties to the enabled directory on the server, or to change content in a Write-enabled file. Write can only be done with a browser that supports the PUT feature of the HTTP 1.1 protocol standard. 1 means that it is enabled; 0 means that it is disabled. ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE 6-7

44 <accesssslflags>1</accesssslflags> This flag governs what kind of access the site has. Whether this site is only browsable with HTTPS or it is browsable with HTTP. 1 means only HTTPS should be allowed (a certificate must be applied first so that site remains browsable). It enforces a secure channel; 0 means that HTTP should be allowed. <execflag>1</execflag> This controls what kind of execute permissions are allowed. The options under IIS available are None, Scripts only, and Scripts and Executables. Accordingly the values that must be specified in this field are: 0 for None, 1 for Scripts, and 2 for Scripts and Executables. <enabledirbrowsing>1</enabledirbrowsing> whether directory browsing should be enabled or disabled for the site. 1 means directory browsing is enabled for the site; 0 means that it is disabled. <enabledefaultdoc>0</enabledefaultdoc> whether default documents are enabled or not that is, when the site is browsed if default document is enabled it will show the first document from the default document list; otherwise, it will fail with error. 1 means default document is enabled; 0 means that default document is not enabled. <defaultdoc>default.html</defaultdoc> the file name of the default document for a domain. <logtype>1</logtype> whether IIS should log all the requests for web sites. 1 means logging is enabled; 0 means logging is disabled. <enablebandwidthquota>1</enablebandwidthquota> if this is 1, then the bandwidth quota of the site will be restricted as described below. <maxbandwidth>100</maxbandwidth> maximum bandwidth to be consumed by the site. It is specified in Kbps. <connectiontimeout>900</connectiontimeout> value, in seconds, when IIS closes an idle connection. <serversize>1</serversize> This field specifies the size of the server, in terms of number of client requests processed per day. A value of 0 indicates a small Web site that would expect to receive fewer than 10,000 requests per day, a value of 1 indicates a medium site handling between 10,000 and 100,000 requests a day, and a value of 2 designates a large site processing more than 100,000 requests a day. <enabledocfooter>0</enabledocfooter> whether document footer is enabled or not. 1 means enabled 0 means disabled. <defaultdocfooter>footer</defaultdocfooter> This field must be present but its contents are ignored in the current product. <footertype>0</footertype> this identifies what to use as the footer: a file or a string. 0 means file is to be used so footerfile field is used; 1 means string is to be used, so footerstring is used. 6-8 ENSIM WEBPPLIANCE PRO FOR WINDOWS 2000 (UPGRADE) TECHNICAL REFERENCE GUIDE