Directory locations and properties
The Open Liberty default directory structure is helpful for understanding the relationship between directories and files. Some directories have properties that can be used to specify file locations when you configure the server. For example, the wlp.install.dir
property is used to specify the location of the wlp/
directory.
Directory properties can be specified in different places. For example, the wlp.install.dir
property can be set in the server.xml
or bootstrap.properties
files, depending on when you want the property to be processed. For more information about these files and the order in which properties are processed, see the Server configuration overview.
You can bind directory properties into the JNDI namespace by using the predefined variables that are associated with these properties. For more information, see Provide programmatic access to predefined variables.
To ensure configuration portability, use the most specific property that is appropriate and do not rely on the relationship between resources. For example, in some configurations the ${wlp.install.dir}
installation location might not be the parent of the customized ${wlp.user.dir}
instance.
The following table shows the Open Liberty default directory structure. The first column contains a directory tree. If a directory has an associated property, the property is provided in the second column. A description of each directory or file is given in the third column.
Directory or file | Property | Description |
---|---|---|
|
| Root of installation. |
| Scripts for managing the installation, for example, | |
| Open Liberty client and thin client libraries, for example, | |
| Jython-based scripts. | |
| Root for developer resources (APIs, SPIs, specifications, and tools). | |
| Public APIs that are available for both compile and run time by default. | |
| APIs that are available in Open Liberty. | |
| Java document archives for APIs. | |
| Public specification APIs that are available for both compile and run time by default. | |
| Third-party APIs that are available at compile time by default and must be specified in the configuration by using the | |
| Public SPIs that are available for both compile and run time by default. | |
| SPIs that are available in Open Liberty. | |
| Java document archives for SPIs. | |
| Public specification SPIs that are available for both compile and run time by default. | |
| Ant plug-in for Open Liberty. | |
| User-customized server variables that apply to all servers (optional). For more information about Open Liberty environment variables, see Default environment variables. | |
| Default server script environment variables (optional). | |
| Default client script environment variables (optional). | |
| Default JVM options (optional). | |
| License information files. | |
| Platform runtime environment. | |
| Runtime customization templates and examples. | |
| Server template when creating a server. | |
| Client template when creating a client. | |
|
| User directory. |
|
| User-developed features. |
| ||
|
| Shared applications. |
|
| Shared configuration files. |
|
| Shared resource definitions: adapters, data sources. |
|
| Shared stack groups for remote deployment of packages and installables. |
| Shared servers directory. | |
|
| Server configuration directory. |
| Default directory for the files to be loaded as configuration variables. For more information, see Variable substitution precedence. | |
| Server bootstrap properties (optional). For more information about this file, see the Server configuration overview. | |
| Server JVM options, which replace the values in the | |
| Server script environment variables, which are merged with | |
| Server configuration overlays (required). For more information about this file, see the Server configuration overview. | |
| Server configuration for applications. | |
| Server default application dropins folder (optional). | |
| Application folder or archive (optional). | |
| Server configuration dropins folder (optional). | |
| Default server configuration dropins folder (optional). | |
| Server configuration overrides dropins folder (optional). | |
|
| Server output directory. |
| Server log files, including First Failure Data Capture (FFDC) logs. | |
| Basic server status and operations messages. | |
| Time-stamped trace messages, with the level of detail determined by the current tracing configuration. | |
| First Failure Data Capture (FFDC) output directory. | |
| First Failure Data Capture (FFDC) output that typically includes selective memory dumps of diagnostic data related to the failure of a requested operation. | |
| Files created by the server as it operates. | |
| Shared clients directory. | |
| Client configuration directory. | |
| Client bootstrap properties (optional). | |
| Client JVM options, which replace the values in the | |
| Client configuration overlays (required). | |
| Client configuration for applications. | |
| Client log files, including First Failure Data Capture (FFDC) logs. | |
| Time-stamped trace messages, with the level of detail determined by the current tracing configuration. | |
| First Failure Data Capture (FFDC) output directory. | |
| First Failure Data Capture (FFDC) output that typically includes selective memory dumps of diagnostic data related to the failure of a requested operation. | |
| Files created by the client as it operates. |