You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by se...@apache.org on 2020/04/08 21:00:30 UTC
[directory-studio] branch master updated (bddc7e2 -> 532bb66)
This is an automated email from the ASF dual-hosted git repository.
seelmann pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/directory-studio.git.
from bddc7e2 DIRSTUDIO-1165: Fix table entry editor preferences documentation
new d84d44a DIRSTUDIO-1124: Update basic LDAP server view doc
new def1db7 DIRSTUDIO-1124: Update configuration doc to ApacheDS 2.0.0
new 532bb66 Fix typos and layout
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
helps/apacheds.help/src/main/docbook/0_index.xml | 2 +-
.../src/main/docbook/1.1_download_install.xml | 3 +-
..._servers_view.xml => 1.2_ldap_servers_view.xml} | 99 +++++++--
.../1.3.1_configuration_editor_overview.xml | 106 +++-------
.../1.3.2_configuration_editor_ldap_server.xml | 221 +++++++++++++-------
.../1.3.3_configuration_editor_kerberos_server.xml | 75 ++++++-
.../1.3.4_configuration_editor_partitions.xml | 158 ++++++--------
.../main/docbook/1.3.5_configuration_editor_pp.xml | 229 +++++++++++++--------
.../docbook/1.3.6_configuration_editor_repl.xml | 130 +++++-------
.../src/main/docbook/1.3_configuration_editor.xml | 8 +-
.../src/main/docbook/1_gettingstarted.xml | 2 +-
.../src/main/docbook/2.1_creating_new_server.xml | 18 +-
.../images/gettingstarted/editor_1.5.7_general.png | Bin 43177 -> 0 bytes
.../gettingstarted/editor_1.5.7_general_limits.png | Bin 7296 -> 0 bytes
.../editor_1.5.7_general_options.png | Bin 8742 -> 0 bytes
.../editor_1.5.7_general_protocols.png | Bin 13328 -> 0 bytes
.../editor_2.0.0_kerberos_server.png | Bin 0 -> 69310 bytes
.../gettingstarted/editor_2.0.0_ldap_servers.png | Bin 0 -> 115569 bytes
.../gettingstarted/editor_2.0.0_overview.png | Bin 0 -> 44152 bytes
.../gettingstarted/editor_2.0.0_partitions.png | Bin 0 -> 62566 bytes
.../editor_2.0.0_passwordpolicies.png | Bin 0 -> 56129 bytes
.../gettingstarted/editor_2.0.0_replication.png | Bin 0 -> 70776 bytes
.../resources/html/images/icons_connection_add.gif | Bin
.../html/images/tasks_new_server_wizard.png | Bin 12315 -> 28973 bytes
.../resources/html/images/views_ldap_servers.png | Bin 0 -> 8503 bytes
.../resources/html/images/views_servers-view.png | Bin 7577 -> 0 bytes
.../configuration/editor/LdapLdapsServersPage.java | 2 +-
.../editor/PasswordPolicyDetailsPage.java | 14 +-
.../editor/ReplicationDetailsPage.java | 2 +-
29 files changed, 607 insertions(+), 462 deletions(-)
rename helps/apacheds.help/src/main/docbook/{1.2_servers_view.xml => 1.2_ldap_servers_view.xml} (65%)
delete mode 100644 helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general.png
delete mode 100644 helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_limits.png
delete mode 100644 helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_options.png
delete mode 100644 helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_protocols.png
create mode 100644 helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_kerberos_server.png
create mode 100644 helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_ldap_servers.png
create mode 100644 helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_overview.png
create mode 100644 helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_partitions.png
create mode 100644 helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_passwordpolicies.png
create mode 100644 helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_replication.png
copy plugins/ldapservers.apacheds/resources/icons/connection_new.gif => helps/apacheds.help/src/main/resources/html/images/icons_connection_add.gif (100%)
create mode 100644 helps/apacheds.help/src/main/resources/html/images/views_ldap_servers.png
delete mode 100644 helps/apacheds.help/src/main/resources/html/images/views_servers-view.png
[directory-studio] 02/03: DIRSTUDIO-1124: Update configuration doc
to ApacheDS 2.0.0
Posted by se...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
seelmann pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-studio.git
commit def1db716b43f4590b27dcfc96fd5903cbbf9c8a
Author: Stefan Seelmann <ma...@stefan-seelmann.de>
AuthorDate: Wed Apr 8 22:59:50 2020 +0200
DIRSTUDIO-1124: Update configuration doc to ApacheDS 2.0.0
---
.../src/main/docbook/1.2_ldap_servers_view.xml | 2 +-
.../1.3.1_configuration_editor_overview.xml | 106 +++-------
.../1.3.2_configuration_editor_ldap_server.xml | 221 +++++++++++++-------
.../1.3.3_configuration_editor_kerberos_server.xml | 75 ++++++-
.../1.3.4_configuration_editor_partitions.xml | 158 ++++++--------
.../main/docbook/1.3.5_configuration_editor_pp.xml | 229 +++++++++++++--------
.../docbook/1.3.6_configuration_editor_repl.xml | 130 +++++-------
.../src/main/docbook/1.3_configuration_editor.xml | 8 +-
.../images/gettingstarted/editor_1.5.7_general.png | Bin 43177 -> 0 bytes
.../gettingstarted/editor_1.5.7_general_limits.png | Bin 7296 -> 0 bytes
.../editor_1.5.7_general_options.png | Bin 8742 -> 0 bytes
.../editor_1.5.7_general_protocols.png | Bin 13328 -> 0 bytes
.../editor_2.0.0_kerberos_server.png | Bin 0 -> 69310 bytes
.../gettingstarted/editor_2.0.0_ldap_servers.png | Bin 0 -> 115569 bytes
.../gettingstarted/editor_2.0.0_overview.png | Bin 0 -> 44152 bytes
.../gettingstarted/editor_2.0.0_partitions.png | Bin 0 -> 62566 bytes
.../editor_2.0.0_passwordpolicies.png | Bin 0 -> 56129 bytes
.../gettingstarted/editor_2.0.0_replication.png | Bin 0 -> 70776 bytes
18 files changed, 499 insertions(+), 430 deletions(-)
diff --git a/helps/apacheds.help/src/main/docbook/1.2_ldap_servers_view.xml b/helps/apacheds.help/src/main/docbook/1.2_ldap_servers_view.xml
index 593e982..d27901b 100644
--- a/helps/apacheds.help/src/main/docbook/1.2_ldap_servers_view.xml
+++ b/helps/apacheds.help/src/main/docbook/1.2_ldap_servers_view.xml
@@ -27,7 +27,7 @@
Here is an example screenshot of the LDAP Servers view:
<screenshot>
<mediaobject>
- j<imageobject>
+ <imageobject>
<imagedata scale="50"
fileref="images/views_ldap_servers.png"
format="PNG" />
diff --git a/helps/apacheds.help/src/main/docbook/1.3.1_configuration_editor_overview.xml b/helps/apacheds.help/src/main/docbook/1.3.1_configuration_editor_overview.xml
index e3ea8ff..afb5349 100644
--- a/helps/apacheds.help/src/main/docbook/1.3.1_configuration_editor_overview.xml
+++ b/helps/apacheds.help/src/main/docbook/1.3.1_configuration_editor_overview.xml
@@ -17,114 +17,77 @@
under the License.
-->
<section id="gettingstarted_configuration_editor_overview">
- <title>General Page</title>
+ <title>Overview Page</title>
<para>
The
- <emphasis role="strong">General Page</emphasis>
- of the Configuration Editor allows you to edit the server
- settings.
+ <emphasis role="strong">Overview page</emphasis>
+ gives you a quick overview about enabled protocols,
+ ports, and configured partitions.
</para>
<para>
- It contains three sections :
- <emphasis role="strong">Protocols</emphasis>
+ It contains four sections :
+ <emphasis role="strong">LDAP/LDAPS Servers</emphasis>
,
- <emphasis role="strong">Limits</emphasis>
+ <emphasis role="strong">Kerberos Server</emphasis>
+ ,
+ <emphasis role="strong">Partitions</emphasis>
and
<emphasis role="strong">Options</emphasis>
.
</para>
<para>
Here's what the
- <emphasis role="strong">General Page</emphasis>
+ <emphasis role="strong">Overview page</emphasis>
looks like:
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_general.png"
+ fileref="images/gettingstarted/editor_2.0.0_overview.png"
format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
- <simplesect id="configuration_editor_1.5.7_general_protocols">
- <title>Protocols</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_general_protocols.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <simplesect id="configuration_editor_2.0.0_overview_ldap_servers">
+ <title>LDAP/LDAPS Servers</title>
<para>
This section allows you to enable/disable each of the
following protocols and specify the port it is running on:
<itemizedlist spacing="normal" mark="bullet">
<listitem>LDAP (default port: 10389)</listitem>
- <listitem>LDAPS (default port: 636)</listitem>
- <listitem>Kerberos (default port: 88)</listitem>
- <listitem>NTP (default port: 123)</listitem>
- <listitem>DNS (default port: 53)</listitem>
- <listitem>Change Password (default port: 464)</listitem>
+ <listitem>LDAPS (default port: 10636)</listitem>
</itemizedlist>
</para>
</simplesect>
-
- <simplesect id="configuration_editor_1.5.7_general_limits">
- <title>Limits</title>
- <para>
- This section allows you to specify the Limits of the server.
- </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_general_limits.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <simplesect id="configuration_editor_2.0.0_overview_kerberos_server">
+ <title>Kerberos Server</title>
<para>
- <emphasis role="strong">Max. Time Limit</emphasis>
- lets you choose the maximum time that should last a request
- (in milliseconds).
- </para>
- <para>
- <emphasis role="strong">Max. Size Limit</emphasis>
- lets you choose the maximum number of entries that should be
- returned.
- </para>
- <para>
- <emphasis role="strong">Synchronization Period</emphasis>
- lets you choose the number of milliseconds between two
- synchronizations.
+ This section allows you to enable/disable each of the
+ following protocols and specify the port it is running on:
+ <itemizedlist spacing="normal" mark="bullet">
+ <listitem>Kerberos (default port: 60088)</listitem>
+ <listitem>Change Password (default port: 60464)</listitem>
+ </itemizedlist>
</para>
+ </simplesect>
+
+
+ <simplesect id="configuration_editor_2.0.0_overview_partitions">
+ <title>Limits</title>
<para>
- <emphasis role="strong">Max. Threads</emphasis>
- lets you choose the number of threads that should be used by
- the server in its execution.
+ This section shows the partitions defined.
</para>
</simplesect>
- <simplesect id="configuration_editor_1.5.7_general_options">
+ <simplesect id="configuration_editor_2.0.0_overview_options">
<title>Options</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_general_options.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
<para>
Check the
- <emphasis role="strong">Allow Anymous Access</emphasis>
- checkbox to allow anymous access on the server.
+ <emphasis role="strong">Allow Anonymous Access</emphasis>
+ checkbox to allow anonymous access on the server.
</para>
<para>
Check the
@@ -134,12 +97,9 @@
<para>
Check the
<emphasis role="strong">
- Denormalize Operational Attributes
+ Enable Hidden Password
</emphasis>
- to use a more human readable form ('uid=admin,ou=system'
- instead of
- '0.9.2342.19200300.100.1.1=admin,2.5.4.11=system') for
- Operational Attributes on the server.
+ to hide password attributes in search results.
</para>
</simplesect>
</section>
\ No newline at end of file
diff --git a/helps/apacheds.help/src/main/docbook/1.3.2_configuration_editor_ldap_server.xml b/helps/apacheds.help/src/main/docbook/1.3.2_configuration_editor_ldap_server.xml
index ba77eee..ed8c0e0 100644
--- a/helps/apacheds.help/src/main/docbook/1.3.2_configuration_editor_ldap_server.xml
+++ b/helps/apacheds.help/src/main/docbook/1.3.2_configuration_editor_ldap_server.xml
@@ -17,35 +17,39 @@
under the License.
-->
<section id="gettingstarted_configuration_editor_ldap_server">
- <title>LDAP/LDAPS Server Page</title>
+ <title>LDAP/LDAPS Servers Page</title>
<para>
The
- <emphasis role="strong">Authentication Page</emphasis>
- of the Configuration Editor allows you to edit the server
- authentication settings.
+ <emphasis role="strong">LDAP/LDAPS Servers page</emphasis>
+ of the configuration editor allows you to edit all LDAP
+ specific settings.
</para>
<para>
- It contains four sections :
- <emphasis role="strong">
- Supported Authentication Mechanisms
- </emphasis>
+ It contains the following sections :
+ <emphasis role="strong">LDAP/LDAPS Servers</emphasis>
,
- <emphasis role="strong">SASL Settings</emphasis>
+ <emphasis role="strong">Limits</emphasis>
+ ,
+ <emphasis role="strong">SSL/Start TLS Keystore</emphasis>
+ ,
+ <emphasis role="strong">SSL Advanced Settings</emphasis>
+ ,
+ <emphasis role="strong">Supported Authentication Mechanisms</emphasis>
,
- <emphasis role="strong">SASL Quality Of Protection</emphasis>
+ <emphasis role="strong">SASL Settings</emphasis>
and
- <emphasis role="strong">SASL Realms</emphasis>
+ <emphasis role="strong">Advanced</emphasis>
.
</para>
<para>
Here's what the
- <emphasis role="strong">Authentication Page</emphasis>
+ <emphasis role="strong">LDAP/LDAPS Servers page</emphasis>
looks like:
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_authentication.png"
+ fileref="images/gettingstarted/editor_2.0.0_ldap_servers.png"
format="PNG" />
</imageobject>
</mediaobject>
@@ -53,47 +57,111 @@
</para>
<simplesect
- id="configuration_editor_1.5.7_authentication_supported_authentication_mechanisms">
+ id="configuration_editor_2.0.0_ldap_servers_ldap_servers">
+ <title>LDAP/LDAPS Servers</title>
+ <para>
+ This section allows you to enable/disable the LDAP and LDAPS protocols.
+ For each protocol you can specify
+ <itemizedlist spacing="normal" mark="bullet">
+ <listitem>Port: the TCP port the server should listen to</listitem>
+ <listitem>Address: the IP address the server should bind to (default 0.0.0.0 means to bind to all network interfaces)</listitem>
+ <listitem>NbThreads: the number of threads to use to serve requests</listitem>
+ <listitem>Backlog Size: the number of requests to queue when all threads are busy</listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="configuration_editor_2.0.0_ldap_servers_limits">
+ <title>Limits</title>
+ <para>
+ This section allows you to specify the Limits of the server.
+ </para>
+ <para>
+ <emphasis role="strong">Max. Time Limit</emphasis>
+ lets you choose the maximum time that should last a request
+ (in milliseconds).
+ </para>
+ <para>
+ <emphasis role="strong">Max. Size Limit</emphasis>
+ lets you choose the maximum number of entries that should be
+ returned.
+ </para>
+ <para>
+ <emphasis role="strong">Max. PDU Size</emphasis>
+ lets you choose the maximum PDU size (in bytes).
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="configuration_editor_2.0.0_ldap_servers_ssl_keystore">
+ <title>SSL/Start TLS Keystore</title>
+ <para>
+ This section allows you to specify keystore which contains the
+ private key used for SSL and Start TLS sessions.
+ </para>
+ <para>
+ <emphasis role="strong">Keystore</emphasis>
+ lets you select the path to the keystore file.
+ </para>
+ <para>
+ <emphasis role="strong">Password</emphasis>
+ lets you enter the password of the keystore file.
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="configuration_editor_2.0.0_ldap_servers_ssl_advanced">
+ <title>SSL Advanced Settings</title>
+ <para>
+ This section allows you to specify advanced settings for
+ SSL and Start TLS.
+ </para>
+ <para>
+ Check the
+ <emphasis role="strong">Require Client Auth</emphasis>
+ checkbox to require client authentication.
+ </para>
+ <para>
+ Check the
+ <emphasis role="strong">Request Client Auth</emphasis>
+ checkbox to request client authentication.
+ </para>
+ <para>
+ <emphasis role="strong">Ciphers Suite</emphasis>
+ lets you select which cipher suites are allowed to use.
+ </para>
+ <para>
+ <emphasis role="strong">Enabled Protocols</emphasis>
+ lets you select which protocols are enabled
+ (default: TLSv1, TLSv1.1, TLSv1.2).
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="configuration_editor_2.0.0_ldap_servers_supported_authentication_mechanisms">
<title>Supported Authentication Mechanisms</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_authentication_supported_authentication_mechanisms.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
<para>
This section allows you to specify the supported
authentication mechanisms. You can choose between the
following mechanisms:
<itemizedlist spacing="normal" mark="bullet">
<listitem>SIMPLE</listitem>
+ <listitem>GSSAPI (SASL)</listitem>
<listitem>CRAM-MD5 (SASL)</listitem>
<listitem>DIGEST-MD5 (SASL)</listitem>
- <listitem>GSSAPI (SASL)</listitem>
- <listitem>NTML (SASL)</listitem>
- <listitem>GSS-SPNEGO (SASL)</listitem>
+ <listitem>NTML (SASL), including the provider</listitem>
+ <listitem>GSS-SPNEGO (SASL), including the provider</listitem>
</itemizedlist>
</para>
</simplesect>
<simplesect
- id="configuration_editor_1.5.7_authentication_sasl_settings">
+ id="configuration_editor_2.0.0_ldap_servers_sasl_settings">
<title>SASL Settings</title>
<para>
- This section allows you to specify to the SASL setting.
+ This section allows you to specify to the SASL settings.
</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_authentication_sasl_settings.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
<para>
The
<emphasis role="strong">SASL Host</emphasis>
@@ -116,51 +184,11 @@
where the LDAP service principal must reside, as well as
where user principals must reside.
</para>
- </simplesect>
-
- <simplesect
- id="configuration_editor_1.5.7_authentication_sasl_qop">
- <title>SASL Quality Of Protection</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_authentication_sasl_qop.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>
- This section allows you to specify the SASL quality of
- protection. You can choose between the following values:
- <itemizedlist spacing="normal" mark="bullet">
- <listitem>auth (Authentication only)</listitem>
- <listitem>
- auth-int (Authentication with integrity protection)
- </listitem>
- <listitem>
- auth-conf (Authentication with integrity and privacy
- protection)
- </listitem>
- </itemizedlist>
- </para>
- </simplesect>
-
- <simplesect
- id="configuration_editor_1.5.7_authentication_sasl_realms">
- <title>SASL Realms</title>
<para>
- This section allows you to specify to the SASL realms.
+ The
+ <emphasis role="strong">SASL Realms</emphasis>
+ field allows you specify to the SASL realms.
</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_authentication_sasl_realms.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
<para>
Use the
<emphasis role="strong">Add...</emphasis>
@@ -172,4 +200,37 @@
</para>
</simplesect>
+ <simplesect
+ id="configuration_editor_2.0.0_ldap_servers_advanced">
+ <title>Advanced</title>
+ <para>
+ This section allows you to specify other advanced
+ settings of the server.
+ </para>
+ <para>
+ Check the
+ <emphasis role="strong">Enable TLS</emphasis>
+ checkbox to enable the Start TLS extended operation.
+ </para>
+ <para>
+ Check the
+ <emphasis role="strong">Enable server-side password hashing</emphasis>
+ checkbox to instruct the server to hash modified user passwords on the
+ server side.
+ When checked this also allows you to select the hashing method to use.
+ </para>
+ <para>
+ The
+ <emphasis role="strong">Replication pinger sleep</emphasis>
+ field allows you to define the frequency how often the replication
+ consumer pings the replication producer (in seconds).
+ </para>
+ <para>
+ The
+ <emphasis role="strong">Disk synchronization delay</emphasis>
+ field allows you to define the frequency how often data is
+ synchronized to the disk (in milliseconds).
+ </para>
+ </simplesect>
+
</section>
\ No newline at end of file
diff --git a/helps/apacheds.help/src/main/docbook/1.3.3_configuration_editor_kerberos_server.xml b/helps/apacheds.help/src/main/docbook/1.3.3_configuration_editor_kerberos_server.xml
index 4691d89..a39b3cd 100644
--- a/helps/apacheds.help/src/main/docbook/1.3.3_configuration_editor_kerberos_server.xml
+++ b/helps/apacheds.help/src/main/docbook/1.3.3_configuration_editor_kerberos_server.xml
@@ -20,9 +20,78 @@
<title>Kerberos Server Page</title>
<para>
The
- <emphasis role="strong">Authentication Page</emphasis>
- of the Configuration Editor allows you to edit the server
- authentication settings.
+ <emphasis role="strong">Kerberos Page</emphasis>
+ of the configuration editor allows you to edit all Keberos
+ specific settings.
</para>
+ <para>
+ It contains the following sections :
+ <emphasis role="strong">Kerberos Server</emphasis>
+ ,
+ <emphasis role="strong">Kerberos Settings</emphasis>
+ and
+ <emphasis role="strong">Ticket Settings</emphasis>
+ .
+ </para>
+ <para>
+ Here's what the
+ <emphasis role="strong">Kerberos Server page</emphasis>
+ looks like:
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata scale="50"
+ fileref="images/gettingstarted/editor_2.0.0_kerberos_server.png"
+ format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+
+ <simplesect
+ id="configuration_editor_2.0.0_keberos_server_kerberos_server">
+ <title>Kerberos Server</title>
+ <para>
+ This section allows you to enable/disable the Kerberos and Change Password protocols.
+ For each protocol you can specify
+ <itemizedlist spacing="normal" mark="bullet">
+ <listitem>Port: the TCP port the server should listen to</listitem>
+ <listitem>Address: the IP address the server should bind to (default 0.0.0.0 means to bind to all network interfaces)</listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="configuration_editor_2.0.0_keberos_server_kerberos_settings">
+ <title>Kerberos Settings</title>
+ <para>
+ This section allows you to specify to the Kerberos server settings.
+ </para>
+ <para>
+ The
+ <emphasis role="strong">Primary KDC Realm</emphasis>
+ field represents the primary realm of the key distribution controller.
+ </para>
+ <para>
+ The
+ <emphasis role="strong">Search Base DN</emphasis>
+ field represents base DN in the LDAP server where principals
+ are searched.
+ </para>
+ <para>
+ <emphasis role="strong">Encryption Types</emphasis>
+ lets you select which encryption types are allowed to use.
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="configuration_editor_2.0.0_keberos_server_ticket_settings">
+ <title>Ticket Settings</title>
+ <para>
+ This section allows you to specify to the Ticket specific settings.
+ Please refer to RFC 1510 and RFC 4120 for detailed information
+ about each setting.
+ </para>
+ </simplesect>
</section>
\ No newline at end of file
diff --git a/helps/apacheds.help/src/main/docbook/1.3.4_configuration_editor_partitions.xml b/helps/apacheds.help/src/main/docbook/1.3.4_configuration_editor_partitions.xml
index b557779..c5578cd 100644
--- a/helps/apacheds.help/src/main/docbook/1.3.4_configuration_editor_partitions.xml
+++ b/helps/apacheds.help/src/main/docbook/1.3.4_configuration_editor_partitions.xml
@@ -21,7 +21,7 @@
<para>
The
<emphasis role="strong">Partitions Page</emphasis>
- of the Configuration Editor allows you to edit the server
+ of the configuration editor allows you to edit the server
partitions.
</para>
<para>
@@ -32,7 +32,7 @@
<mediaobject>
<imageobject>
<imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_partitions.png"
+ fileref="images/gettingstarted/editor_2.0.0_partitions.png"
format="PNG" />
</imageobject>
</mediaobject>
@@ -40,50 +40,40 @@
</para>
<para>The page is divided vertically in two parts.</para>
<para>
- You can choose the orientation of the page by clicking on the
- appropriate button ("Horizontal Orientation"
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/horizontal_orientation.gif"
- format="GIF" />
- </imageobject>
- or "Vertical Orientation"
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/vertical_orientation.gif"
- format="GIF" />
- </imageobject>
- ) at the right of the page.
- </para>
- <para>
The left side of the page shows the partitions defined on the
server. This is where you can add or delete a partition.
</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_partitions_list.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <para>
+ The following icons appear:
+ <itemizedlist spacing="normal" mark="bullet">
+ <listitem>
+ <imageobject>
+ <imagedata scale="50"
+ fileref="images/gettingstarted/partition.gif" format="GIF" />
+ </imageobject>
+ : Standard Partition
+ </listitem>
+ <listitem>
+ <imageobject>
+ <imagedata scale="50"
+ fileref="images/gettingstarted/partition_system.gif" format="GIF" />
+ </imageobject>
+ : System Partition
+ </listitem>
+ </itemizedlist>
+ </para>
<para>
The right side of the page display and lets you edit the details
of the selected partition in the left side.
</para>
- <simplesect id="config1.5.4on_editor_1.5.7_partitions_details">
- <title>Partition details</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_partitions_details.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <simplesect id="configuration_editor_2.0.0_partitions_details">
+ <title>Partition General Details</title>
+ <para>
+ <emphasis role="strong">Partiton Type</emphasis>
+ allows you to choose the partition type.
+ Available options are JDBM or Mavibot.
+ </para>
<para>
An
<emphasis role="strong">ID</emphasis>
@@ -91,43 +81,54 @@
</para>
<para>
A
- <emphasis role="strong">Cache Size</emphasis>
- is mandatory for the partition.
+ <emphasis role="strong">Suffix</emphasis>
+ is mandatory for the partition and defines the context entry DN.
</para>
<para>
- A
- <emphasis role="strong">Suffix</emphasis>
- is mandatory for the partition.
+ Check the
+ <emphasis role="strong">Synchronization On Write</emphasis>
+ checkbox to enable the synchronization on write for the
+ partition.
</para>
+ </simplesect>
+
+ <simplesect id="configuration_editor_2.0.0_partitions_details">
+ <title>Context Entry</title>
<para>
Check the
- <emphasis role="strong">Enable Optimizer</emphasis>
- checkbox to enable the optimizer for the partition.
+ <emphasis role="strong">Auto-generate context entry from suffix DN</emphasis>
+ to instruct the server to automatically generate
+ the context entry on first startup.
+ </para>
+ <para>
+ If you disable the auto-generation you have to specify all attributes.
+ </para>
+ </simplesect>
+
+ <simplesect id="configuration_editor_2.0.0_partition_specific_settings">
+ <title>Partition Specific Settings</title>
+ <para>
+ If you selected JDBM partition type the following settings are available.
+ </para>
+ <para>
+ The
+ <emphasis role="strong">Cache Size</emphasis>
+ defines the cache size of the partition.
</para>
<para>
Check the
- <emphasis role="strong">Synchronization On Write</emphasis>
- checkbox to enable the synchronization on write for the
- partition.
+ <emphasis role="strong">Enable Optimizer</emphasis>
+ checkbox to enable the optimizer for the partition.
</para>
</simplesect>
<simplesect
- id="configuration_editor_1.5.7_partitions_indexed_attributes">
+ id="configuration_editor_2.0.0_partitions_indexed_attributes">
<title>Indexed Attributes</title>
<para>
This section allows you to specify to the server the
attributes that should be indexed and their cache size.
</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_partitions_indexed_attributes.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
<para>
Use the
<emphasis role="strong">Add...</emphasis>
@@ -138,45 +139,4 @@
buttons to set the indexed attributes.
</para>
</simplesect>
- <para></para>
- <para>The following icons can appear in the Partitions Page.</para>
- <para>
- <informaltable>
- <tgroup cols="2">
- <colspec colname="Icon" colwidth="1* " />
- <colspec colname="Description" colwidth="3*" />
- <thead>
- <row>
- <entry>Icon</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry align="center">
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/partition.gif" format="GIF" />
- </imageobject>
- </mediaobject>
- </entry>
- <entry>Standard Partition</entry>
- </row>
- <row>
- <entry align="center">
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/partition_system.gif"
- format="GIF" />
- </imageobject>
- </mediaobject>
- </entry>
- <entry>System Partition</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
</section>
\ No newline at end of file
diff --git a/helps/apacheds.help/src/main/docbook/1.3.5_configuration_editor_pp.xml b/helps/apacheds.help/src/main/docbook/1.3.5_configuration_editor_pp.xml
index 7315d95..758b76d 100644
--- a/helps/apacheds.help/src/main/docbook/1.3.5_configuration_editor_pp.xml
+++ b/helps/apacheds.help/src/main/docbook/1.3.5_configuration_editor_pp.xml
@@ -17,22 +17,24 @@
under the License.
-->
<section id="gettingstarted_configuration_editor_pp">
- <title>Password Policy Page</title>
+ <title>Password Policies Page</title>
<para>
The
- <emphasis role="strong">Interceptors Page</emphasis>
- of the Configuration Editor allows you to edit the server
- interceptors.
+ <emphasis role="strong">Password Policies Page</emphasis>
+ of the configuration editor allows you to edit the server's
+ password policies.
+ See also IETF draft-behera-ldap-password-policy-10 for a
+ detailed description of the password policy configuration.
</para>
<para>
Here's what the
- <emphasis role="strong">Interceptors Page</emphasis>
+ <emphasis role="strong">Password Policies page</emphasis>
looks like:
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_interceptors.png"
+ fileref="images/gettingstarted/editor_2.0.0_passwordpolicies.png"
format="PNG" />
</imageobject>
</mediaobject>
@@ -40,94 +42,149 @@
</para>
<para>The page is divided vertically in two parts.</para>
<para>
- You can choose the orientation of the page by clicking on the
- appropriate button ("Horizontal Orientation"
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/horizontal_orientation.gif"
- format="GIF" />
- </imageobject>
- or "Vertical Orientation"
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/vertical_orientation.gif"
- format="GIF" />
- </imageobject>
- ) at the right of the page.
+ The left side of the page shows the password policies defined on the
+ server. This is where you can add or delete a policy.
</para>
<para>
- The left side of the page shows the interceptors defined on the
- server. This is where you can add or delete an interceptor.
- </para>
- <para>
- You can also choose the order of the interceptors in the
- interceptors' chain using the "Up" and "Down" buttons.
- </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_interceptors_list.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>
- The right side of the page display and lets you see the details
- of the selected interceptor in the left side.
+ The right side of the page display and lets you edit the details
+ of the selected password policy in the left side.
</para>
- <simplesect id="configuration_editor_1.5.7_interceptors_details">
- <title>Interceptor details</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_interceptors_details.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <simplesect id="configuration_editor_2.0.0_pp_details">
+ <title>Password Policy Details</title>
<para>
- The
- <emphasis role="strong">Name</emphasis>
- field displays the name of the interceptor.
+ Check the
+ <emphasis role="strong">Enabled</emphasis>
+ checkbox to enable the password policy.
</para>
<para>
- The
+ An
+ <emphasis role="strong">ID</emphasis>
+ is mandatory for the password policy.
+ </para>
+ <para>
+ An
<emphasis role="strong">Description</emphasis>
- field displays the description of the interceptor.
+ is optional for the password policy.
+ </para>
+ </simplesect>
+
+ <simplesect id="configuration_editor_2.0.0_pp_quality">
+ <title>Quality</title>
+ <para>
+ <emphasis role="strong">Check Quality</emphasis>
+ defines which quality level a new password must fulfil.
+ One of the following options can be chosen:
+ <itemizedlist spacing="normal" mark="bullet">
+ <listitem>Disabled - Don't check the password</listitem>
+ <listitem>Relaxed - Check the password and accept passwords that can't be checked (hashed passwords)</listitem>
+ <listitem>Strict - Check the password but reject passwords that can't be checked (hashed passwords)</listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ <emphasis role="strong">Validator</emphasis>
+ Defines the class that implements PasswordValidator interface (default
+ org.apache.directory.server.core.api.authn.ppolicy.DefaultPasswordValidator).
+ </para>
+ <para>
+ Check
+ <emphasis role="strong">Enable Minimum Length</emphasis>
+ to enable and specify the minimum password length.
+ </para>
+ <para>
+ Check
+ <emphasis role="strong">Enable Maximum Length</emphasis>
+ to enable and specify the maximum password length.
+ </para>
+ </simplesect>
+
+ <simplesect id="configuration_editor_2.0.0_pp_expiration">
+ <title>Expiration</title>
+ <para>
+ <emphasis role="strong">Minimum Age</emphasis>
+ defines the number of seconds that must elapse between modifications to the password.
+ </para>
+ <para>
+ <emphasis role="strong">Maximum Age</emphasis>
+ defines the number of seconds after which a modified password will expire.
+ Default value is 0, does not expire. If not 0, the value must be
+ greater than or equal to the value of the minimum age.
+ </para>
+ <para>
+ Check
+ <emphasis role="strong">Enable Expire Warning</emphasis>
+ to enable and specify the number of seconds before password expiration a warning
+ message will be returned to an authentication user.
+ </para>
+ <para>
+ Check
+ <emphasis role="strong">Enable Grace Authentication Limit</emphasis>
+ to enable and specify the how often an expired password can be used to authenticate.
+ </para>
+ <para>
+ Check
+ <emphasis role="strong">Enable Grace Expire</emphasis>
+ to enable and specify the number of seconds for the grace period.
+ </para>
+ </simplesect>
+
+ <simplesect id="configuration_editor_2.0.0_pp_options">
+ <title>Options</title>
+ <para>
+ Check
+ <emphasis role="strong">Enable Must Change</emphasis>
+ to enforce that the password must be changed by the user after a password reset.
+ </para>
+ <para>
+ Check
+ <emphasis role="strong">Enable Allow User Change</emphasis>
+ to allow users to change their own password.
+ </para>
+ <para>
+ Check
+ <emphasis role="strong">Enable Safe Modify</emphasis>
+ to enforce that the existing password must be ent when changing the password.
+ </para>
+ </simplesect>
+
+ <simplesect id="configuration_editor_2.0.0_pp_lockout">
+ <title>Lockout</title>
+ <para>
+ Check
+ <emphasis role="strong">Enable Lockout</emphasis>
+ to enable password lockout.
+ </para>
+ <para>
+ <emphasis role="strong">Lockout Duraton</emphasis>
+ defines the number of seconds that the password cannot be used
+ to authenticate due to too many failed bind attempts.
+ </para>
+ <para>
+ <emphasis role="strong">Maximum consecutive Failrues</emphasis>
+ defines the number of consecutive failed bind attempts after
+ which the password may not be used to authenticate.
+ </para>
+ <para>
+ Check
+ <emphasis role="strong">Enable Maximum Idle</emphasis>
+ to enable and specify the number of seconds an account may
+ remain unused before it becomes locked.
+ </para>
+ <para>
+ Check
+ <emphasis role="strong">Enable In History</emphasis>
+ to enable and specify the maximum number of used password
+ history is preserved.
+ </para>
+ <para>
+ <emphasis role="strong">Minimum Delay</emphasis>
+ defines the number of seconds to delay responding to the
+ first failed authentication attempt. Default value 0, no delay
+ </para>
+ <para>
+ <emphasis role="strong">Maximum Delay</emphasis>
+ defines the maximum number of seconds to delay responding to the
+ first failed authentication attempt.
</para>
</simplesect>
- <para></para>
- <para>
- The following icons can appear in the Interceptors Page.
- </para>
- <para>
- <informaltable>
- <tgroup cols="2">
- <colspec colname="Icon" colwidth="1* " />
- <colspec colname="Description" colwidth="3*" />
- <thead>
- <row>
- <entry>Icon</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry align="center">
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/interceptor.gif" format="GIF" />
- </imageobject>
- </mediaobject>
- </entry>
- <entry>Interceptor</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
</section>
\ No newline at end of file
diff --git a/helps/apacheds.help/src/main/docbook/1.3.6_configuration_editor_repl.xml b/helps/apacheds.help/src/main/docbook/1.3.6_configuration_editor_repl.xml
index 7fbcf2b..0699c4b 100644
--- a/helps/apacheds.help/src/main/docbook/1.3.6_configuration_editor_repl.xml
+++ b/helps/apacheds.help/src/main/docbook/1.3.6_configuration_editor_repl.xml
@@ -20,19 +20,19 @@
<title>Replication Page</title>
<para>
The
- <emphasis role="strong">Extended Operations Page</emphasis>
- of the Configuration Editor allows you to edit the server
- extended operations.
+ <emphasis role="strong">Replication</emphasis>
+ of the configuration editor allows you to setup replication consumers.
+ See also RFC 4533 for a detailed description of the parameters.
</para>
<para>
Here's what the
- <emphasis role="strong">Extended Operations Page</emphasis>
+ <emphasis role="strong">Replication Page</emphasis>
looks like:
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_extended_operations.png"
+ fileref="images/gettingstarted/editor_2.0.0_replication.png"
format="PNG" />
</imageobject>
</mediaobject>
@@ -40,92 +40,56 @@
</para>
<para>The page is divided vertically in two parts.</para>
<para>
- You can choose the orientation of the page by clicking on the
- appropriate button ("Horizontal Orientation"
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/horizontal_orientation.gif"
- format="GIF" />
- </imageobject>
- or "Vertical Orientation"
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/vertical_orientation.gif"
- format="GIF" />
- </imageobject>
- ) at the right of the page.
+ The left side of the page shows the replication consumers defined
+ on the server. This is where you can add or delete an replication consumer.
</para>
<para>
- The left side of the page shows the extended operations defined
- on the server. This is where you can add or delete an extended
- operation.
- </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_extended_operations_list.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>
- The right side of the page display and lets you see the details
- of the selected extended operation in the left side.
+ The right side of the page display and lets you edit the details
+ of the selected replication consumer in the left side.
</para>
- <simplesect id="configuration_editor_1.5.7_extended_operation_details">
- <title>Extended Operation details</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/editor_1.5.7_extended_operations_details.png"
- format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <simplesect id="configuration_editor_2.0.0_replication_consumer_details">
+ <title>Replication Consumer Details</title>
<para>
- The
- <emphasis role="strong">Name</emphasis>
- field displays the name of the extended operation.
+ Check the
+ <emphasis role="strong">Enabled</emphasis>
+ checkbox to enable the replication consumer.
</para>
<para>
- The
+ An
+ <emphasis role="strong">ID</emphasis>
+ is mandatory for the replication consumer.
+ </para>
+ <para>
+ An
<emphasis role="strong">Description</emphasis>
- field displays the description of the extended operation.
+ is optional for the replication consumer.
</para>
</simplesect>
- <para></para>
- <para>
- The following icons can appear in the Extended Operations Page.
- </para>
- <para>
- <informaltable>
- <tgroup cols="2">
- <colspec colname="Icon" colwidth="1* " />
- <colspec colname="Description" colwidth="3*" />
- <thead>
- <row>
- <entry>Icon</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry align="center">
- <mediaobject>
- <imageobject>
- <imagedata scale="50"
- fileref="images/gettingstarted/extended_operation.gif"
- format="GIF" />
- </imageobject>
- </mediaobject>
- </entry>
- <entry>Extended Operation</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+
+ <simplesect id="configuration_editor_2.0.0_replication_connection">
+ <title>Connection</title>
+ <para>
+ <emphasis role="strong">Replication Mode</emphasis>
+ defines the replication mode to use.
+ One of the following options can be chosen:
+ <itemizedlist spacing="normal" mark="bullet">
+ <listitem>Refresh And Persist - Push based replication using persisten search</listitem>
+ <listitem>Refresh Only - Poll based replication</listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ The reminder of the section allows to configure the connection parameters
+ to the replication provider.
+ </para>
+ </simplesect>
+
+ <simplesect id="configuration_editor_2.0.0_replication_configuration">
+ <title>Configuration</title>
+ <para>
+ The configuration section allows to define the search parameters
+ for the entries to replicate.
+ </para>
+ </simplesect>
+
</section>
\ No newline at end of file
diff --git a/helps/apacheds.help/src/main/docbook/1.3_configuration_editor.xml b/helps/apacheds.help/src/main/docbook/1.3_configuration_editor.xml
index 6692598..8680094 100644
--- a/helps/apacheds.help/src/main/docbook/1.3_configuration_editor.xml
+++ b/helps/apacheds.help/src/main/docbook/1.3_configuration_editor.xml
@@ -20,7 +20,7 @@
<title>Apache DS Configuration Editor</title>
<para>
The Configuration Editor for Apache DS consists in a six pages
- Editor:
+ editor:
<itemizedlist spacing="normal" mark="bullet">
<listitem>
The
@@ -30,9 +30,7 @@
Overview
</link>
</emphasis>
- page allows you to set general settings about the
- server such as enabling/disabling protocols, setting
- protocols ports, limits, etc...
+ gives you a quick overview about enabled protocols, ports, and configured partitions.
</listitem>
<listitem>
The
@@ -49,7 +47,7 @@
<emphasis>
<link
linkend="gettingstarted_configuration_editor_kerberos_server">
- LDAP/LDAPS Servers
+ Kerberos Server
</link>
</emphasis>
page allows you to configure the Kerberos server.
diff --git a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general.png b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general.png
deleted file mode 100644
index 27a9235..0000000
Binary files a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general.png and /dev/null differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_limits.png b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_limits.png
deleted file mode 100644
index 63af775..0000000
Binary files a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_limits.png and /dev/null differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_options.png b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_options.png
deleted file mode 100644
index ec0e384..0000000
Binary files a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_options.png and /dev/null differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_protocols.png b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_protocols.png
deleted file mode 100644
index b5e0aac..0000000
Binary files a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_1.5.7_general_protocols.png and /dev/null differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_kerberos_server.png b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_kerberos_server.png
new file mode 100644
index 0000000..946adad
Binary files /dev/null and b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_kerberos_server.png differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_ldap_servers.png b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_ldap_servers.png
new file mode 100644
index 0000000..6911659
Binary files /dev/null and b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_ldap_servers.png differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_overview.png b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_overview.png
new file mode 100644
index 0000000..b1cbbc7
Binary files /dev/null and b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_overview.png differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_partitions.png b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_partitions.png
new file mode 100644
index 0000000..da9f8f1
Binary files /dev/null and b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_partitions.png differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_passwordpolicies.png b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_passwordpolicies.png
new file mode 100644
index 0000000..a13d81b
Binary files /dev/null and b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_passwordpolicies.png differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_replication.png b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_replication.png
new file mode 100644
index 0000000..e8de026
Binary files /dev/null and b/helps/apacheds.help/src/main/resources/html/images/gettingstarted/editor_2.0.0_replication.png differ
[directory-studio] 03/03: Fix typos and layout
Posted by se...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
seelmann pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-studio.git
commit 532bb663de5069e28ec0e4f38bf7f81e08036e01
Author: Stefan Seelmann <ma...@stefan-seelmann.de>
AuthorDate: Wed Apr 8 23:00:15 2020 +0200
Fix typos and layout
---
.../configuration/editor/LdapLdapsServersPage.java | 2 +-
.../configuration/editor/PasswordPolicyDetailsPage.java | 14 +++++++-------
.../configuration/editor/ReplicationDetailsPage.java | 2 +-
3 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/LdapLdapsServersPage.java b/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/LdapLdapsServersPage.java
index 467049b..721190a 100644
--- a/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/LdapLdapsServersPage.java
+++ b/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/LdapLdapsServersPage.java
@@ -1066,9 +1066,9 @@ public class LdapLdapsServersPage extends ServerConfigurationEditorPage
createLimitsSection( toolkit, leftComposite );
createSslStartTlsKeystoreSection( toolkit, leftComposite );
createSslAdvancedSettingsSection( toolkit, leftComposite );
- createAdvancedSection( toolkit, leftComposite );
createSupportedAuthenticationMechanismsSection( toolkit, rightComposite );
createSaslSettingsSection( toolkit, rightComposite );
+ createAdvancedSection( toolkit, rightComposite );
// Refreshing the UI
refreshUI();
diff --git a/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/PasswordPolicyDetailsPage.java b/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/PasswordPolicyDetailsPage.java
index f41f22b..4cbcd5f 100644
--- a/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/PasswordPolicyDetailsPage.java
+++ b/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/PasswordPolicyDetailsPage.java
@@ -412,11 +412,11 @@ public class PasswordPolicyDetailsPage implements IDetailsPage
validatorText.setLayoutData( new GridData( SWT.FILL, SWT.CENTER, true, false ) );
// Minimum Length (pwdMinLength)
- minimumLengthCheckbox = toolkit.createButton( composite, "Enable Mimimum Length", SWT.CHECK );
+ minimumLengthCheckbox = toolkit.createButton( composite, "Enable Minimum Length", SWT.CHECK );
minimumLengthCheckbox.setLayoutData( new GridData( SWT.BEGINNING, SWT.CENTER, false, false, 2, 1 ) );
- Composite mimimumLengthRadioIndentComposite = createRadioIndentComposite( toolkit, composite,
+ Composite minimumLengthRadioIndentComposite = createRadioIndentComposite( toolkit, composite,
"Number of characters:" );
- minimumLengthText = toolkit.createText( mimimumLengthRadioIndentComposite, "" );
+ minimumLengthText = toolkit.createText( minimumLengthRadioIndentComposite, "" );
minimumLengthText.setLayoutData( new GridData( SWT.FILL, SWT.CENTER, true, false ) );
// Maximum Length (pwdMaxLength)
@@ -452,7 +452,7 @@ public class PasswordPolicyDetailsPage implements IDetailsPage
section.setClient( composite );
// Minimum Age (pwdMinAge)
- toolkit.createLabel( composite, "Mimimum Age (seconds):" );
+ toolkit.createLabel( composite, "Minimum Age (seconds):" );
minimumAgeText = toolkit.createText( composite, "" );
minimumAgeText.setLayoutData( new GridData( SWT.FILL, SWT.CENTER, true, false ) );
@@ -582,7 +582,7 @@ public class PasswordPolicyDetailsPage implements IDetailsPage
inHistoryText.setLayoutData( new GridData( SWT.FILL, SWT.CENTER, true, false ) );
// Minimum delay (pwdMinDelay)
- toolkit.createLabel( composite, "Mimimum Delay (seconds):" );
+ toolkit.createLabel( composite, "Minimum Delay (seconds):" );
minimumDelayText = toolkit.createText( composite, "" );
minimumDelayText.setLayoutData( new GridData( SWT.FILL, SWT.CENTER, true, false ) );
@@ -777,7 +777,7 @@ public class PasswordPolicyDetailsPage implements IDetailsPage
passwordPolicy
.setPwdValidator( ServerConfigurationEditorUtils.checkEmptyString( validatorText.getText() ) );
- // Miminum Length
+ // Mininum Length
if ( minimumLengthCheckbox.getSelection() )
{
try
@@ -1066,7 +1066,7 @@ public class PasswordPolicyDetailsPage implements IDetailsPage
// Validator
validatorText.setText( ServerConfigurationEditorUtils.checkNull( passwordPolicy.getPwdValidator() ) );
- // Miminum Length
+ // Mininum Length
int minimumLength = passwordPolicy.getPwdMinLength();
minimumLengthCheckbox.setSelection( minimumLength != 0 );
minimumLengthText.setText( "" + minimumLength );
diff --git a/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/ReplicationDetailsPage.java b/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/ReplicationDetailsPage.java
index 849e756..54fd4ea 100644
--- a/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/ReplicationDetailsPage.java
+++ b/plugins/apacheds.configuration/src/main/java/org/apache/directory/studio/apacheds/configuration/editor/ReplicationDetailsPage.java
@@ -403,7 +403,7 @@ public class ReplicationDetailsPage implements IDetailsPage
{
Section section = toolkit.createSection( parent, Section.DESCRIPTION | Section.TITLE_BAR );
section.marginWidth = 10;
- section.setText( "Replication Consumer Details" );
+ section.setText( "Configuration" );
section.setDescription( "Set the properties of the configuration." );
TableWrapData td = new TableWrapData( TableWrapData.FILL, TableWrapData.TOP );
td.grabHorizontal = true;
[directory-studio] 01/03: DIRSTUDIO-1124: Update basic LDAP server
view doc
Posted by se...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
seelmann pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-studio.git
commit d84d44a7a558b45a1158ad1513e879f7c1493852
Author: Stefan Seelmann <ma...@stefan-seelmann.de>
AuthorDate: Sun Apr 5 16:41:11 2020 +0200
DIRSTUDIO-1124: Update basic LDAP server view doc
---
helps/apacheds.help/src/main/docbook/0_index.xml | 2 +-
.../src/main/docbook/1.1_download_install.xml | 3 +-
..._servers_view.xml => 1.2_ldap_servers_view.xml} | 101 +++++++++++++++++----
.../src/main/docbook/1_gettingstarted.xml | 2 +-
.../src/main/docbook/2.1_creating_new_server.xml | 18 +++-
.../resources/html/images/icons_connection_add.gif | Bin 0 -> 585 bytes
.../html/images/tasks_new_server_wizard.png | Bin 12315 -> 28973 bytes
.../resources/html/images/views_ldap_servers.png | Bin 0 -> 8503 bytes
.../resources/html/images/views_servers-view.png | Bin 7577 -> 0 bytes
9 files changed, 101 insertions(+), 25 deletions(-)
diff --git a/helps/apacheds.help/src/main/docbook/0_index.xml b/helps/apacheds.help/src/main/docbook/0_index.xml
index ef53b49..8adf5c0 100644
--- a/helps/apacheds.help/src/main/docbook/0_index.xml
+++ b/helps/apacheds.help/src/main/docbook/0_index.xml
@@ -3,7 +3,7 @@
<!ENTITY gettingstarted SYSTEM "1_gettingstarted.xml">
<!ENTITY gettingstarted_download_install SYSTEM "1.1_download_install.xml">
- <!ENTITY gettingstarted_servers_view SYSTEM "1.2_servers_view.xml">
+ <!ENTITY gettingstarted_ldap_servers_view SYSTEM "1.2_ldap_servers_view.xml">
<!ENTITY gettingstarted_configuration_editor SYSTEM "1.3_configuration_editor.xml">
<!ENTITY gettingstarted_configuration_editor_overview SYSTEM "1.3.1_configuration_editor_overview.xml">
<!ENTITY gettingstarted_configuration_editor_ldap_server SYSTEM "1.3.2_configuration_editor_ldap_server.xml">
diff --git a/helps/apacheds.help/src/main/docbook/1.1_download_install.xml b/helps/apacheds.help/src/main/docbook/1.1_download_install.xml
index d8e1628..39e77cb 100644
--- a/helps/apacheds.help/src/main/docbook/1.1_download_install.xml
+++ b/helps/apacheds.help/src/main/docbook/1.1_download_install.xml
@@ -20,8 +20,7 @@
<title>Download and installation</title>
<para>
The latest version of Apache Directory Studio can be downloaded
- from the Apache Directory Studio Downloads page, at this address
- :
+ from the Apache Directory Studio Downloads page, at this address:
<ulink
url="https://directory.apache.org/studio/downloads.html">
https://directory.apache.org/studio/downloads.html
diff --git a/helps/apacheds.help/src/main/docbook/1.2_servers_view.xml b/helps/apacheds.help/src/main/docbook/1.2_ldap_servers_view.xml
similarity index 65%
rename from helps/apacheds.help/src/main/docbook/1.2_servers_view.xml
rename to helps/apacheds.help/src/main/docbook/1.2_ldap_servers_view.xml
index 4f7f82d..593e982 100644
--- a/helps/apacheds.help/src/main/docbook/1.2_servers_view.xml
+++ b/helps/apacheds.help/src/main/docbook/1.2_ldap_servers_view.xml
@@ -16,39 +16,41 @@
specific language governing permissions and limitations
under the License.
-->
-<section id="gettingstarted_servers_view">
+<section id="gettingstarted_ldapservers_view">
<title>LDAP Servers View</title>
<para>
- The Servers view allows you to manage the servers. This view
+ The LDAP Servers view allows you to manage the servers. This view
displays a list of all your servers. You can use this view to
start or stop the servers.
</para>
<para>
- Here is what the Servers view looks like:
+ Here is an example screenshot of the LDAP Servers view:
<screenshot>
<mediaobject>
- <imageobject>
+ j<imageobject>
<imagedata scale="50"
- fileref="images/views_servers-view.png"
+ fileref="images/views_ldap_servers.png"
format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
- Use the Servers view to perform the following tasks:
+ Use the LDAP Servers view to perform the following tasks:
<itemizedlist spacing="normal" mark="bullet">
<listitem>Create a server</listitem>
- <listitem>Edit a server</listitem>
- <listitem>Delete a server</listitem>
+ <listitem>Rename a server</listitem>
+ <listitem>Configure a server</listitem>
<listitem>Start a server</listitem>
+ <listitem>Create a connection to the server</listitem>
<listitem>Stop a server</listitem>
+ <listitem>Delete a server</listitem>
</itemizedlist>
</para>
<para>
- The Servers view displays the current status of all the servers.
+ The LDAP Servers view displays the current status of all the servers.
The
- <emphasis role="strong">Status</emphasis>
+ <emphasis role="strong">State</emphasis>
column indicates whether or not a server has been started. The
following lists the possible server status:
<itemizedlist spacing="normal" mark="bullet">
@@ -62,7 +64,42 @@
<emphasis role="strong">Toolbar</emphasis>
</para>
<para>
- The toolbar of the Servers view contains the following actions:
+ The toolbar of the LDAP Servers view contains the following actions:
+ <itemizedlist spacing="normal" mark="bullet">
+ <listitem>
+ <imageobject>
+ <imagedata scale="50"
+ fileref="images/icons_server_new.gif" format="GIF" />
+ </imageobject>
+ -
+ <emphasis>New server</emphasis>
+ : Creates a new LDAP server.
+ </listitem>
+ <listitem>
+ <imageobject>
+ <imagedata scale="50"
+ fileref="images/icons_run.gif" format="GIF" />
+ </imageobject>
+ -
+ <emphasis>Run</emphasis>
+ : Starts the selected LDAP server.
+ </listitem>
+ <listitem>
+ <imageobject>
+ <imagedata scale="50"
+ fileref="images/icons_stop.gif" format="GIF" />
+ </imageobject>
+ -
+ <emphasis>Stop</emphasis>
+ : Stops the selected LDAP server.
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ <emphasis role="strong">Context Menu</emphasis>
+ </para>
+ <para>
+ The context menu of the LDAP Servers view contains the following actions:
<itemizedlist spacing="normal" mark="bullet">
<listitem>
<imageobject>
@@ -70,8 +107,25 @@
fileref="images/icons_server_new.gif" format="GIF" />
</imageobject>
-
- <emphasis>Create a new server</emphasis>
- : Creates a new server.
+ <emphasis>New Server</emphasis>
+ : Creates a new LDAP server.
+ </listitem>
+ <listitem>
+ <emphasis>Open Configuration</emphasis>
+ : Opens the configuration editor.
+ </listitem>
+ <listitem>
+ <imageobject>
+ <imagedata scale="50"
+ fileref="images/icons_delete.gif" format="GIF" />
+ </imageobject>
+ -
+ <emphasis>Delete</emphasis>
+ : Deletes the selected LDAP server.
+ </listitem>
+ <listitem>
+ <emphasis>Rename...</emphasis>
+ : Renames the selected LDAP server.
</listitem>
<listitem>
<imageobject>
@@ -80,7 +134,7 @@
</imageobject>
-
<emphasis>Run</emphasis>
- : Starts the selected server.
+ : Starts the selected LDAP server.
</listitem>
<listitem>
<imageobject>
@@ -89,14 +143,29 @@
</imageobject>
-
<emphasis>Stop</emphasis>
- : Stops the selected server.
+ : Stops the selected LDAP server.
+ </listitem>
+ <listitem>
+ <imageobject>
+ <imagedata scale="50"
+ fileref="images/icons_connection_add.gif" format="GIF" />
+ </imageobject>
+ -
+ <emphasis>Create a Connection</emphasis>
+ : Creates a preconfigured connection to the selected LDAP server.
+ </listitem>
+ <listitem>
+ <emphasis>Properties</emphasis>
+ : Opens the properties dialog of the selected LDAP server which shows details like version and the path the to configuration folder.
</listitem>
</itemizedlist>
</para>
+
+
<para>
<emphasis role="strong">Icons</emphasis>
</para>
- <para>The following icons can appear in the Hierarchy view:</para>
+ <para>The following icons can appear in the LDAP Servers view:</para>
<para>
<informaltable>
<tgroup cols="2">
diff --git a/helps/apacheds.help/src/main/docbook/1_gettingstarted.xml b/helps/apacheds.help/src/main/docbook/1_gettingstarted.xml
index 064d55c..48652f4 100644
--- a/helps/apacheds.help/src/main/docbook/1_gettingstarted.xml
+++ b/helps/apacheds.help/src/main/docbook/1_gettingstarted.xml
@@ -24,7 +24,7 @@
</para>
&gettingstarted_download_install;
- &gettingstarted_servers_view;
+ &gettingstarted_ldap_servers_view;
&gettingstarted_configuration_editor;
</chapter>
\ No newline at end of file
diff --git a/helps/apacheds.help/src/main/docbook/2.1_creating_new_server.xml b/helps/apacheds.help/src/main/docbook/2.1_creating_new_server.xml
index 81b2bf7..b712555 100644
--- a/helps/apacheds.help/src/main/docbook/2.1_creating_new_server.xml
+++ b/helps/apacheds.help/src/main/docbook/2.1_creating_new_server.xml
@@ -17,9 +17,9 @@
under the License.
-->
<section id="tasks_creating_new_server">
- <title>Creating a new server</title>
+ <title>Creating a new LDAP server</title>
<para>
- To create a new server, in the Servers view toolbar, click on
+ To create a new LDAP server, in the Servers view toolbar, click on
the
<imageobject>
<imagedata scale="50"
@@ -57,10 +57,18 @@
</thead>
<tbody>
<row>
- <entry>Name</entry>
+ <entry>Server Type</entry>
<entry>
- The name of the server. In the Servers view
- the server is listed with this name. The
+ The type of the LDAP server. Currently only the
+ Apache Directory Server (ApacheDS) is available.
+ </entry>
+ <entry>empty</entry>
+ </row>
+ <row>
+ <entry>Server Name</entry>
+ <entry>
+ The name of the LDAP server. In the LDAP Servers
+ view the server is listed with this name. The
name must be unique.
</entry>
<entry>empty</entry>
diff --git a/helps/apacheds.help/src/main/resources/html/images/icons_connection_add.gif b/helps/apacheds.help/src/main/resources/html/images/icons_connection_add.gif
new file mode 100644
index 0000000..ea1b9c6
Binary files /dev/null and b/helps/apacheds.help/src/main/resources/html/images/icons_connection_add.gif differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/tasks_new_server_wizard.png b/helps/apacheds.help/src/main/resources/html/images/tasks_new_server_wizard.png
index 0ced85c..172a2f8 100644
Binary files a/helps/apacheds.help/src/main/resources/html/images/tasks_new_server_wizard.png and b/helps/apacheds.help/src/main/resources/html/images/tasks_new_server_wizard.png differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/views_ldap_servers.png b/helps/apacheds.help/src/main/resources/html/images/views_ldap_servers.png
new file mode 100644
index 0000000..65d1d4c
Binary files /dev/null and b/helps/apacheds.help/src/main/resources/html/images/views_ldap_servers.png differ
diff --git a/helps/apacheds.help/src/main/resources/html/images/views_servers-view.png b/helps/apacheds.help/src/main/resources/html/images/views_servers-view.png
deleted file mode 100644
index c56d3e8..0000000
Binary files a/helps/apacheds.help/src/main/resources/html/images/views_servers-view.png and /dev/null differ