 |
Gateway
Customization Guide Netscape Directory Server |
| Previous |
Contents |
Index |
DocHome | Next |
The
dsgw.conf and
pb.conf files are installed during Netscape Directory Server
(Directory Server) installation. This appendix describes the
configuration parameters defined in these files. Associated directives
are described in Appendix B,
"Gateway
Directives."
Specifies the amount of time in seconds before a user's authentication expires in the gateway. When authenticating to the directory from the gateway, the gateway retains authentication credentials for the amount of time specified in this parameter. Once authentication credentials have expired, the gateway prompts the user to re-authenticate.
For information on authenticating to the Directory Server using the gateway, see the online documentation that is available through the gateway.
Specifies the host name and port number used to contact the Directory Server. This parameter also determines the search base used for searches performed from the gateway and whether the gateway uses SSL to communicate with the Directory Server.
ldap|ldaps. Use LDAP to have the gateway communicate the Directory Server without using SSL. Use LDAPS to have the gateway communicate with the Directory Server using SSL.
dirHost. Indicates the host name of the machine where the Directory Server is installed.
dirPort. Indicates the port number used by the Directory Server. Always specify a port number, even when using standard LDAP or LDAPS port numbers (389 and 636, respectively).
searchBase. Indicates the distinguished name (DN) representing the point in the directory from which all searches are performed. Normally, searchBase is set to the directory's suffix.
Substitute the following hexadecimal values for the equal sign, space, and comma in the search base:
Specifies the location of the file where the
bind DN and bind password are stored. This file should be stored
separately of the
.conf file for the gateway instance. The
binddnfile is used to authenticate to the server for
non-anonymous searching.
Used by the gateway to substitute ideographic
space for non-breaking space (nbsp) in Asian character sets.
Defines the default character set for communication with HTTP clients. The default is UTF-8 (Unicode), which supports all the characters in the Directory Server. UTF-8 is the preferred character set; however, many browsers don't support the UTF-8 charset or display it poorly.
Some users may require a different character set than the one specified in using this parameter. For these users, the charset parameter setting may be overridden by creating a <LANG>/dsgw/charset.conf file which contains the charset name. However, to receive the correct language, users will have to configure their browsers to send the appropriate accept-language headers.
For compatibility with HTTP clients that can't handle an HTTP response with a charset parameter in the content-type, comment out this parameter in the .conf file. This prevents the gateway from sending an explicit charset to gateway clients. When no charset parameter is defined, the gateway by default transmits ISO-8859-1 (Latin-1).
The charset parameter is ignored by current versions of Netscape Communicator and Internet Explorer, which request the UTF-8 charset by default. Forcing these clients to use a non-UTF-8 charset (such as Latin-1) requires the ignoreAcceptCharsetFrom parameter.
More information: ignoreAcceptCharsetFrom
Specifies the location of the configuration directory of the gateway. These include the object class templates, search configuration files, search result templates, and script files used to generate HTML forms dynamically for the user.
The configuration directory for the default
gateway (dsgw.conf)
is
../config. The configuration directory for Directory Express (pb.conf) is
../pbconfig.
Specifies the distinguished name of the Directory Manager. This is the DN used to bind to the Directory Server when users authenticate as the Directory Manager from the gateway. Use a DN other than the root DN for this purpose. It is intended that the DN specified here has read and write authority for the subtree that the gateway sees.
For information on authenticating as the
Directory Manager from the gateway, see the online documentation that
is available through the gateway.
Specifies the AIM® presence (online or offline) of a user by displaying or hiding the AIM icon in the Directory Server Gateway UI. If enable-aim-presence is set to true and if the user being displayed is logged into the AIM service, the AIM icon show ups in the UI when the full entry for a user is being displayed.
By default, the AIM icon won't show up for lists of users because it would have adverse affects on search performance. To see AIM presence for lists of users (or multiple search results), the following files will need to be modified:
The block of text that needs to be modified is shown below:
<SCRIPT
LANGUAGE="JavaScript">
<!-- Hide
from non-JavaScript-capable browsers
showAimIcon(
<!--
DS_ATTRIBUTE "attr=nsaimid" "options=quoted" -->
,
"" //<!--
DS_ATTRIBUTE "attr=nsaimstatustext" "options=quoted" -->
);
////
Uncomment the above DS_ATTRIBUTE directive and remove the ////
//// double
quotes to have aim presence in search results lists ////
The modified block of text is shown below (the
"" and
// removed from the sixth line):
<SCRIPT
LANGUAGE="JavaScript">
<!-- Hide
from non-JavaScript-capable browsers
showAimIcon(
<!--
DS_ATTRIBUTE "attr=nsaimid" "options=quoted" -->
,
<!--
DS_ATTRIBUTE "attr=nsaimstatustext" "options=quoted" -->
);
////
Uncomment the above DS_ATTRIBUTE directive and remove the ////
//// double
quotes to have aim presence in search results lists ////
Once this is done, listings of multiple users will show AIM presence
for each user.
Used by the gateway CGI scripts to specify
the URL to output for HTTP redirection. This needs to be specified as
"/clients/dsgw/<htmldir>" and should be the same as the
NameTrans set in the HTTP server, if any is being used.
Specifies the location of the HTML files for the gateway. These include the HTML files controlling the appearance of gateway forms.
The HTML directory for the default gateway (dsgw.conf)
is
../html. The HTML directory for Directory Express (pb.conf) is
../pbhtml.
Ignores request headers for the UTF-8
character set automatically sent by Netscape Communicator and
Internet Explorer browsers. Can be used together with the
charset parameter to transmit a charset other than Unicode to
all gateway clients.
Defines the location choices selectable from
the gateway when adding new entries. Each
location parameter represents a branch point in the directory
tree below which new entries can be added.
location handle "friendly_name""dn"
handle. An arbitrary string used by the location-suffix parameter to map a type of entry to the locations where the entry can be created. For more information, see location-suffix.
friendly_name. An arbitrary string that represents the location. This string should describe the location because the gateway displays this string to users to represent the location.
dn. The distinguished name (DN) representing this branch point in the directory. If this value is not terminated with a pound sign, the value specified on the include parameter is appended to this value to build the fully qualified distinguished name. If DN terminated with a pound sign (#), the value represented here is assumed to be a fully qualified distinguished name, and the pound sign is stripped from the distinguished name before the DN is used by the gateway.
For more information, see include.
The following example defines an entry creation location in a user directory. This location corresponds to the Marketing organizational unit, and the remainder of the distinguished name is built from the value set in the include parameter:
location marketing "Marketing Organization" "ou=Marketing"
A slightly different example defines the same location but specifies the fully qualified distinguished name:
location marketing "Marketing Organization" "ou=Marketing,o=example.com#"
For a more complete example of the
location parameter, see Mapping Locations and Entry Types.
Identifies the directory suffix used to create new entries in the directory.
This value is appended to the DN field of the
NLS
parameter when the gateway is used to create new entries in the
directory.
Defines the types of entries that can be
added to the directory using the gateway. newtype
also defines the locations in the directory where an entry type can be
added. For a user to create the entry, the corresponding location must
be defined using the
location parameter.
newtype template_name " friendly_name " rdnattr locations
template_name. The name of a display- template_name.html file that defines the object class listed. Template files are stored in the ../config directory. The gateway uses these files to define how various types of entries are displayed when entries are being created or viewed:
friendly_name. An arbitrary string that describes the entry. This string should be reasonably descriptive of the entry type because the gateway displays this string to users who are adding entries.
rdnattr. The attribute used to name entries of this type. For example, the default value for the rdnattr field for people entries is uid. This means that any people entries created using the gateway will have DNs of the following format:
The rdnattr field can be modified so that entries are named using a different attribute. For example, to change the rdnattr of the newtype orgPerson line from uid to cn, people entries created using the gateway will have cn-based DNs rather than the UID-based DNs (the default setting).
locations.
A space-separated list of the locations where this type of entry can be
added. The locations in this list must be identical to the
handle specified on the corresponding
location parameter.
The following example allows persons to be added to the Marketing subtree using the template for organizationalPerson:
For a more complete
example of the newtype parameter, see Mapping Locations and Entry
Types.
Identifies the libNLS data directory, which
should contain a directory named "locales," containing the
configuration files
LANG.ctx,
LANG.col, and
LANG.txt for each supported language (locale).
Specifies the attribute to be used as the leftmost RDN for the DNs of user entries (in order to enable the Org Chart application to search for entries).
The
orgchart-attrib-farleft-rdn attribute is the same as the one
included in the Org Chart's configuration file (serverRoot/clients/orgchart/config.txt),
and the attribute value (uid,
cn, and so on) must match the values specified in the
config.txt file.
Identifies the location of the certificate
database used by the gateway when using SSL to communicate with the
Directory Server. The certificate database contains the Certificate
Authority issuing the certificate for the Directory Server.
Maps specific object classes to internal
gateway templates. These templates define how a specific object class
such as a person, a group, or an organizational unit is displayed in
the gateway. The
templatename identified has a corresponding HTML template stored
in
clients/dsgw/config/.
Points to the Org Chart application, providing a link to the Org Chart application from the Directory Server Gateway UI pages. By default, the Directory Server installation program sets the base to use the Netscape Administration Server as the web server. You can change the host name and port number to be that of a dedicated web server. (See HTTP Server Configuration.)
In the absence of the url-orgchart-base configuration field, there will be no link to the Org Chart application in the Directory Server Gateway UI.
Note that the Org Chart application also has
a similar URL which points to the Directory Server Gateway (the
dsgw instance). You can change it to
..../lang?context=pb to have the Org Chart link to the Phonebook
or remove the
context=dsgw altogether and have it link to the default gateway
instance (default.conf,
which is the
dsgw instance).
Directory Server Gateway allows users to view
vCards for person and NT person directory entries. The vCard and LDAP
specifications define different labels to access information: vCards
use properties, and LDAP uses attributes. Therefore, there must be a
way to map the vCard property names to the LDAP attribute names so that
the Directory Server can locate the information for the vCard display.
The vcard-property parameter accomplishes mapping vCard property to
LDAP attribute.
vcard-property vcardprop syntax ldapattr [ ldapattr2 ...]
vcardprop. The name of a vCard property. vCard properties that are currently mapped to LDAP attributes are:
syntax. A string that describes the nature of the vCard information. The following syntaxes are supported:
ldapattr
[ldapattr2...]. The attribute(s) to be mapped to the vCard
property. This is useful when mapping a vCard property to a custom
attribute.