Configuring Domains and Regions in the MGI Server Admin

Before proceeding, you should have installed MGI and set up any web site account on your machine (including any entries for virtual hosting).

The MGI Server Admin has other features such as logging and security, however the instructions below only pertain to allowing a web site access to MGI modules.

1. Open the MGI Server Admin

To use the MGI Server Admin, access the "MGIServerAdmin.XXX" page (where XXX is any suffix ir extension mapped to MGI2) in a web browser using any virtually hosted domain on the server (including the server name or IP address). For example, "http://www.domain.com/mgiserveradmin.mgi".

2. Click the "Domain Management" Button.

3. Create an MGI Domain for Each Web Site

Virtually hosted domains are configured differently from non-dns accounts (i.e., folders at the root of WebSTAR that do not have a domain name).

For Each Virtually Hosted Domain (i.e., Accounts with a Domain Name):
 
a. Add a Domain. Under "Create new domain" enter the web site's main domain name (e.g., "domain.com") and click the "Create..." button. This name is simply a label for the web site so that you can recognize the web site in the Domain Management list.
 
b. Configure Domain Preferences. Select the domain in the Domain Management list and click the "Edit" button.
  • Virtual Hosts. In the text box under Domain Preferences, enter all virtual hosts that resolve to the selected web site (e.g., "domain.com", "www.domain.com", and "third.domain.com"). Enter each host on one line with a return. Be sure you enter the virtual hosts for all domains that resolve to the selected web site including redirects. Click the "Save" button. Preference changes take effect immediately.
  • Module Access for the Domain. At the bottom of the Domain Preferences window the modules available for the web site are listed. The module list does not reflect modules that are disabled at the server level (under Module Management in the MGI Server Admin). By default the web site has access to all modules. To disable the web site's access to a module, click the "Disable" button beside the module. When disabled the module name displays in plain text with a line through the name. To enabled a module, click the "Enable" button beside the module. When enabled the module name displays in bold text.
  • Default Domain. If you are running a shared hosting environment, we recommend that you disable all modules in the Default Domain. This will disallow unauthorized use of MGI on your server and prevent unintended shared databases and other access.
 
c. Add Regions or Use Default Region. Click the "Regions" link beside "Domain Preferences" to view the "Region Management" list. Regions specified in the Region Management list restrict file paths within the region to the root of the region (i.e., a file path cannot walk "up and out" of a defined region) and restrict database access and other settings to the region. Regions can be created to separate access and settings between sub-folders of a web site. For example, if you need to separate database access for different divisions of a company that are sub-folders of a web site, you could create a region for each division. For the majority of web sites, shared access within a domain is preferred and allowed, therefore the default region (/ - the root level) is used.
 
To add a region, enter the region (sub-folder) path under "Create new region" and click the "Create..." button. The region path is based on your virtual host mapping. A region is any sub-folder under the mapping level of the domain for the region. For example, if your virtual host "domain.com" maps to the folder "/domain/" and you want to create a region for "/domain/shop/", then you would enter "shop" as the region path. However, if you have the domain "shop.domain.com" mapped to the folder "/domain/shop/", then the "shop" folder is actually the root level ("/") of that domain.
 
NOTE: If you are using a virtual host application that modifies the URL rather than maintaining separate virtual roots (such as Welcome in normal mode or HomeDoor on a Macintosh), you must prepend the region name with the host folder path. For example, the Welcome admin requires a "host folder" for each virtual host. If the host folder for a domain is "/websites/" then the non-dns account region name should be entered as "/websites/accountFolderName/". If you are running a "true" virtual hosting system (such as WebSTAR Virtual Host or Welcome in router mode on a Macintosh or an NT IIS virtual hosting system), there is no need to prepend information to the region name since the URL is not modified.
 
d. Configure Region Preferences. Settings for the default region will apply to any region (sub-folder) in the web site that is not configured as a separate region. To configure a region's preferences, select the region in the list and click the "Edit" button.
  • Remove Unprocessed Tags. By default MGI tags that are not recognized or that are not processed are removed from pages before they are served. To leave unrecognized or unprocessed tags in pages, check the box beside "Do Not Remove Unprocessed MGI Tags".
  • Embedded Error Checking. By default MGI does not check for errors in MGI tags that are embedded in HTML. To have MGI check and report errors in embedded tags, check the box beside the "Report Errors in Embedded MGI Tags". Warning: MGI may find embedding errors in scripts such as Javascript which are not actually errors and are acceptable coding. To remedy this problem, add spaces to the script near embedded tags (after open brackets "<") or turn this option off.
  • Default Index Pages. In WebSTAR (Mac) only, you have the option of using the default index pages defined in the web server admin or using the default index pages defined for the region of the specified web site. By default, the region is set to use the "Web Server-Defined Default Pages". To use the default index pages listed for the region, select the radio button beside "Use". Enter each default index page on one line with a return. For example, you may want the "index.html", "index.htm", and "index.mgi" pages to be served by default when a specific index page is not entered. Default pages are checked and served in the order entered.
  • Custom Error Pages. By default, MGI error pages, (e.g., the "Wow, I bet you didn't expect to see this..." page) display when errors occur. To a custom error page instead of the default MGI error page, select the radio button beside "Use" and enter the name of the custom error page (from the root of the region). A custom error page can display specific aspects of an error using the mgiGetErrorParameter tag.
  • File Upload Preferences. In the Region Preferences, you may configure the file upload settings including the maximum file size (in kilobytes), the sub-folder (inside the selected region) where files are saved, the regular expressions that a file name must match to be uploaded, and the IP addresses that are allowed or denied access to upload files. See the MGI Server Admin Features or MGI User Guide for more information about configuring the File Upload preferences.
  • Save the Region Preferences. Click the "Save" button to save the Region Preferences. Preference changes take effect immediately.
  • Module Access for the Region. At the bottom of the Region Preferences window the modules available for the selected region are listed. A module disabled in the Domain Management window will not be listed in the Region Preferences window. By default the region has access to all modules. To disable the region's access to a module, click the "Disable" button beside the module. When disabled the module name displays in plain text with a line through the name. To enabled a module, click the "Enable" button beside the module. When enabled the module name displays in bold text.
  • Module Preferences. To configure the module preferences, click the "Edit..." button beside the module name. Under the Module Preferences window, the MGI tags in each module are listed. By default the region has access to all tags in each module. To disable access to a specific MGI tag within a module, uncheck the box beside the tag name and click the "Save" button. To enabled an MGI tag within a module, check the box beside the tag name and click the "Save" button or click the "Revert" button to return all settings to default. Additional settings for specific MGI functions such as database search result limits, date and time GMT offsets, and mail server settings may also be entered in the module preferences. If you change the module preferences, click the "Save" button to save the settings. Preference changes take effect immediately.
 
For Non-DNS Accounts:
 
a. Add one Domain for all Non-DNS folders. Under " Create new domain" enter a label for the non-dns accounts (e.g., "non-dns") and click the "Create..." button. This name is simply a label for these accounts so that you can recognize them in the Domain Management list.
 
b. Configure Domain Preferences. Select the non-dns account in the Domain Management list and click the "Edit" button.
  • Virtual Hosts. In the text box under Domain Preferences, enter all virtual hosts that resolve to the root level of the server. For example, your server's IP address or name (e.g., server.domain.com) may resolve to the root level of the server. Enter the domain or IP address that clients use to access their non-dns web site. Enter each host on one line with a return. Click the "Save" button. Preference changes take effect immediately.
  • Module Access. At the bottom of the Domain Preferences window the modules available for all non-dns web sites are listed. The module list does not reflect modules that are disabled at the server level (under Module Management in the MGI Server Admin). By default the web sites have access to all modules. To disable access to a module, click the "Disable" button beside the module. When disabled the module name displays in plain text with a line through the name. To enabled a module, click the "Enable" button beside the module. When enabled the module name displays in bold text. You may enable or disable module access for specific non-dns accounts under region preferences.
 
c. Add a Region for Each Non-DNS Account. Click the "Regions" link beside "Domain Preferences" to view the "Region Management" list. Add a region for each non-dns web site. To add a region, enter the web site's folder name under "Create new region" and click the "Create..." button.
 
NOTE: If you are using a virtual host application that modifies the URL rather than maintaining separate virtual roots (such as Welcome in normal mode or HomeDoor on a Macintosh), you must prepend the region name with the host folder path. For example, the Welcome admin requires a "host folder" for each virtual host. If the host folder for a domain is "/websites/" then the non-dns account region name should be entered as "/websites/accountFolderName/". If you are running a "true" virtual hosting system (such as WebSTAR Virtual Host or Welcome in router mode on a Macintosh or an NT IIS virtual hosting system), there is no need to prepend information to the region name since the URL is not modified.
 
Default Region. If you are running a shared hosting environment, we recommend that you disable all modules in the Default Region of your Non-DNS domain. This will disallow unauthorized use of MGI on your server and prevent unintended shared databases and other access.
 
d. Configure Region Preferences. Settings for the default region will apply to any non-dns folder that is not configured as a separate region. To configure a region's preferences, select the region in the list and click the "Edit" button.
  • Remove Unprocessed Tags. By default MGI tags that are not recognized or that are not processed are removed from pages before they are served. To leave unrecognized or unprocessed tags in pages, check the box beside "Do Not Remove Unprocessed MGI Tags".
  • Embedded Error Checking. By default MGI does not check for errors in MGI tags that are embedded in HTML. To have MGI check and report errors in embedded tags, check the box beside the "Report Errors in Embedded MGI Tags". Warning: MGI may find embedding errors in scripts such as Javascript which are not actually errors and are acceptable coding. To remedy this problem, add spaces to the script near embedded tags (after open brackets "<") or turn this option off.
  • Default Index Pages. In WebSTAR (Mac) only, you have the option of using the default index pages defined in the web server admin or using the default index pages defined for the region of the specified web site. By default, the region is set to use the "Web Server-Defined Default Pages". To use the default index pages listed for the region, select the radio button beside "Use". Enter each default index page on one line with a return. For example, you may want the "index.html", "index.htm", and "index.mgi" pages to be served by default when a specific index page is not entered. Default pages are checked and served in the order entered.
  • Custom Error Pages. By default, MGI error pages, (e.g., the "Wow, I bet you didn't expect to see this..." page) display when errors occur. To a custom error page instead of the default MGI error page, select the radio button beside "Use" and enter the name of the custom error page (from the root of the region). A custom error page can display specific aspects of an error using the mgiGetErrorParameter tag.
  • File Upload Preferences. In the Region Preferences, you may configure the file upload settings including the maximum file size (in kilobytes), the sub-folder (inside the selected region) where files are saved, the regular expressions that a file name must match to be uploaded, and the IP addresses that are allowed or denied access to upload files. See the MGI Server Admin Features or MGI User Guide for more information about configuring the File Upload preferences.
  • Save the Region Preferences. Click the "Save" button to save the Region Preferences. Preference changes take effect immediately.
  • Module Access for the Region. At the bottom of the Region Preferences window the modules available for the selected region are listed. A module disabled in the Domain Management window will not be listed in the Region Preferences window. By default the region has access to all modules. To disable the region's access to a module, click the "Disable" button beside the module. When disabled the module name displays in plain text with a line through the name. To enabled a module, click the "Enable" button beside the module. When enabled the module name displays in bold text.
  • Module Preferences. To configure the module preferences, click the "Edit..." button beside the module name. Under the Module Preferences window, the MGI tags in each module are listed. By default the region has access to all tags in each module. To disable access to a specific MGI tag within a module, uncheck the box beside the tag name and click the "Save" button. To enabled an MGI tag within a module, check the box beside the tag name and click the "Save" button or click the "Revert" button to return all settings to default. Additional settings for specific MGI functions such as database search result limits, date and time GMT offsets, and mail server settings may also be entered in the module preferences. If you change the module preferences, click the "Save" button to save the settings. Preference changes take effect immediately.


[System Requirements] [Installation] [Domain Configuration] [Server Admin] [Domain Admin] [Licensing]


[MGI Guides Main Menu] [Admin Guide Main Menu]