7321N/A<?xml version="1.0" encoding="UTF-8"?>
7321N/A<!--
7321N/A ! CCPL HEADER START
7321N/A !
7321N/A ! This work is licensed under the Creative Commons
7321N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
7321N/A ! To view a copy of this license, visit
7321N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
7321N/A ! or send a letter to Creative Commons, 444 Castro Street,
7321N/A ! Suite 900, Mountain View, California, 94041, USA.
7321N/A !
7321N/A ! You can also obtain a copy of the license at
7321N/A ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
7321N/A ! See the License for the specific language governing permissions
7321N/A ! and limitations under the License.
7321N/A !
7321N/A ! If applicable, add the following below this CCPL HEADER, with the fields
7321N/A ! enclosed by brackets "[]" replaced with your own identifying information:
7321N/A ! Portions Copyright [yyyy] [name of copyright owner]
7321N/A !
7321N/A ! CCPL HEADER END
7321N/A !
7321N/A ! Copyright 2011-2015 ForgeRock AS.
7321N/A !
7321N/A-->
7321N/A<appendix xml:id='appendix-file-layout'
7321N/A xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
7321N/A xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
7321N/A xsi:schemaLocation='http://docbook.org/ns/docbook
7321N/A http://docbook.org/xml/5.0/xsd/docbook.xsd'>
7321N/A <title>File Layout</title>
7321N/A
7321N/A <para>
7321N/A OpenDJ software installs and creates the following files and directories.
7321N/A The following list is not meant to be exhaustive.
7321N/A </para>
7321N/A <indexterm><primary>File layout</primary></indexterm>
7321N/A <indexterm><primary>Installed files</primary></indexterm>
7321N/A <variablelist>
7321N/A <varlistentry>
7321N/A <term><filename>Legal</filename></term>
7321N/A <listitem>
7321N/A <para>
7321N/A License information
7321N/A </para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>QuickSetup.app</filename></term>
7321N/A <listitem>
7321N/A <para>Mac OS X GUI for installing OpenDJ</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>README</filename></term>
7321N/A <listitem>
7321N/A <para>
7321N/A Brief instructions on installing OpenDJ directory server
7321N/A </para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>Uninstall.app</filename></term>
7321N/A <listitem>
7321N/A <para>Mac OS X GUI for removing OpenDJ</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>bak</filename></term>
7321N/A <listitem>
7321N/A <para>Directory for saving backup files</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>bat</filename></term>
7321N/A <listitem>
7321N/A <para>Windows command-line tools and control panel</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>bin</filename></term>
7321N/A <listitem>
7321N/A <para>UNIX/Linux/Mac OS X command-line tools and control panel</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>changelogDb</filename></term>
7321N/A <listitem>
7321N/A <para>
7321N/A Backend data for the external change log when using replication
7321N/A </para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>classes</filename></term>
7321N/A <listitem>
7321N/A <para>Directory added to the <literal>CLASSPATH</literal> for OpenDJ,
7321N/A permitting individual classes to be patched</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>config</filename></term>
7321N/A <listitem>
7321N/A <para>OpenDJ server configuration and schema, PKI stores, LDIF generation
7321N/A templates, resources for upgrade</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>config/MakeLDIF</filename></term>
7321N/A <listitem>
7321N/A <para>Templates for use with the <command>make-ldif</command> LDIF
7321N/A generation tool</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>config/config.ldif</filename></term>
7321N/A <listitem>
7321N/A <para>LDIF representation of current OpenDJ server config</para>
7321N/A <para>Use the <command>dsconfig</command> command to edit OpenDJ server
7321N/A configuration.</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>config/java.properties</filename></term>
7321N/A <listitem>
7321N/A <para>JVM settings for OpenDJ server and tools</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>config/schema</filename></term>
7321N/A <listitem>
7321N/A <para>OpenDJ directory server LDAP schema definition files</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>config/tasks.ldif</filename></term>
7321N/A <listitem>
7321N/A <para>Data used by task scheduler backend so that scheduled tasks and
7321N/A recurring tasks persist after server restart</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>config/tools.properties</filename></term>
7321N/A <listitem>
7321N/A <para>Default settings for command-line tools</para>
7321N/A <para>Use as a template when creating an
7321N/A <filename>~/.opendj/tools.properties</filename> file.</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>config/upgrade</filename></term>
7321N/A <listitem>
7321N/A <para>Resources used by the upgrade command to move to the next version
7321N/A of OpenDJ</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>config/wordlist.txt</filename></term>
7321N/A <listitem>
7321N/A <para>List of words used to check password strength</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>db</filename></term>
7321N/A <listitem>
7321N/A <para>
7321N/A Backend database files for backends that hold user data
7321N/A </para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>example-plugin.zip</filename></term>
7321N/A <listitem>
7321N/A <para>Sample OpenDJ plugin code. Custom plugins are meant to be installed
7321N/A in <filename>lib/extensions</filename>.</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>import-tmp</filename></term>
7321N/A <listitem>
7321N/A <para>Used when importing data into OpenDJ</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>instance.loc</filename></term>
7321N/A <listitem>
7321N/A <para>
7321N/A Pointer to OpenDJ on the file system, provided for package installations
7321N/A where the program files are separate from the server instance files
7321N/A </para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>ldif</filename></term>
7321N/A <listitem>
7321N/A <para>Directory for saving LDIF export files</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>lib</filename></term>
7321N/A <listitem>
7321N/A <para>Scripts and libraries needed by OpenDJ and added to the
7321N/A <literal>CLASSPATH</literal> for OpenDJ</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>lib/extensions</filename></term>
7321N/A <listitem>
7321N/A <para>File system directory to hold your custom plugins</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>locks</filename></term>
7321N/A <listitem>
7321N/A <para>Directory to hold lock files used when OpenDJ is running to prevent
7321N/A backends from accidentally being used by more than one server process</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>logs</filename></term>
7321N/A <listitem>
7321N/A <para>Access, errors, audit, and replication logs</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>logs/server.pid</filename></term>
7321N/A <listitem>
7321N/A <para>Contains the process ID for the server when OpenDJ is running</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>setup</filename></term>
7321N/A <listitem>
7321N/A <para>UNIX setup utility</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>setup.bat</filename></term>
7321N/A <listitem>
7321N/A <para>Windows setup utility</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>template</filename></term>
7321N/A <listitem>
7321N/A <para>
7321N/A Template files for a directory server instance
7321N/A </para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>uninstall</filename></term>
7321N/A <listitem>
7321N/A <para>UNIX utility for removing OpenDJ</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>uninstall.bat</filename></term>
7321N/A <listitem>
7321N/A <para>Windows utility for removing OpenDJ</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>upgrade</filename></term>
7321N/A <listitem>
7321N/A <para>UNIX utility for upgrading OpenDJ by pointing to the new .zip</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A <varlistentry>
7321N/A <term><filename>upgrade.bat</filename></term>
7321N/A <listitem>
7321N/A <para>Windows utility for upgrading OpenDJ by pointing to the new .zip</para>
7321N/A </listitem>
7321N/A </varlistentry>
7321N/A </variablelist>
7321N/A</appendix>