From 3185e51c232bdf1ce5a4bc5fbc88f5f969fc3eed Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Mon, 08 Sep 2014 09:12:30 +0000
Subject: [PATCH] CR-4463 Fix for OPENDJ-1436: Admin guide should have links to the reference guide
---
opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-upgrade.xml | 14
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-monitoring.xml | 23
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-privileges-acis.xml | 24 +
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-backup-restore.xml | 26 +
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-schema.xml | 175 +++++++--
opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-gui.xml | 30 +
opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-uninstall.xml | 18
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-pwd-policy.xml | 87 +++-
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-resource-limits.xml | 149 +++++--
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-tuning.xml | 138 +++++--
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-admin-tools.xml | 44 +
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-rest-operations.xml | 17
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-ldap-operations.xml | 78 +++
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-import-export.xml | 74 +++
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-indexing.xml | 46 +
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-connection-handlers.xml | 35 +
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-server-process.xml | 42 +
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-account-lockout.xml | 16
opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-cli.xml | 28 +
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-replication.xml | 22
20 files changed, 829 insertions(+), 257 deletions(-)
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-account-lockout.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-account-lockout.xml
index 2c24a98..73c156b 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-account-lockout.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-account-lockout.xml
@@ -53,8 +53,20 @@
number of times on each replica before being locked out on all replicas.</para>
</note>
- <para>This chapter shows you how to set up account lockout policies,
- and how to intervene manually to lock and unlock accounts.</para>
+ <para>
+ This chapter shows you how to set up account lockout policies by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dsconfig-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dsconfig</command></link> command,
+ and how to intervene manually to lock and unlock accounts by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#manage-account-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>manage-account</command></link> command.
+ </para>
<section xml:id="configure-account-lockout">
<title>Configuring Account Lockout</title>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-admin-tools.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-admin-tools.xml
index 6af46be..88a5208 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-admin-tools.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-admin-tools.xml
@@ -24,11 +24,11 @@
!
-->
<chapter xml:id='chap-admin-tools'
- xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'
- xmlns:xinclude='http://www.w3.org/2001/XInclude'>
+ xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
+ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+ xsi:schemaLocation='http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'>
<title>Administration Interfaces & Tools</title>
<para>OpenDJ server software installs with a cross-platform, Java Swing-based
@@ -57,7 +57,15 @@
administration server port, making a secure LDAPS connection.</para>
<itemizedlist>
- <para>Start OpenDJ Control Panel.</para>
+ <para>
+ Start OpenDJ Control Panel by running the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#control-panel-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>control-panel</command></link> command.
+ </para>
+
<listitem>
<para>(Linux, Solaris) Run <command>/path/to/opendj/bin/control-panel</command>.</para>
</listitem>
@@ -203,12 +211,24 @@
</tgroup>
</table>
- <para>The <command>setup</command>, <command>upgrade</command>, and
- <command>uninstall</command> tools are located in the parent directory of the
- other tools, as these tools are not used for everyday administration.
- For example, if the path to most tools is
- <filename>/path/to/opendj/bin</filename> you can find these tools in
- <filename>/path/to/opendj</filename>.</para>
+ <para>
+ You find the installation and upgrade tools,
+ <command>setup</command>,
+ <command>upgrade</command>,
+ and <command>uninstall</command>,
+ in the parent directory of the other tools,
+ as these tools are not used for everyday administration.
+ For example, if the path to most tools is
+ <filename>/path/to/opendj/bin</filename>
+ you can find these tools in
+ <filename>/path/to/opendj</filename>.
+ For instructions on how to use the installation and upgrade tools, see the
+ <link
+ xlink:show="new"
+ xlink:href="install-guide#install-guide"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><citetitle>Installation Guide</citetitle></link>.
+ </para>
<para>All OpenDJ command-line tools take the <option>--help</option> option.</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-backup-restore.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-backup-restore.xml
index 6484a72..898d57a 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-backup-restore.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-backup-restore.xml
@@ -81,9 +81,16 @@
<literal>backend-backup</literal> privilege, and also setting a start time
for the task by using the <option>--start</option> option.</para>
- <para>To perform offline backup when OpenDJ is stopped, you run the
- <command>backup</command> command without connecting to the server,
- authenticating, or requesting a backup task.</para>
+ <para>
+ To perform offline backup when OpenDJ is stopped,
+ you run the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#backup-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>backup</command></link> command
+ without connecting to the server, authenticating, or requesting a backup task.
+ </para>
<step>
<para>Use one of the following alternatives.</para>
@@ -233,9 +240,16 @@
the <literal>backend-restore</literal> privilege, and also setting a start
time for the task by using the <option>--start</option> option.</para>
- <para>To restore data when OpenDJ is stopped, you run the
- <command>restore</command> command without connecting to the server,
- authenticating, or requesting a restore task.</para>
+ <para>
+ To restore data when OpenDJ is stopped, you run the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#restore-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>restore</command></link> command
+ without connecting to the server, authenticating, or requesting a restore task.
+ </para>
+
<step>
<para>Use one of the following alternatives.</para>
<stepalternatives>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-connection-handlers.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-connection-handlers.xml
index 5d23023..f3f36f0 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-connection-handlers.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-connection-handlers.xml
@@ -31,10 +31,17 @@
xmlns:xlink='http://www.w3.org/1999/xlink'>
<title>Configuring Connection Handlers</title>
<indexterm><primary>Ports</primary><secondary>Configuring</secondary></indexterm>
- <para>This chapter shows you how to configure OpenDJ directory server to
- listen for directory client requests, using connection handlers. You can view
- information about connection handlers in the OpenDJ Control Panel, and update
- the configuration using the <command>dsconfig</command> command.</para>
+ <para>
+ This chapter shows you how to configure OpenDJ directory server
+ to listen for directory client requests, using connection handlers.
+ You can view information about connection handlers in the OpenDJ Control Panel,
+ and update the configuration using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dsconfig-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dsconfig</command></link> command.
+ </para>
<section xml:id="configure-ldap-port">
<title>LDAP Client Access</title>
@@ -965,7 +972,10 @@
<para>Consider the following global configuration settings.</para>
<varlistentry>
- <term><literal>bind-with-dn-requires-password</literal></term>
+ <term><link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#bind-with-dn-requires-password"
+ ><literal>bind-with-dn-requires-password</literal></link></term>
<listitem>
<para>Whether the directory server should reject any simple bind request
that contains a DN but no password. Default: <literal>true</literal></para>
@@ -985,7 +995,10 @@
</varlistentry>
<varlistentry>
- <term><literal>max-allowed-client-connections</literal></term>
+ <term><link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#max-allowed-client-connections"
+ ><literal>max-allowed-client-connections</literal></link></term>
<listitem>
<para>Restricts the number of concurrent client connections to the
directory server. Default: 0, meaning no limit is set</para>
@@ -1005,7 +1018,10 @@
</varlistentry>
<varlistentry>
- <term><literal>reject-unauthenticated-requests</literal></term>
+ <term><link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#reject-unauthenticated-requests"
+ ><literal>reject-unauthenticated-requests</literal></link></term>
<listitem>
<para>Rejects any request (other than bind or StartTLS requests) received
from a client that has not yet been authenticated, whose last
@@ -1027,7 +1043,10 @@
</varlistentry>
<varlistentry>
- <term><literal>return-bind-error-messages</literal></term>
+ <term><link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#return-bind-error-messages"
+ ><literal>return-bind-error-messages</literal></link></term>
<listitem>
<para>Does not restrict access, but by default prevents OpenDJ directory
server from returning extra information about why a bind failed, as that
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-import-export.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-import-export.xml
index f500d8b..1a7cb37 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-import-export.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-import-export.xml
@@ -59,9 +59,17 @@
<section xml:id="generating-ldif">
<title>Generating Test Data</title>
- <para>When you install OpenDJ, you have the option of importing sample
- data generated during the installation. This procedure demonstrates how to
- generate LDIF using the <command>make-ldif</command> command.</para>
+ <para>
+ When you install OpenDJ,
+ you have the option of importing sample data
+ that is generated during the installation.
+ This procedure demonstrates how to generate LDIF by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#make-ldif-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>make-ldif</command></link> command.
+ </para>
<procedure xml:id="generate-ldif">
<title>To Generate Test LDIF Data</title>
@@ -129,11 +137,22 @@
<section xml:id="importing-exporting-ldif">
<title>Importing & Exporting Data</title>
- <para>You can use the OpenDJ Control Panel to import data (Directory
- Data > Import LDIF...) and to export data (Directory Data > Export
- LDIF...). The following procedures demonstrate how to use the
- <command>import-ldif</command> and <command>export-ldif</command>
- commands.</para>
+ <para>
+ You can use OpenDJ Control Panel
+ to import data (Directory Data > Import LDIF)
+ and to export data (Directory Data > Export LDIF).
+ The following procedures demonstrate how to use the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#import-ldif-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>import-ldif</command></link> and
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#export-ldif-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>export-ldif</command></link> commands.
+ </para>
<procedure xml:id="import-ldif">
<title>To Import LDIF Data</title>
@@ -244,9 +263,25 @@
<primary>LDIF</primary>
<secondary>Tools</secondary>
</indexterm>
-
- <para>This section demonstrates the <command>ldifsearch</command>,
- <command>ldifmodify</command>, and <command>ldif-diff</command> tools.</para>
+
+ <para>
+ This section demonstrates the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#ldifsearch-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>ldifsearch</command></link>,
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#ldifmodify-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>ldifmodify</command></link> and
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#ldif-diff-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>ldif-diff</command></link> commands.
+ </para>
<section xml:id="ldifsearch-example">
<title>Searching in LDIF With <command>ldifsearch</command></title>
@@ -342,7 +377,12 @@
</para>
<para>
- You can create new backends using the <command>dsconfig</command> command.
+ You can create new backends using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dsconfig-create-backend"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dsconfig create-backend</command></link> command.
The following example creates a local backend named <literal>testData</literal>.
</para>
@@ -474,8 +514,14 @@
<secondary>Deleting</secondary>
</indexterm>
- <para>You delete a database backend by using the <command>dsconfig
- delete-backend</command> command.</para>
+ <para>
+ You delete a database backend by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dsconfig-delete-backend"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dsconfig delete-backend</command></link> command.
+ </para>
<para>When you delete a database backend by using the <command>dsconfig
delete-backend</command> command, OpenDJ does not actually remove the
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-indexing.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-indexing.xml
index de4f148..0d24a23 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-indexing.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-indexing.xml
@@ -385,12 +385,23 @@
<secondary>Configuring</secondary>
</indexterm>
- <para>You modify index configurations using the <command>dsconfig</command>
- command. The configuration changes then take effect after you rebuild the
- index according to the new configuration, using the
- <command>rebuild-index</command>. The <command>dsconfig
- --help-database</command> command lists subcommands for creating, reading,
- updating, and deleting index configuration.</para>
+ <para>
+ You modify index configurations by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dsconfig-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dsconfig</command></link> command.
+ The configuration changes then take effect
+ after you rebuild the index according to the new configuration, using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#rebuild-index-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>rebuild-index</command></link> command.
+ The <command>dsconfig --help-database</command> command lists subcommands
+ for creating, reading, updating, and deleting index configuration.
+ </para>
<tip>
<para>Indexes are per directory backend rather than per suffix. To maintain
@@ -625,6 +636,17 @@
is shown in the following example, where an index has just been created
for <literal>newUnusedAttribute</literal>.</para>
+ <para>
+ Start by testing the index status by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dbtest-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dbtest</command></link> command.
+ The final column show in the output is the Index Valid column,
+ <literal>false</literal> before the rebuild, <literal>true</literal> after.
+ </para>
+
<screen>
$ <userinput>dbtest \
list-index-status \
@@ -810,9 +832,15 @@
<secondary>Verifying</secondary>
</indexterm>
- <para>You can verify that indexes correspond to current directory data,
- and that indexes do not contain errors using the
- <command>verify-index</command> command.</para>
+ <para>
+ You can verify that indexes correspond to current directory data,
+ and that indexes do not contain errors by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#verify-index-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>verify-index</command></link> command.
+ </para>
<example xml:id="verify-index-example">
<title>Verify Index</title>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-ldap-operations.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-ldap-operations.xml
index 673e71f..ae745f9 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-ldap-operations.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-ldap-operations.xml
@@ -59,13 +59,22 @@
example, but potentially in other ways. When searching you therefore also
specify where in the directory to search.</para>
- <para>The <command>ldapsearch</command> command thus takes at minimum a
- search base DN option and an LDAP filter. The search base DN identifies
- where in the directory to search for entries that match the filter.
- For example, if you are looking for printers, you might specify the base
- DN as <literal>ou=Printers,dc=example,dc=com</literal>. Perhaps you are
- visiting the <literal>GNB00</literal> office and are looking for a
- printer.</para>
+ <para>
+ The
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#ldapsearch-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>ldapsearch</command></link> command
+ thus takes at minimum a search base DN option and an LDAP filter.
+ The search base DN identifies where in the directory
+ to search for entries that match the filter.
+ For example, if you are looking for printers,
+ you might specify the base DN as
+ <literal>ou=Printers,dc=example,dc=com</literal>.
+ Perhaps you are visiting the <literal>GNB00</literal> office
+ and are looking for a printer.
+ </para>
<screen>
$ <userinput>ldapsearch --baseDN ou=Printers,dc=example,dc=com "(printerLocation=GNB00)"</userinput>
@@ -424,8 +433,16 @@
<example xml:id="compare-example">
<title>Compare: Checking <literal>authPassword</literal></title>
- <para>In this example, Kirsten Vaughan checks whether the hashed password
- value matches the stored value on <literal>authPassword</literal>.</para>
+ <para>
+ In this example, Kirsten Vaughan uses the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#ldapcompare-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>ldapcompare</command></link> command
+ to check whether the hashed password value matches the stored value
+ on <literal>authPassword</literal>.
+ </para>
<screen>
$ <userinput>ldapcompare \
@@ -447,8 +464,17 @@
<title>Updating the Directory</title>
<indexterm><primary>Updating data</primary></indexterm>
<indexterm><primary>LDIF</primary><secondary>Examples</secondary></indexterm>
- <para>Authorized users can change directory data using the LDAP add, modify,
- modify DN, and delete operations.</para>
+
+ <para>
+ Authorized users can change directory data using
+ the LDAP add, modify, modify DN, and delete operations.
+ You can use the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#ldapmodify-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>ldapmodify</command></link> command to make changes.
+ </para>
<section xml:id="add-ldap">
<title>Adding Entries</title>
@@ -990,8 +1016,15 @@
<title>Changing Passwords</title>
<indexterm><primary>Passwords</primary><secondary>Changing</secondary></indexterm>
- <para>With the <command>ldappasswordmodify</command> command, authorized
- users can change and reset user passwords.</para>
+ <para>
+ With the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#ldappasswordmodify-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>ldappasswordmodify</command></link> command,
+ authorized users can change and reset user passwords.
+ </para>
<example xml:id="password-reset">
<title>Password Reset</title>
@@ -1045,7 +1078,11 @@
<para>
To change the password as the user, you can
bind as the user whose password should be changed,
- use the LDAP Password Modify extended operation
+ use the
+ <link
+ xlink:show="new"
+ xlink:href="http://tools.ietf.org/html/rfc3062"
+ >LDAP Password Modify extended operation</link>
with an authorization ID but without performing a bind,
or use proxied authorization.
For instructions on using proxied authorization, see the section on
@@ -1057,9 +1094,16 @@
</para>
</tip>
- <para>You could also accomplish password reset with the following command,
- but <command>set-password-is-reset</command> is a hidden option, supported
- only for testing.</para>
+ <para>
+ You could also accomplish password reset with the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#manage-account-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>manage-account</command></link> command,
+ although <command>set-password-is-reset</command> is a hidden option,
+ supported only for testing.
+ </para>
<screen>
$ <userinput>manage-account \
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-monitoring.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-monitoring.xml
index 2091319..693195e 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-monitoring.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-monitoring.xml
@@ -252,11 +252,24 @@
<section xml:id="monitoring-status-and-tasks">
<title>Server Operation & Tasks</title>
- <para>OpenDJ comes with two commands for monitoring server processes and
- tasks. The <command>status</command> command displays basic information
- about the local server, similar to what is seen in the default window of the
- Control Panel. The <command>manage-tasks</command> command lets you manage
- tasks scheduled on a server, such as nightly backup.</para>
+ <para>
+ OpenDJ comes with two commands for monitoring server processes and tasks.
+ The
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#status-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>status</command></link> command
+ displays basic information about the local server,
+ similar to what is seen in the default window of the Control Panel.
+ The
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#manage-tasks-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>manage-tasks</command></link> command
+ lets you manage tasks scheduled on a server, such as nightly backup.
+ </para>
<para>The <command>status</command> command takes administrative credentials
to read the configuration, as does the Control Panel.</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-privileges-acis.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-privileges-acis.xml
index c4ab259..cb4ad18 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-privileges-acis.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-privileges-acis.xml
@@ -908,12 +908,26 @@
<section xml:id="configure-privileges">
<title>Configuring Privileges</title>
- <para>For root directory administrators, by default <literal>cn=Directory
- Manager</literal>, you configure privileges using the
- <command>dsconfig</command> command.</para>
+ <para>
+ For root directory administrators,
+ by default <literal>cn=Directory Manager</literal>,
+ you configure privileges using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dsconfig-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dsconfig</command></link> command.
+ </para>
- <para>For non-root directory administrators, you add privileges with
- the <command>ldapmodify</command> command.</para>
+ <para>
+ For non-root directory administrators,
+ you add privileges with the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#ldapmodify-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>ldapmodify</command></link> command.
+ </para>
<procedure xml:id="change-root-dn-privileges">
<title>To Change Root DN Privileges</title>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-pwd-policy.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-pwd-policy.xml
index 5e28dc8..48d668b 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-pwd-policy.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-pwd-policy.xml
@@ -340,13 +340,21 @@
<section xml:id="configure-pwp">
<title>Configuring Password Policies</title>
- <para>You configure server based password policies using the
- <command>dsconfig</command> command. Notice that server based password
- policies are part of the server configuration, and therefore not replicated.
- Alternatively, you can configure a subset of password policy features using
- subentry based password policies that are stored with the replicated
- server data. This section covers both server based and subentry based
- password policies.</para>
+ <para>
+ You configure server based password policies by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dsconfig-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dsconfig</command></link> command.
+ Notice that server based password policies are
+ part of the server configuration,
+ and therefore not replicated.
+ Alternatively, you can configure a subset of password policy features
+ by using subentry based password policies
+ that are stored with the replicated server data.
+ This section covers both server based and subentry based password policies.
+ </para>
<procedure xml:id="default-pwp">
<title>To Adjust the Default Password Policy</title>
@@ -819,10 +827,22 @@
<secondary>Generating</secondary>
</indexterm>
- <para>Password generators are used by OpenDJ during the LDAP password modify
- extended operation to construct a new password for the user. In other words,
- a directory administrator resetting a user's password can have OpenDJ
- directory server generate the new password.</para>
+ <para>
+ Password generators are used by OpenDJ during the
+ <link
+ xlink:show="new"
+ xlink:href="http://tools.ietf.org/html/rfc3062"
+ >LDAP Password Modify extended operation</link>
+ to construct a new password for the user.
+ In other words, a directory administrator resetting a user's password
+ can have OpenDJ directory server generate the new password
+ by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#ldappasswordmodify-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>ldappasswordmodify</command></link> command.
+ </para>
<screen>
$ <userinput>ldappasswordmodify \
@@ -834,8 +854,13 @@
Generated Password: eak77qdi</computeroutput>
</screen>
- <para>The default password policy shown in <xref linkend="default-pwp" /> uses
- the Random Password Generator.</para>
+ <para>
+ The default password policy shown in <xref linkend="default-pwp" /> uses the
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}random-password-generator.html"
+ >Random Password Generator</link>.
+ </para>
<screen>
$ <userinput>dsconfig \
@@ -919,11 +944,19 @@
<secondary>Storage schemes</secondary>
</indexterm>
- <para>Password storage schemes encode new passwords provided by users so that
- they are stored in an encoded manner. This makes it difficult or impossible
- for someone to determine the clear-text passwords from the encoded
- values. Password storage schemes also determine whether a clear-text password
- provided by a client matches the encoded value stored in the server.</para>
+ <para>
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}password-storage-scheme.html"
+ >Password storage schemes</link>
+ encode new passwords provided by users
+ so that they are stored in an encoded manner.
+ This makes it difficult or impossible
+ to determine the clear-text passwords from the encoded values.
+ Password storage schemes also determine whether
+ a clear-text password provided by a client
+ matches the encoded value stored by the server.
+ </para>
<para>OpenDJ offers a variety of both reversible and one-way password storage
schemes. Some schemes make it easy to recover the clear-text password,
@@ -1078,11 +1111,19 @@
<secondary>Validating</secondary>
</indexterm>
- <para>Password validators are responsible for determining whether a proposed
- password is acceptable for use and can run checks like ensuring the password
- meets minimum length requirements, that it has an appropriate range of
- characters, or that it is not in the history. OpenDJ directory server
- provides a variety of password validators.</para>
+ <para>
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}password-validator.html"
+ >Password validators</link>
+ are responsible for determining whether a proposed password is
+ acceptable for use.
+ Validators can run checks like ensuring
+ that the password meets minimum length requirements,
+ that it has an appropriate range of characters,
+ or that it is not in the history of recently used passwords.
+ OpenDJ directory server provides a variety of password validators.
+ </para>
<screen>
$ <userinput>dsconfig \
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-replication.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-replication.xml
index 314e6c0..1829088 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-replication.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-replication.xml
@@ -333,8 +333,15 @@
<secondary>Configuring</secondary>
</indexterm>
- <para>This section shows how to configure replication with command-line
- tools.</para>
+ <para>
+ This section shows how to configure replication with command-line tools,
+ such as the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dsreplication-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dsreplication</command></link> command.
+ </para>
<section xml:id="enable-repl">
<title>Enabling Replication</title>
@@ -613,8 +620,15 @@
<procedure xml:id="stop-repl-tmp">
<title>To Stop Replication Temporarily For a Replica</title>
- <para>If you need to stop a server from replicating temporarily, you can
- do so using <command>dsconfig</command> command.</para>
+ <para>
+ If you must stop a server from replicating temporarily,
+ you can do so by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dsconfig-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dsconfig</command></link> command.
+ </para>
<warning>
<para>Do not allow modifications on the replica for which replication is
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-resource-limits.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-resource-limits.xml
index 9dc6dc4..e5f1b7d 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-resource-limits.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-resource-limits.xml
@@ -23,10 +23,11 @@
!
-->
<chapter xml:id='chap-resource-limits'
- xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:schemaLocation='http://docbook.org/ns/docbook
- http://docbook.org/xml/5.0/xsd/docbook.xsd'>
+ xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
+ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+ xsi:schemaLocation='http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'>
<title>Setting Resource Limits</title>
<indexterm><primary>Resource limits</primary></indexterm>
@@ -41,52 +42,116 @@
OpenDJ also only allows users with appropriate privileges to perform
unindexed searches.</para>
- <para>You can further adjust additional limits on search operations, such
- as the following.</para>
<itemizedlist>
+ <para>
+ You can further adjust additional limits on search operations,
+ such as the following.
+ </para>
+
<listitem>
- <para>The <firstterm>lookthrough limit</firstterm> defines the maximum
- number of candidate entries OpenDJ considers when processing a
- search.</para>
- <para>The default lookthrough limit, set by using the global server
- property <literal>lookthrough-limit</literal>, is 5000.</para>
- <para>You can override the limit for a particular user by changing the
- operational attribute, <literal>ds-rlim-lookthrough-limit</literal>, on
- the user's entry.</para>
+ <para>
+ The <firstterm>lookthrough limit</firstterm> defines
+ the maximum number of candidate entries OpenDJ considers
+ when processing a search.
+ </para>
+
+ <para>
+ The default lookthrough limit,
+ set by using the global server property,
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#lookthrough-limit"
+ ><literal>lookthrough-limit</literal></link>,
+ is 5000.
+ </para>
+
+ <para>
+ You can override the limit for a particular user
+ by changing the operational attribute,
+ <literal>ds-rlim-lookthrough-limit</literal>,
+ on the user's entry.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <firstterm>size limit</firstterm> sets
+ the maximum number of entries returned for a search.
+ </para>
+
+ <para>
+ The default size limit, set by using the global server property,
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#size-limit"
+ ><literal>size-limit</literal></link>,
+ is 1000.
+ </para>
+
+ <para>
+ You can override the limit for a particular user
+ by changing the operational attribute,
+ <literal>ds-rlim-size-limit</literal>,
+ on the user's entry.
+ </para>
</listitem>
<listitem>
- <para>The <firstterm>size limit</firstterm> sets the maximum number of
- entries returned for a search.</para>
- <para>The default size limit, set by using the global server property
- <literal>size-limit</literal>, is 1000.</para>
- <para>You can override the limit for a particular user by changing the
- operational attribute, <literal>ds-rlim-size-limit</literal>, on
- the user's entry.</para>
+ <para>
+ The <firstterm>time limit</firstterm> defines
+ the maximum processing time OpenDJ devotes to a search operation.
+ </para>
+
+ <para>
+ The default time limit, set by using the global server property,
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#time-limit"
+ ><literal>time-limit</literal></link>,
+ is 1 minute.
+ </para>
+
+ <para>
+ You can override the limit for a particular user
+ by changing the operational attribute,
+ <literal>ds-rlim-time-limit</literal>,
+ on the user's entry.
+ Times for <literal>ds-rlim-time-limit</literal> are expressed in seconds.
+ </para>
</listitem>
+
<listitem>
- <para>The <firstterm>time limit</firstterm> defines the maximum processing
- time OpenDJ devotes to a search operation.</para>
- <para>The default time limit, set by using the global server property
- <literal>time-limit</literal>, is 1 minute.</para>
- <para>You can override the limit for a particular user by changing the
- operational attribute, <literal>ds-rlim-time-limit</literal>, on
- the user's entry. Times for <literal>ds-rlim-time-limit</literal> are
- expressed in seconds.</para>
+ <para>
+ The <firstterm>idle time limit</firstterm> defines
+ how long OpenDJ allows idle connections to remain open.
+ </para>
+
+ <para>
+ No default idle time limit is set.
+ You can set an idle time limit by using the global server property,
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#idle-time-limit"
+ ><literal>idle-time-limit</literal></link>.
+ </para>
+
+ <para>
+ You can override the limit for a particular user
+ by changing the operational attribute,
+ <literal>ds-rlim-idle-time-limit</literal>,
+ on the user's entry.
+ Times for <literal>ds-rlim-idle-time-limit</literal> are expressed in seconds.
+ </para>
</listitem>
+
<listitem>
- <para>The <firstterm>idle time limit</firstterm> defines how long OpenDJ
- allows idle connections to remain open.</para>
- <para>No default idle time limit is set. You can set an idle time limit
- by using the global server property
- <literal>idle-time-limit</literal>.</para>
- <para>You can override the limit for a particular user by changing the
- operational attribute, <literal>ds-rlim-idle-time-limit</literal>, on
- the user's entry. Times for <literal>ds-rlim-idle-time-limit</literal>
- are expressed in seconds.</para>
- </listitem>
- <listitem>
- <para>The maximum number of persistent searches can be set using the
- global server property <literal>max-psearches</literal>.</para>
+ <para>
+ The maximum number of persistent searches can be set
+ by using the global server property,
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#max-psearches"
+ ><literal>max-psearches</literal></link>.
+ </para>
</listitem>
</itemizedlist>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-rest-operations.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-rest-operations.xml
index 19bf045..98db011 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-rest-operations.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-rest-operations.xml
@@ -34,11 +34,18 @@
<indexterm><primary>JSON</primary></indexterm>
<indexterm><primary>REST</primary></indexterm>
- <para>OpenDJ lets you access directory data as JSON resources over HTTP.
- This chapter demonstrates basic RESTful client operations using the
- default configuration and sample directory data imported into OpenDJ from
- <link xlink:show="new" xlink:href="http://opendj.forgerock.org/Example.ldif"
- >Example.ldif</link>.</para>
+ <para>
+ OpenDJ lets you access directory data as
+ <link xlink:show="new" xlink:href="http://json.org">JSON</link>
+ resources over HTTP.
+ This chapter demonstrates basic RESTful client operations
+ by using the default configuration
+ and sample directory data imported into OpenDJ from
+ <link
+ xlink:show="new"
+ xlink:href="http://opendj.forgerock.org/Example.ldif"
+ >Example.ldif</link>.
+ </para>
<para>
Before trying the examples, enable HTTP access to
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-schema.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-schema.xml
index ef9d371..1acf45b 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-schema.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-schema.xml
@@ -497,25 +497,55 @@
<filename>00-core.ldif</filename>
</term>
<listitem>
- <para>This file contains a core set of attribute type and objectlass
- definitions from several standard LDAP documents, including
- draft-ietf-boreham-numsubordinates, draft-findlay-ldap-groupofentries,
- draft-furuseth-ldap-untypedobject, draft-good-ldap-changelog,
- draft-ietf-ldup-subentry, draft-wahl-ldap-adminaddr, RFC 1274, RFC 2079,
- RFC 2256, RFC 2798, RFC 3045, RFC 3296, RFC 3671, RFC 3672, RFC 4512,
- RFC 4519, RFC 4523, RFC 4524, RFC 4530, RFC 5020, and X.501.</para>
+ <para>
+ This file contains a core set of
+ attribute type and object class definitions
+ from the following Internet-Drafts, RFCs, and standards:
+ </para>
+
+ <simplelist columns="1">
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/draft-ietf-boreham-numsubordinates">draft-ietf-boreham-numsubordinates</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/draft-findlay-ldap-groupofentries">draft-findlay-ldap-groupofentries</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/draft-furuseth-ldap-untypedobject">draft-furuseth-ldap-untypedobject</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/draft-good-ldap-changelog">draft-good-ldap-changelog</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/draft-ietf-ldup-subentry">draft-ietf-ldup-subentry</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/draft-wahl-ldap-adminaddr">draft-wahl-ldap-adminaddr</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc1274">RFC 1274</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc2079">RFC 2079</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc2256">RFC 2256</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc2798">RFC 2798</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc3045">RFC 3045</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc3296">RFC 3296</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc3671">RFC 3671</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc3672">RFC 3672</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc4512">RFC 4512</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc4519">RFC 4519</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc4523">RFC 4523</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc4524">RFC 4524</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc4530">RFC 4530</member>
+ <member xlink:show="new" xlink:href="https://tools.ietf.org/html/rfc5020">RFC 5020</member>
+ <member xlink:show="new" xlink:href="https://www.itu.int/rec/T-REC-X.501">X.501</member>
+ </simplelist>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>01-pwpolicy.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from
- draft-behera-ldap-password-policy, which defines a mechanism for storing
- password policy information in an LDAP directory server.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/draft-behera-ldap-password-policy-09"
+ >draft-behera-ldap-password-policy</link> (Draft 09),
+ which defines a mechanism for storing password policy information
+ in an LDAP directory server.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>02-config.ldif</filename>
@@ -525,105 +555,170 @@
for use with the directory server configuration.</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>03-changelog.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from
- draft-good-ldap-changelog, which defines a mechanism for storing
- information about changes to directory server data.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/draft-good-ldap-changelog"
+ >draft-good-ldap-changelog</link>, which defines a mechanism
+ for storing information about changes to directory server data.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>03-rfc2713.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from RFC 2713, which defines a
- mechanism for storing serialized Java objects in the directory
- server.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/rfc2713"
+ >RFC 2713</link>, which defines a mechanism
+ for storing serialized Java objects in the directory server.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>03-rfc2714.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from RFC 2714, which defines a
- mechanism for storing CORBA objects in the directory server.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/rfc2714"
+ >RFC 2714</link>, which defines a mechanism
+ for storing CORBA objects in the directory server.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>03-rfc2739.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from RFC 2739, which defines a
- mechanism for storing calendar and vCard objects in the directory server.
- Note that the definition in RFC 2739 contains a number of errors, and this
- schema file has been altered from the standard definition in order to fix
- a number of those problems.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/rfc2739"
+ >RFC 2739</link>, which defines a mechanism
+ for storing calendar and vCard objects in the directory server.
+ Note that the definition in RFC 2739 contains a number of errors,
+ and this schema file has been altered from the standard definition
+ in order to fix a number of those problems.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>03-rfc2926.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from RFC 2926, which defines a
- mechanism for mapping between Service Location Protocol (SLP)
- advertisements and LDAP.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/rfc2926"
+ >RFC 2926</link>, which defines a mechanism
+ for mapping between Service Location Protocol (SLP) advertisements and LDAP.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>03-rfc3112.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from RFC 3112, which defines
- the authentication password schema.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/rfc3112"
+ >RFC 3112</link>, which defines the authentication password schema.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>03-rfc3712.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from RFC 3712, which defines a
- mechanism for storing printer information in the directory server.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/rfc3712"
+ >RFC 3712</link>, which defines a mechanism
+ for storing printer information in the directory server.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>03-uddiv3.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from RFC 4403,
- which defines a mechanism for storing UDDIv3 information in the directory
- server.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/rfc4403"
+ >RFC 4403</link>, which defines a mechanism
+ for storing UDDIv3 information in the directory server.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>04-rfc2307bis.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from the
- draft-howard-rfc2307bis specification, used to store naming service
- information in the directory server.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/draft-howard-rfc2307bis"
+ >draft-howard-rfc2307bis</link>, which defines a mechanism
+ for storing naming service information in the directory server.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>05-rfc4876.ldif</filename>
</term>
<listitem>
- <para>This file contains schema definitions from RFC 4876, which defines
- a schema for storing Directory User Agent (DUA) profiles and preferences
- in the directory server.</para>
+ <para>
+ This file contains schema definitions from
+ <link
+ xlink:show="new"
+ xlink:href="https://tools.ietf.org/html/rfc4876"
+ >RFC 4876</link>, which defines a schema
+ for storing Directory User Agent (DUA) profiles and preferences
+ in the directory server.
+ </para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>05-samba.ldif</filename>
@@ -633,6 +728,7 @@
user accounts in the directory server.</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>05-solaris.ldif</filename>
@@ -642,6 +738,7 @@
OpenSolaris LDAP naming services.</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>
<filename>06-compat.ldif</filename>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-server-process.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-server-process.xml
index e04abf5..0fd8c9a 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-server-process.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-server-process.xml
@@ -48,7 +48,14 @@
<itemizedlist>
<para>Use one of the following techniques.</para>
<listitem>
- <para>Use the <command>start-ds</command> command.</para>
+ <para>
+ Use the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#start-ds-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>start-ds</command></link> command.
+ </para>
<screen>
$ <userinput>start-ds</userinput>
@@ -78,8 +85,16 @@
</listitem>
<listitem>
- <para>(UNIX) Create an RC script, and then use the script to start
- the server.</para>
+ <para>
+ (UNIX) Create an RC script by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#create-rc-script-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>create-rc-script</command></link> command,
+ and then use the script to start the server.
+ </para>
+
<para>Unless you run OpenDJ as root, use the --userName
<replaceable>userName</replaceable> option to specify the user
who installed OpenDJ.</para>
@@ -111,8 +126,15 @@
</screen>
</listitem>
<listitem>
- <para>(Windows) Register OpenDJ as a Windows Service, and then manage
- the service through Windows administration tools.</para>
+ <para>
+ (Windows) Register OpenDJ as a Windows Service by using the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#windows-service-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>windows-service</command></link> command,
+ and then manage the service through Windows administration tools.
+ </para>
<screen>
C:\path\to\opendj\bat> <userinput>windows-service.bat --enableService</userinput>
@@ -137,7 +159,15 @@
<itemizedlist>
<para>Use one of the following techniques.</para>
<listitem>
- <para>Use the <command>stop-ds</command> command.</para>
+ <para>
+ Use the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#stop-ds-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>stop-ds</command></link> command.
+ </para>
+
<screen>$ stop-ds</screen>
</listitem>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-tuning.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-tuning.xml
index 33099be..77abe9f 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-tuning.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-tuning.xml
@@ -249,10 +249,16 @@
and allow you to perform tests at specific levels of throughput.
</para>
- <para>If you need additional precision when evaluating response times, use
- the global configuration setting <literal>etime-resolution</literal> to
- change elapsed processing time resolution from milliseconds (default) to
- nanoseconds.</para>
+ <para>
+ If you need additional precision when evaluating response times,
+ use the global configuration setting,
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#etime-resolution"
+ ><literal>etime-resolution</literal></link>,
+ to change elapsed processing time resolution
+ from milliseconds (default) to nanoseconds.
+ </para>
<screen>
$ <userinput>dsconfig \
@@ -284,9 +290,16 @@
the following JVM options. These apply to the Sun/Oracle JVM.</para>
<tip>
- <para>To apply JVM settings for your server, edit
- <filename>config/java.properties</filename>, and apply the changes with the
- <command>dsjavaproperties</command> command.</para>
+ <para>
+ To apply JVM settings for your server,
+ edit <filename>config/java.properties</filename>,
+ and apply the changes with the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#dsjavaproperties-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>dsjavaproperties</command></link> command.
+ </para>
</tip>
<variablelist>
@@ -358,16 +371,27 @@
<para>By default, OpenDJ compressing attribute descriptions and object class
sets to reduce data size. This is called compact encoding.</para>
- <para>By default, OpenDJ does not however compress entries stored in its
- backend database. If your entries hold values that compress well —
- such as text, and not JPEG photos or MP3 audio — you can gain space
- by setting the local DB backend property
- <literal>entries-compressed</literal> to <literal>true</literal> before you
- (re-)import data from LDIF. With <literal>entries-compressed: true</literal>
- OpenDJ compresses entries before writing them to the database.<footnote>
- <para>OpenDJ does not proactively rewrite all entries in the database after
- you change the settings. Instead, to force OpenDJ to compress all entries,
- import the data from LDIF.</para></footnote></para>
+ <para>
+ By default, OpenDJ does not however compress entries
+ stored in its backend database.
+ If your entries hold values that compress well —
+ such as text, and not JPEG photos or MP3 audio —
+ you can gain space by setting the local DB backend property,
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}local-db-backend.html#entries-compressed"
+ ><literal>entries-compressed</literal></link>,
+ to <literal>true</literal> before you (re-)import data from LDIF.
+ With <literal>entries-compressed: true</literal>
+ OpenDJ compresses entries before writing them to the database.<footnote>
+ <para>
+ OpenDJ does not proactively rewrite all entries in the database
+ after you change the settings.
+ Instead, to force OpenDJ to compress all entries,
+ import the data from LDIF.
+ </para>
+ </footnote>
+ </para>
<screen>
$ <userinput>dsconfig \
@@ -402,13 +426,21 @@
</indexterm>
<para>You can tweak OpenDJ to speed up import of large LDIF files.</para>
-
- <para>By default, the temporary directory used for scratch files is
- <filename>import-tmp</filename> under the directory where you installed
- OpenDJ. Use <command>import-ldif</command> with the
- <option>--tmpdirectory</option> option to set this directory to a
- <literal>tmpfs</literal> file system, such as
- <filename>/tmp</filename>.</para>
+
+ <para>
+ By default, the temporary directory used for scratch files is
+ <filename>import-tmp</filename> under the directory
+ where you installed OpenDJ.
+ Use the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#import-ldif-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>import-ldif</command></link> command
+ with the <option>--tmpdirectory</option> option
+ to set this directory to a <literal>tmpfs</literal> file system,
+ such as <filename>/tmp</filename>.
+ </para>
<para>In some cases, you can improve performance by using the
<option>--threadCount</option> option with the
@@ -426,24 +458,44 @@
<section xml:id="perf-db-cache">
<title>Database Cache Settings</title>
- <para>Database cache size is, by default, set as a percentage of the JVM
- heap, using the backend property <literal>db-cache-percent</literal>.
- Alternatively, you use the backend property
- <literal>db-cache-size</literal> to set the size. If you set up multiple
- database backends, the total percent of JVM heap used must remain less than
- 100, and must leave space for other uses. Default settings work for servers
- with one user data backend JVM heaps up to 2 GB. For heaps larger than 2 GB,
- you can allocate a larger percentage of heap space to DB cache.</para>
+ <para>
+ Database cache size is, by default, set as a percentage of the JVM heap
+ by using the backend property,
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}local-db-backend.html#db-cache-percent"
+ ><literal>db-cache-percent</literal></link>.
+ Alternatively, you use the backend property,
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}local-db-backend.html#db-cache-size"
+ ><literal>db-cache-size</literal></link>,
+ to set the size.
+ If you set up multiple database backends,
+ the total percent of JVM heap used must remain less than 100,
+ and must leave space for other uses.
+ Default settings work for servers
+ with one user data backend JVM heaps up to 2 GB.
+ For heaps larger than 2 GB,
+ you can allocate a larger percentage of heap space to DB cache.
+ </para>
<para>Depending on the size of your database, you have a choice to make
about database cache settings.</para>
- <para>By caching the entire database in the JVM heap, you can get more
- deterministic response times and limit disk I/O. Yet, caching the whole
- DB can require a very large JVM, which you must pre-load on startup, and
- which can result in long garbage collections and a difficult-to-manage
- JVM. Test database pre-load on startup by setting the
- <literal>preload-time-limit</literal> for the backend.</para>
+ <para>
+ By caching the entire database in the JVM heap,
+ you can get more deterministic response times and limit disk I/O.
+ Yet, caching the whole DB can require a very large JVM,
+ which you must pre-load on startup,
+ and which can result in long garbage collections
+ and a difficult-to-manage JVM.
+ Test database pre-load on startup by setting the
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}local-db-backend.html#preload-time-limit"
+ ><literal>preload-time-limit</literal></link>
+ for the backend.</para>
<screen>
$ <userinput>dsconfig \
@@ -494,8 +546,14 @@
--no-prompt</userinput>
</screen>
- <para>You can use the global setting, <literal>entry-cache-preload</literal>,
- to force OpenDJ to load the entry cache as part of server startup.</para>
+ <para>
+ You can use the global setting,
+ <link
+ xlink:show="new"
+ xlink:href="${configRefBase}global.html#entry-cache-preload"
+ ><literal>entry-cache-preload</literal></link>,
+ to force OpenDJ to load the entry cache as part of server startup.
+ </para>
<screen>
$ <userinput>dsconfig \
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-cli.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-cli.xml
index 662f955..b9dfec0 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-cli.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-cli.xml
@@ -143,11 +143,18 @@
<para>Unzip <filename>OpenDJ-<?eval ${docTargetVersion}?>.zip</filename>
in the file system directory where you want to install the server.</para>
- <para>Unlike the web-based Quick Setup install, the <command>setup</command>
- command uses the directory where you unzipped the files as the installation
- directory, and does not ask you where to install OpenDJ. Therefore, if you
- want to install elsewhere on the file system, unzip the files in that
- location.</para>
+ <para>
+ Unlike the web-based Quick Setup install, the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#setup-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>setup</command></link> command uses
+ the directory where you unzipped the files as the installation directory,
+ and does not ask you where to install OpenDJ.
+ Therefore, if you want to install elsewhere on the file system,
+ unzip the files in that location.
+ </para>
<para>When you unzip <filename>OpenDJ-<?eval ${docTargetVersion}?>.zip</filename>,
a top-level <filename>opendj</filename> directory is created in the directory
@@ -381,8 +388,15 @@
</step>
<step>
- <para>Run the <command>status</command> command to make sure your OpenDJ
- server is working as expected.</para>
+ <para>
+ Run the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#status-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>status</command></link> command
+ to make sure your OpenDJ server is working as expected.
+ </para>
<screen>
$ <userinput>/path/to/opendj/bin/status</userinput>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-gui.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-gui.xml
index c7982d3..35b2067 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-gui.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-gui.xml
@@ -28,6 +28,7 @@
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:schemaLocation='http://docbook.org/ns/docbook
http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<title>Installing OpenDJ With the QuickSetup Wizard</title>
<indexterm><primary>Downloading OpenDJ</primary></indexterm>
@@ -71,10 +72,20 @@
$ <userinput>javaws <replaceable>URL-to-QuickSetup-Installer</replaceable></userinput>
</screen>
- <para>The WebStart installer corresponds to what you start if you download
- OpenDJ-<?eval ${docTargetVersion}?>.zip, unzip the file, and then run
- <command>opendj/setup</command> (UNIX), <command>opendj\setup.bat</command>
- (Windows), or <command>opendj/QuickSetup.app</command> (Mac OS X).</para>
+ <para>
+ The WebStart installer corresponds to what you start
+ if you download OpenDJ-${docTargetVersion}.zip,
+ unzip the file,
+ and then run the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#setup-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>setup</command></link> command,
+ <command>opendj/setup</command> (UNIX),
+ <command>opendj\setup.bat</command> (Windows),
+ or <command>opendj/QuickSetup.app</command> (Mac OS X).
+ </para>
<para>Java WebStart launches the the QuickSetup wizard, and soon the
Welcome screen appears.</para>
@@ -167,8 +178,15 @@
</mediaobject>
<itemizedlist>
- <para>To launch OpenDJ Control Panel again later, you can run one of the
- following, depending on your host system.</para>
+ <para>
+ To launch OpenDJ Control Panel again later, run the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#control-panel-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>control-panel</command></link> command.
+ Depending on your host system, this command is one of the following.
+ </para>
<listitem>
<para>(Mac OS X) <command>/path/to/opendj/bin/ControlPanel.app</command></para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-uninstall.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-uninstall.xml
index c33a532..47217ae 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-uninstall.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-uninstall.xml
@@ -24,10 +24,11 @@
!
-->
<chapter xml:id='chap-uninstall'
- xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:schemaLocation='http://docbook.org/ns/docbook
- http://docbook.org/xml/5.0/xsd/docbook.xsd'>
+ xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
+ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+ xsi:schemaLocation='http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'>
<title>Removing OpenDJ Servers</title>
<indexterm><primary>Uninstalling</primary></indexterm>
@@ -43,6 +44,15 @@
<procedure xml:id="uninstall-gui">
<title>To Uninstall OpenDJ From the Graphical Uninstaller</title>
<step>
+ <para>
+ Run the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#uninstall-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>uninstall</command></link> command.
+ </para>
+
<para>(UNIX) Run <command>/path/to/opendj/uninstall</command>.</para>
<para>(Windows) Double-click <filename>/path/to/opendj\uninstall.bat</filename>.</para>
<para>(Mac OS X) Double-click <filename>/path/to/opendj/Uninstall.app</filename>.</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-upgrade.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-upgrade.xml
index 8c911a8..3985657 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-upgrade.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-upgrade.xml
@@ -109,9 +109,17 @@
</step>
<step>
- <para>Run the <command>upgrade</command> command to bring OpenDJ
- configuration and application data up to date with the new binary and
- script files that you copied over the current server files.</para>
+ <para>
+ Run the
+ <link
+ xlink:show="new"
+ xlink:href="admin-guide#upgrade-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><command>upgrade</command></link> command
+ to bring OpenDJ configuration and application data up to date
+ with the new binary and script files
+ that you copied over the current server files.
+ </para>
<para>By default, the <command>upgrade</command> command requests
confirmation before making important configuration changes. For some
--
Gitblit v1.10.0