| | |
| | | ! CCPL HEADER END |
| | | ! |
| | | ! Copyright 2011 ForgeRock AS |
| | | ! |
| | | ! |
| | | --> |
| | | <preface xml:id='preface' |
| | | <preface xml:id='preface' |
| | | 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'> |
| | | <title>Preface</title> |
| | | |
| | | |
| | | <para>This guide shows you how to install, upgrade, and remove OpenDJ |
| | | software. Unless you are planning a throwaway evaluation or test |
| | | installation, read the <citetitle>Release Notes</citetitle> before |
| | | you get started.</para> |
| | | |
| | | |
| | | <para>If you want only to try OpenDJ server software, and you |
| | | do not plan to store any real or important data that you want to keep, |
| | | then you need not read this guide right now. Instead, visit the <link |
| | | xlink:href='http://www.forgerock.com/downloads-opendj.html' |
| | | xlink:href='http://www.forgerock.org/opendj.html' |
| | | >download page</link>, and click the link for the latest release to |
| | | start the Java WebStart installer wizard directly from your browser.</para> |
| | | |
| | | <section> |
| | | <title>Who Should Read this Guide</title> |
| | | |
| | | |
| | | <para>This guide is written for anyone installing OpenDJ who plans to |
| | | maintain directory services for client applications. Basic OpenDJ |
| | | installation, especially using Java WebStart, can be simple and |
| | |
| | | failure that can cause downtime requires at least a little thought |
| | | and planning. Also, even in the case of basic installation, you may |
| | | find yourself wanting more background about what you are doing.</para> |
| | | |
| | | |
| | | <para>This guide covers the install, upgrade, and removal (a.k.a. uninstall) |
| | | procedures that you theoretically perform only once per version. This guide |
| | | aims to provide you with at least some idea of what happens behind the |
| | | scenes when you perform the steps.</para> |
| | | |
| | | |
| | | <para>You do not need to be an LDAP wizard to learn something from this |
| | | guide, though a background in directory services and maintaining server |
| | | software can help. You do need some background in managing servers and |
| | | services on your operating system of choice. You can nevertheless get |
| | | started with this guide, and then learn more as you go along.</para> |
| | | started with this guide, and then learn more as you go along.</para> |
| | | </section> |
| | | |
| | | <section> |
| | |
| | | |
| | | <section> |
| | | <title>Formatting Conventions</title> |
| | | |
| | | |
| | | <note><para>Pay attention to notes like this one.</para></note> |
| | | |
| | | |
| | | <para>Some items might be formatted differently from other text, like |
| | | <filename>filenames</filename>, <command>commands</command>, and |
| | | <literal>literal values</literal>.</para> |
| | | |
| | | |
| | | <screen>$ echo Terminal sessions are formatted like this. |
| | | Terminal sessions are formatted like this.</screen> |
| | | |
| | |
| | | |
| | | } |
| | | }</programlisting> |
| | | |
| | | |
| | | <para>In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD, |
| | | and so forth are marked (UNIX). Sections pertaining to Microsoft Windows |
| | | might be marked (Windows). To avoid repetition, however, file system |
| | |
| | | |
| | | <section> |
| | | <title>Accessing OpenDJ Documentation Online</title> |
| | | |
| | | |
| | | <para>Core documentation, such as what you are now reading, aims to |
| | | be technically accurate and complete with respect to the software |
| | | documented. Core documentation therefore follows a <link |
| | |
| | | >three-phase review process</link> designed to eliminate errors. The |
| | | review process should slow authors down enough that documentation you get |
| | | with a stable release has had time to bake fully.</para> |
| | | |
| | | |
| | | <!-- TODO: online location of core documentation, perhaps docs.forgerock.org? --> |
| | | <para>Fully baked core documentation is available at <link |
| | | xlink:href='http://...'>...</link>.</para> |
| | | |
| | | |
| | | <para>You need not wait until the core documentation is finished, though, |
| | | to read more about OpenDJ, and also to read about related topics that |
| | | involve OpenDJ without being strictly about OpenDJ. The <link |
| | |
| | | you are welcome to <link |
| | | xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register' |
| | | >sign up</link> and then edit the Wiki if you notice an error, or if you |
| | | have something to share.</para> |
| | | have something to share.</para> |
| | | </section> |
| | | |
| | | <section> |
| | | <title>Joining the OpenDJ Community</title> |
| | | |
| | | |
| | | <para>After you <link |
| | | xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register' |
| | | >sign up</link> at ForgeRock, you can also login to the Wiki and the issue |
| | | database to follow what is happening with the project.</para> |
| | | |
| | | |
| | | <para>If you have questions regarding OpenDJ which are not answered by the |
| | | documentation, there is a mailing list which can be found at |
| | | <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj' |
| | | >https://lists.forgerock.org/mailman/listinfo/opendj</link> where you are |
| | | likely to find an answer.</para> |
| | | |
| | | |
| | | <para>You can join the IRC discussion in the #opendj room at |
| | | irc.freenode.net.</para> |
| | | |
| | | |
| | | <para>The Wiki has information on how to check out OpenDJ source code. |
| | | There is also a mailing list for OpenDJ development which can be found at |
| | | <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj-dev' |
| | | >https://lists.forgerock.org/mailman/listinfo/opendj-dev</link> |
| | | Should you want to contribute a patch, test, or feature, or want to author |
| | | part of the core documentation, first have a look on the ForgeRock site |
| | | at <link xlink:href='http://www.forgerock.com/fcpa-faq.html'>how to get |
| | | involved</link>.</para> |
| | | part of the core documentation, first have a look on the ForgeRock Community |
| | | page at <link xlink:href='http://www.forgerock.org/community_process.html'> |
| | | how to get involved</link>.</para> |
| | | </section> |
| | | |
| | | </preface> |