Netscape Directory Server Gateway Customization Guide:

Gateway Customization Guide
Netscape Directory Server

Contents

Preface
Prerequisite Reading
Conventions Used in This Book
Related Information
Chapter 1   Introduction
What is a Gateway?
Gateways Installed with Directory Server
Default Gateway
Directory Express
HTTP Server Requirements for Gateways
Directory Express and Default Gateway
Directory Express (pb.conf)
Default Gateway (dsgw.conf)
Support for Multiple Gateway Instances
Specifying Gateway Configuration to Gateway CGIs
GET Operations (GCONTEXT)
POST Operations (PCONTEXT)
URLs for Gateway Access
Anonymous and Non-Anonymous Searching
binddnfile
Compatibility with Previous Releases of Gateway
Automatic Updates to Directory Configuration
Chapter 2   Setting Up the Gateway
Gateway Installation Planning
Location of Gateway Files
Gateway Release 6.2
Gateway Release 4.x
Gateway Cloning
Securing Gateway Configuration and Settings
Protecting Bind DN and Password
Protecting Root Processes on UNIX Systems
Updating the Gateway with Changes to Directory Server Configuration
HTTP Server Recommendations for Directory Server Gateway
Running the Gateway in High-Usage Networks
HTTP Server Configuration
Name Translation Mapping
Gateway Root Suffix
Configuring the Gateway for Web Servers
Creating a New Gateway Instance
Gateway Cloning
Gateway .conf File Configuration
Changing the Default Port Setting
Setting Up a Directory Manager for the Gateway
Configuring the Directory Manager DN
Authenticating as Directory Manager
Setting up the Suffix for Adding Entries
Setting Up SSL Support
Configuring the Gateway to Use SSL
Setting vCard Properties
Configuring Gateway Clients
Language Support for HTTP Clients
Unicode and Latin-1 Character Sets
Displaying a Non-English Alphabet
Configuring Netscape 7.x for Preferred Language
Customizing Communicator's LDAP Settings
Chapter 3   File Controlling Gateway Functionality
Files Controlling Gateway Functionality
Gateway .conf Files
dsgw.conf
pb.conf
Gateway Search Configuration Files
Object Class Templates
Gateway Script Files
Gateway Search Result Templates
Banner Files
Chapter 4   Editing Entry Types
Entry Types (Object Classes)
Parameters Controlling Entry Types
template
location
newtype
Considerations for Adding New Entry Types
Mapping Locations and Entry Types
Mapping Entry Types to Locations
Setting Up Organizational Units
Configuring DN Formats for Entry Types
UID-Based DN
Modifying the Default DN Format
Object Class Attributes in Template Files
Default Gateway Object Classes
Templates and Directives
Entry-Related Directives
Adding Attributes to Object Classes
Deleting Attributes from Object Classes
Extending Object Classes
Adding a Template for a Child of a Parent Class
Creating a New Parent Object Class
Chapter 5   Search Attributes, Filters, and Results
Search Configuration Files
dsgwsearchprefs.conf
dsgwfilter.conf
Changing Search Scope
Modifying Search Attributes for Advanced Searches
Standard and Advanced Searches
Specifying Search Attributes for Person
Directory Express Search Support for User ID
Adding Search Support for Additional Attributes
Adding Search Support for a New Object
Extending Search Preferences
Creating a New Search Object
Modifying Default Search Filters
Search Filters for User Data Patterns
Specifying a Search Filter for a New Object
Customizing Search Result Templates
How the Gateway Displays Search Results
Search Result Tables
Modifying Search Result Templates
Adding Information to Search Results
Removing Information From Search Results
Chapter 6   Customizing Graphics and Color
Appearance of Gateway Forms
Banner Image
Updating the Banner Image (title.gif)
Changing Dimensions of Banner Image
Changing Filename of Banner Image
Button Images
Updating Button Images
Color Schemes
Files Controlling Colors on Gateway Forms
Changing Colors Using BODY Tag
Changing Colors Using Directives
Changing Table Colors
Specifying Color Names and Color Codes
Changing Color of Table Headings
Changing the Background Color of Table Rows
Appendix A   Parameters Defined in the .conf File
authlifetime
Format
Example
baseurl
Format
Example
binddnfile
Format
Example
changeHTML
Format
Example
charset
Format
Example
configdir
Format
Example
dirmgr
Format
Example
enable-aim-presence
Format
Example
gwnametrans
Format
Example
htmldir
Format
Example
ignoreAcceptCharsetFrom
Format
Example
include
Format
Example
location
Format
Example
location-suffix
Format
Example
newtype
Format
Example
NLS
Format
Example
orgchart-attrib-farleft-rdn
Format
Example
securitypath
Format
Example
template
Format
Example
url-orgchart-base
Format
Example
vcard-property
Format
Example
Appendix B   Gateway Directives
Introduction
Structure of an HTML Template
Structure of an HTML Template for Directory List
Context-Related Directives
GCONTEXT
Arguments
Example
PCONTEXT
Arguments
Example
Entry-Related Directives
DS_ENTRYBEGIN
Arguments
DS_ENTRYEND
Arguments
DS_ATTRIBUTE
Arguments
Examples
DS_OBJECTCLASS
Arguments
Example
DS_VIEW_SWITCHER
Arguments
Example
DS_SORTENTRIES
Arguments
Example
DS_SEARCHDESC
Arguments
DS_POSTEDVALUE
Arguments
Example
DS_EDITBUTTON
Arguments
Example
DS_DELETEBUTTON
Arguments
Example
DS_SAVEBUTTON
Arguments
Examples
DS_EDITASBUTTON
Arguments
Example
DS_NEWPASSWORD
Arguments
DS_CONFIRM_NEWPASSWORD
Arguments
DS_OLDPASSWORD
Arguments
DS_HELPBUTTON
Arguments
Example
DS_CLOSEBUTTON
Arguments
Example
DS_BEGIN_ENTRYFORM
Arguments
DS_END_ENTRYFORM
Arguments
DS_EMIT_BASE_HREF
Arguments
DS_DNEDITBUTTON
Arguments
DS_BEGIN_DNSEARCHFORM
Arguments
DS_ATTRVAL_SET
Arguments
Example
IF/ ELSE/ ELIF/ ENDIF
Arguments for IF and ELIF
Arguments for ELSE and ENDIF
Examples
Miscellaneous Directives
BODY
Arguments
Examples
COLORS
Arguments
Example
TITLE
Arguments
Example
ENDHTML
Arguments
HELPBUTTON
Arguments
Example
INCLUDE
Arguments
Example
INCLUDECONFIG
Arguments
Example
DS_LAST_OP_INFO
Arguments
Example
DS_LOCATIONPOPUP
Arguments
Example
DS_GATEWAY_VERSION
Arguments
Example
IF/ ELSE/ ELIF/ ENDIF
Appendix C   CGI Usage
auth
lang
search
csearch
unauth
dnedit
edit
doauth
domodify
newentry
dosearch
Index

Last Updated October 31, 2003