Contents


Preface

Audience
Typographic Conventions
Related Information

Chapter 1 Introduction

What is a Gateway?

Gateways Installed with Directory Server 4.0

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

Release 4.0
Release 3.x

Gateway Localization

Gateway Locales
Character Sets

Non-Anonymous Searching

binddnfile

Compatibility with Existing Gateways
Automatic Updates to Directory Configuration

Chapter 2 Setting Up the Gateway

Gateway Installation Planning

Location of Gateway Files

Gateway Release 4.0
Gateway Release 3.x

Securing 4.0 Gateway Configuration and Settings

Protecting Bind DN and Password
Protecting Root Processes on UNIX Systems

Migrating 3.x Default Gateways to Release 4.0

Location of migrated dsgw.conf file
Running the Gateway Migration Script

Updating the Gateway with Changes to Directory Server Configuration
HTTP Server Recommendations for Directory Server Gateway Release 4.0

Running the Gateway in High-Usage Networks

HTTP Server Configuration

Name Translation Mapping
Gateway Root Suffix
Configuring the Gateway for Enterprise or FastTrack Servers

Add an Additional Document Directory (4.0 Gateways)
Add an Additional Document Directory (3.x Gateways)
Add an Additional CGI Directory (for 4.0 Gateways)
Add an Additional CGI Directory (for 3.x Gateways)
Change Permissions of Cookie Directory (UNIX only)

Creating a New Gateway Instance (4.0 only)

Gateway Cloning

Gateway .conf File Configuration

Changing the Default Port Setting
Setting Up the Directory Manager

Configuring the Directory Manager DN

Setting up the Suffix for Adding Entries
Setting Up SSL Support

Configuring the Gateway to Use SSL

Setting Up Localization
Setting vCard Properties

Configuring Gateway Clients

Language Support for HTTP Clients

Unicode and Latin-1 Character Sets

Displaying a Non-English Alphabet
Configuring Communicator 4.x for Preferred Language
Configuring Navigator 3.01 for Preferred Language
Customizing Communicator's LDAP Settings

Chapter 3 Gateway Localization

Unicode and iPlanet Support for UTF-8
How the Gateway Selects a Character Set

How the Gateway Selects from Multiple Requested Characters Sets
HTTP Clients that Request UTF-8
HTTP Clients that Do Not Request UTF-8

Special Characters

Non-Breaking Space
Query Strings

Gateway Locales

Support for Multiple Locales

Setting Up Locales for Translation

dsgw-l10n.conf

Chapter 4 File Controlling Gateway Functionality

Files Controlling Gateway Functionality
Gateway .conf Files

dsgw.conf
pb.conf

Gateway Search Configuration Files

dsgwsearchprefs.conf
dsgwfilter.conf

Object Class Templates
Gateway Script Files
Gateway Search Result Templates
Banner Files

Chapter 5 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 6 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 7 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 .conf Parameters

authlifetime

Format
Example

baseurl

Format
Example

binddnfile

Format
Example

changeHTML

Format
Example

charset

Format
Example

configdir

Format
Example

dirmgr

Format
Example

gwnametrans

Format
Example

htmldir

Format
Example

ignoreAccetpCharsetFrom

Format
Example

include

Format
Example

location

Format
Example

location-suffix

Format
Example

newtype

Format
Example

NLS

Format
Example

securitypath

Format
Example

template

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
PCONTEXT

Entry-related Directives

DS_ENTRYBEGIN
DS_ENTRYEND
DS_ATTRIBUTE
DS_OBJECTCLASS
DS_VIEW_SWITCHER
DS_SORTENTRIES
DS_SEARCHDESC
DS_POSTEDVALUE
DS_EDITBUTTON
DS_DELETEBUTTON
DS_SAVEBUTTON
DS_EDITASBUTTON
DS_NEWPASSWORD
DS_CONFIRM_NEWPASSWORD
DS_OLDPASSWORD
DS_HELPBUTTON
DS_CLOSEBUTTON
DS_END_ENTRYFORM
DS_EMIT_BASE_HREF
DS_DNEDITBUTTON
DS_BEGIN_DNSEARCHFORM
DS_ATTRVAL_SET
IF/ ELSE/ ELIF/ ENDIF

Miscellaneous Directives

BODY
COLORS
TITLE
ENDHTML
HELPBUTTON
INCLUDE
INCLUDECONFIG
DS_LAST_OP_INFO
DS_LOCATIONPOPUP
DS_GATEWAY_VERSION
IF/ ELSE/ ELIF/ ENDIF

Appendix C CGI Usage

auth
lang
search
csearch
unauth
dnedit
edit

doauth
domodify

newentry
dosearch