You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2012/10/29 14:44:47 UTC
svn commit: r1403287 - in /directory/site/trunk/content/apacheds: ./
basic-ug/ basic-ug/images/
Author: elecharny
Date: Mon Oct 29 13:44:46 2012
New Revision: 1403287
URL: http://svn.apache.org/viewvc?rev=1403287&view=rev
Log:
Added some pages o the Basic Configuration part
Added:
directory/site/trunk/content/apacheds/basic-ug/1.4-basic-configuration-tasks.mdtext
directory/site/trunk/content/apacheds/basic-ug/1.4.1-changing-server-port.mdtext
directory/site/trunk/content/apacheds/basic-ug/images/studio-port-config1.png (with props)
directory/site/trunk/content/apacheds/basic-ug/images/studio-port-config2.png (with props)
Modified:
directory/site/trunk/content/apacheds/basic-ug/1-how-to-begin.mdtext
directory/site/trunk/content/apacheds/basic-ug/1.1-what-apacheds-is.mdtext
directory/site/trunk/content/apacheds/basic-ug/1.2-some-background.mdtext
directory/site/trunk/content/apacheds/basic-ug/1.3-installing-and-starting.mdtext
directory/site/trunk/content/apacheds/basic-users-guide.mdtext
Modified: directory/site/trunk/content/apacheds/basic-ug/1-how-to-begin.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/1-how-to-begin.mdtext?rev=1403287&r1=1403286&r2=1403287&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/basic-ug/1-how-to-begin.mdtext (original)
+++ directory/site/trunk/content/apacheds/basic-ug/1-how-to-begin.mdtext Mon Oct 29 13:44:46 2012
@@ -19,30 +19,24 @@ Notice: Licensed to the Apache Software
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-
-<DIV class="note" markdown="1">
-**Work in progress**
-This site is in the process of being reviewed and updated.
-</DIV>
+### 1 - How to begin
-### 1. How to begin
-
-* 1\. [How to begin](1-how-to-begin.html)
- * 1\.1. [What Apache Directory Server is](1.1-what-apacheds-is.html)
- * 1\.2. [Some Background. Directories, directory services and LDAP](basic-ug/1.2-some-background.html)
- * 1\.3. [Installing and starting the server](basic-ug/1.3-installing-and-starting.html)
- * 1\.4. Basic configuration tasks
- * 1\.4.1. Changing the server port for LDAP
- * 1\.4.2. Changing the admin password
- * 1\.4.3. Adding your own partition resp. suffix
- * 1\.4.4. Configure logging
- * 1\.4.5. Enable and disable anonymous access
- * 1\.5 About the sample configurations and sample directory data
-* 2\. Handling of data within your directory
-* 3\. Basic Security
- * 3\.1. Authentication options
- * 3\.2. Basic authorization
- * 3\.3. How to enable SSL
-* 4\. Integrating ApacheDS with other programs
- * 4\.1 Mozilla Thunderbird
+* [1 - How to begin](1-how-to-begin.html)
+ * [1.1 - What Apache Directory Server is](1.1-what-apacheds-is.html)
+ * [1.2 - Some Background. Directories, directory services and LDAP](basic-ug/1.2-some-background.html)
+ * [1.3 - Installing and starting the server](basic-ug/1.3-installing-and-starting.html)
+ * [1.4 - Basic configuration tasks](basic-ug/1.4-basic-configuration-tasks.html)
+ * [1.4.1 - Changing the server port for LDAP](basic-ug/1.4.1-changing-server-port.html)
+ * [1.4.2 - Changing the admin password](basic-ug/1.4.2-changing-admin-password.html)
+ * [1.4.3 - Adding your own partition resp. suffix](basic-ug/1.4.3-adding-partition.html)
+ * [1.4.4 - Configure logging](basic-ug/1.4.4-configure-logging.html)
+ * [1.4.5 - Enable and disable anonymous access](basic-ug/1.4.5-anonymous-access.html)
+ * [1.5 - About the sample configurations and sample directory data](basic-ug/1.5-sample-configuration.html)
+* [2 - Handling of data within your directory](basic-ug/2-handling-data.html)
+* [3 - Basic Security](basic-ug/3-basic-security.html)
+ * [3.1 - Authentication options](basic-ug/3.1-authentication-options.html)
+ * [3.2 - Basic authorization](basic-ug/3.2-basic-authorization.html)
+ * [3.3 - How to enable SSL](basic-ug/3.3-enabling-ssl.html)
+* [4 - Integrating ApacheDS with other programs](basic-ug/4-integrating-apacheds.html)
+ * [4.1 - Mozilla Thunderbird](basic-ug/4.1-mozilla-thunderbird.html)
Modified: directory/site/trunk/content/apacheds/basic-ug/1.1-what-apacheds-is.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/1.1-what-apacheds-is.mdtext?rev=1403287&r1=1403286&r2=1403287&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/basic-ug/1.1-what-apacheds-is.mdtext (original)
+++ directory/site/trunk/content/apacheds/basic-ug/1.1-what-apacheds-is.mdtext Mon Oct 29 13:44:46 2012
@@ -1,6 +1,6 @@
Title: 1.1 - What Apache DS is
NavUp: 1-how-to-begin.html
-NavUpText: 1.1 - How to begin
+NavUpText: 1 - How to begin
NavNext: 1.2-some-background.html
NavNextText: 1.2 - Some Background. Directories, directory services and LDAP
Notice: Licensed to the Apache Software Foundation (ASF) under one
Modified: directory/site/trunk/content/apacheds/basic-ug/1.2-some-background.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/1.2-some-background.mdtext?rev=1403287&r1=1403286&r2=1403287&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/basic-ug/1.2-some-background.mdtext (original)
+++ directory/site/trunk/content/apacheds/basic-ug/1.2-some-background.mdtext Mon Oct 29 13:44:46 2012
@@ -2,7 +2,7 @@ Title: 1.2 - Some Background. Directorie
NavPrev: 1.1-what-apacheds-is.html
NavPrevText: 1.1 - What Apache Directory Server is
NavUp: 1-how-to-begin.html
-NavUpText: 1.1 - How to begin
+NavUpText: 1 - How to begin
NavNext: 1.3-installing-and-starting.html
NavNextText: 1.3 - Installing and starting the server
Notice: Licensed to the Apache Software Foundation (ASF) under one
Modified: directory/site/trunk/content/apacheds/basic-ug/1.3-installing-and-starting.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/1.3-installing-and-starting.mdtext?rev=1403287&r1=1403286&r2=1403287&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/basic-ug/1.3-installing-and-starting.mdtext (original)
+++ directory/site/trunk/content/apacheds/basic-ug/1.3-installing-and-starting.mdtext Mon Oct 29 13:44:46 2012
@@ -2,7 +2,7 @@ Title: 1.3 - Installing and starting the
NavPrev: 1.2-some-background.html
NavPrevText: 1.2 - Some Background. Directories, directory services and LDAP
NavUp: 1-how-to-begin.html
-NavUpText: 1.1 - How to begin
+NavUpText: 1 - How to begin
NavNext: 1.4-basic-configuration-tasks.html
NavNextText: 1.4 - Basic configuration tasks
Notice: Licensed to the Apache Software Foundation (ASF) under one
Added: directory/site/trunk/content/apacheds/basic-ug/1.4-basic-configuration-tasks.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/1.4-basic-configuration-tasks.mdtext?rev=1403287&view=auto
==============================================================================
--- directory/site/trunk/content/apacheds/basic-ug/1.4-basic-configuration-tasks.mdtext (added)
+++ directory/site/trunk/content/apacheds/basic-ug/1.4-basic-configuration-tasks.mdtext Mon Oct 29 13:44:46 2012
@@ -0,0 +1,31 @@
+Title: 1.4 - Basic configuration tasks
+NavPrev: 1.3-installing-and-starting.html
+NavPrevText: 1.3 - Installing and starting the server
+NavUp: 1-how-to-begin.html
+NavUpText: 1 - How to begin
+NavNext: 1.5-about-sample-configuration.html
+NavNextText: 1.5. - About the sample configurations and sample directory data
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# 1.4 - Basic configuration tasks
+* [1.4.1 - Changing the server port for LDAP](basic-ug/1.4.1-changing-server-port.html)
+* [1.4.2 - Changing the admin password](basic-ug/1.4.2-changing-admin-password.html)
+* [1.4.3 - Adding your own partition resp. suffix](basic-ug/1.4.3-adding-partition.html)
+* [1.4.4 - Configure logging](basic-ug/1.4.4-configure-logging.html)
+* [1.4.5 - Enable and disable anonymous access](basic-ug/1.4.5-anonymous-access.html)
+
Added: directory/site/trunk/content/apacheds/basic-ug/1.4.1-changing-server-port.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/1.4.1-changing-server-port.mdtext?rev=1403287&view=auto
==============================================================================
--- directory/site/trunk/content/apacheds/basic-ug/1.4.1-changing-server-port.mdtext (added)
+++ directory/site/trunk/content/apacheds/basic-ug/1.4.1-changing-server-port.mdtext Mon Oct 29 13:44:46 2012
@@ -0,0 +1,131 @@
+Title: 1.4.1 - Changing the server port for LDAP
+NavUp: 1.4-basic-configuration-tasks.html
+NavUpText: 1.4 - Basic configuration tasks
+NavNext: 1.4.2-changing-admin-password.html
+NavNextText: 1.4.2 - Changing the admin password
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# 1.4.1 - Changing the server port for LDAP
+
+This section describes how to change to port for the LDAP protocol. There are two ways to do that : either you use the configuration plugin available in **Apache Directory Studio**, or you update the LDIF partition that contains the configuration.
+
+[TOC]
+
+## The task and how to accomplish it
+
+By default the LDAP server listens on port 10389 (unencrypted or StartTLS) and 10636 (SSL). It is quite common to run LDAP on 389, which is the well-known port for this protocol, but that requires the server to be started with a root user (or with sudo). Of course other options are imaginable as well. Changing the LDAP port is a good example for adjusting the existing Spring configuration as introduced in the last section.
+
+<DIV class="note" markdown="1">
+Due to traditional Unix security restrictions, ports less than 1024 were "trusted". Thus on a Unix-System, a non-root process must listen on a port greater than 1023.
+</DIV>
+
+
+Basically, there are two cases :
+* The server is not started
+* The server is started
+
+We will see how to change the port in those two cases.
+
+### Using Apache Directory Studio
+
+#### The server is started
+
+The best solution is to connect on the server using Studio, and to open it's configuration :
+
+<CENTER>
+
+</CENTER>
+
+When you select this menu, you will get the main configuration screen, containing the port for LDAP and LDAPS :
+
+<CENTER>
+
+</CENTER>
+
+
+Now, change the values of _port_ to your needs, then save the configuration. You have to restart the server afterwards in order to take this change into effect.
+
+#### The server is not started
+
+You can start it and update the configuration, of course. But if you want to configure the server when it's stopped, you will have to load the configuration file, which is on _.../instances/default/conf/config.ldif_, when the server has been installed using the default setting.
+
+Opening this file will open the exact same window :
+
+<CENTER>
+
+</CENTER>
+
+You can update the _ports_ and save the file.
+
+<DIV class="warning" markdown="1">
+ Note that you will requite write access on this file !
+</DIV>
+
+### Modifying the configuration LDIF partition
+
+All the **ApacheDS** configuration is stored as a LDIF file, and can be modified either using a text editor (although we don't consider this as a safe practice) or using a Modify request on a running server.
+
+<DIV class="info" markdown="1">
+ Modifying the configuration on a running server will **not** change the listening port of the running server. You will have to relaunch the server in order to get this new configuration to be available.
+</DIV>
+
+
+The configuration is stored as a set of LDAP entries, so you can update one of them. In order to modify the entry containing the ports, you have first to find it, and second to send a valid modify request.
+
+All the **ApacheDS** configuration is stored under the _ou=config_ partition. The ports are stored in some entries under _DN: ldap,ou=transports,ads-serverId=ldapServer,ou=servers,ads-directoryServiceId=default,ou=config_ (obviously, dependning on your installation, this DN might change : the _ads-directoryServiceId_ may have a different name, so is the _ads-serverId_). In any case, the _ou=transports_ branch contains two entries :
+
+for LDAP :
+
+ dn: ads-transportid=ldap,ou=transports,ads-serverId=ldapServer,ou=servers,ad
+ s-directoryServiceId=default,ou=config
+ ads-systemport: 10389
+ ads-enabled: TRUE
+ ads-transportnbthreads: 8
+ ads-transportaddress: 0.0.0.0
+ ads-transportid: ldap
+ objectclass: ads-transport
+ objectclass: ads-tcpTransport
+ objectclass: ads-base
+ objectclass: top
+
+and for LDAPS :
+
+ dn: ads-transportid=ldaps,ou=transports,ads-serverId=ldapServer,ou=servers,a
+ ds-directoryServiceId=default,ou=config
+ ads-systemport: 10636
+ ads-transportenablessl: TRUE
+ ads-enabled: TRUE
+ ads-transportaddress: 0.0.0.0
+ ads-transportid: ldaps
+ objectclass: ads-transport
+ objectclass: ads-tcpTransport
+ objectclass: ads-base
+ objectclass: top
+
+You just have to send a ModifyRequest using such a LDIF :
+
+ dn: ads-transportid=ldaps,ou=transports,ads-serverId=ldapServer,ou=servers,ads
+ -directoryServiceId=default,ou=config
+ changetype: modify
+ replace: ads-systemport
+ ads-systemport: 10637
+ -
+
+(here, we have modified the LDAPS Port from 10636 to 10637)
+
+Those modification can be done directly on the _config.ldif_ file, but you won't have any syntax check if you do so.
\ No newline at end of file
Added: directory/site/trunk/content/apacheds/basic-ug/images/studio-port-config1.png
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/images/studio-port-config1.png?rev=1403287&view=auto
==============================================================================
Binary file - no diff available.
Propchange: directory/site/trunk/content/apacheds/basic-ug/images/studio-port-config1.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/site/trunk/content/apacheds/basic-ug/images/studio-port-config2.png
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/images/studio-port-config2.png?rev=1403287&view=auto
==============================================================================
Binary file - no diff available.
Propchange: directory/site/trunk/content/apacheds/basic-ug/images/studio-port-config2.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: directory/site/trunk/content/apacheds/basic-users-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-users-guide.mdtext?rev=1403287&r1=1403286&r2=1403287&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/basic-users-guide.mdtext (original)
+++ directory/site/trunk/content/apacheds/basic-users-guide.mdtext Mon Oct 29 13:44:46 2012
@@ -40,21 +40,21 @@ We are quite interested to improve the c
## Table of contents
-* 1\. [How to begin](basic-ug/1-how-to-begin.html)
- * 1\.1. [What Apache Directory Server is](basic-ug/1.1-what-apacheds-is.html)
- * 1\.2. [Some Background. Directories, directory services and LDAP](basic-ug/1.2-some-background.html)
- * 1\.3. [Installing and starting the server](basic-ug/1.3-installing-and-starting.html)
- * 1\.4. Basic configuration tasks
- * 1\.4.1. Changing the server port for LDAP
- * 1\.4.2. Changing the admin password
- * 1\.4.3. Adding your own partition resp. suffix
- * 1\.4.4. Configure logging
- * 1\.4.5. Enable and disable anonymous access
- * 1\.5 About the sample configurations and sample directory data
-* 2\. Handling of data within your directory
-* 3\. Basic Security
- * 3\.1. Authentication options
- * 3\.2. Basic authorization
- * 3\.3. How to enable SSL
-* 4\. Integrating ApacheDS with other programs
- * 4\.1 Mozilla Thunderbird
+* [1 - How to begin](1-how-to-begin.html)
+ * [1.1 - What Apache Directory Server is](1.1-what-apacheds-is.html)
+ * [1.2 - Some Background. Directories, directory services and LDAP](basic-ug/1.2-some-background.html)
+ * [1.3 - Installing and starting the server](basic-ug/1.3-installing-and-starting.html)
+ * [1.4 - Basic configuration tasks](basic-ug/1.4-basic-configuration-tasks.html)
+ * [1.4.1 - Changing the server port for LDAP](basic-ug/1.4.1-changing-server-port.html)
+ * [1.4.2 - Changing the admin password](basic-ug/1.4.2-changing-admin-password.html)
+ * [1.4.3 - Adding your own partition resp. suffix](basic-ug/1.4.3-adding-partition.html)
+ * [1.4.4 - Configure logging](basic-ug/1.4.4-configure-logging.html)
+ * [1.4.5 - Enable and disable anonymous access](basic-ug/1.4.5-anonymous-access.html)
+ * [1.5 - About the sample configurations and sample directory data](basic-ug/1.5-sample-configuration.html)
+* [2 - Handling of data within your directory](basic-ug/2-handling-data.html)
+* [3 - Basic Security](basic-ug/3-basic-security.html)
+ * [3.1 - Authentication options](basic-ug/3.1-authentication-options.html)
+ * [3.2 - Basic authorization](basic-ug/3.2-basic-authorization.html)
+ * [3.3 - How to enable SSL](basic-ug/3.3-enabling-ssl.html)
+* [4 - Integrating ApacheDS with other programs](basic-ug/4-integrating-apacheds.html)
+ * [4.1 - Mozilla Thunderbird](basic-ug/4.1-mozilla-thunderbird.html)