Introduction to the OpenCms application structure and tools
Cschoenfeld (Talk | contribs) |
Cschoenfeld (Talk | contribs) (→Initial structure of the OpenCms web application) |
||
| Line 47: | Line 47: | ||
<tr> | <tr> | ||
<td><tt>packages/</tt></td> | <td><tt>packages/</tt></td> | ||
| − | <td>This folder contains a sub folder, modules/, where all ZIP archives of OpenCms modules are stored. The OpenCms setup will make all modules available for installation which it finds here. | + | <td>This folder contains a sub folder, <tt>modules/</tt>, where all ZIP archives of OpenCms modules are stored. The OpenCms setup will make all modules available for installation which it finds here. The module folder is the place where a module ZIP file ends up when you use the "Export Module" function within the OpenCms Administration UI. After the installation of OpenCms you can safely delete the files here.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Revision as of 20:41, 1 November 2006
Initial structure of the OpenCms web application
When you unpack the binary distribution (ZIP file) of OpenCms you find the file opencms.war. This file contains the initial set of files required for the setup of OpenCms as well as the files for running OpenCms.
Following are the directories within opencms.war along with explanations of their meaning.
| File/Folder | Explanation |
|---|---|
| META-INF/ | The place for the Manifest. There is nothing you can tune here. |
| setup/ | This folder contains the JSP pages, images and SQL scripts used during the setup of OpenCms. After you finished setup it is a good idea to remove this folder completely. |
| WEB-INF/ | This folder contains the web application and most of the interesting files and folders. It is detailed in the table below. |
Details of the folder WEB-INF/
| File/Folder | Explanation |
|---|---|
| classes/ | This folder is initially empty but later filled with classes and classpath resources when you import and publish modules. It also contains the log4j.properties file which is responsible for the log settings in OpenCms. |
| cmsshell.sh/bat | Shell script for Linux/Windows to start a shell prompt which gives you access to OpenCms |
| cpappend.bat | TODO |
| logs/ | The place where OpenCms keeps its log file, opencms.log. You can influence the name and location of this log file by customizing WEB-INF/classes/log4j.properties. |
| packages/ | This folder contains a sub folder, modules/, where all ZIP archives of OpenCms modules are stored. The OpenCms setup will make all modules available for installation which it finds here. The module folder is the place where a module ZIP file ends up when you use the "Export Module" function within the OpenCms Administration UI. After the installation of OpenCms you can safely delete the files here. |
| config/ | The place where OpenCms stores its configuration files. The files are loaded from here and updated as well if you make changes to the configuration via the Administration UI. |
| lib/ | The standard WEB-INF/lib folder. It contains OpenCms's own library dependencies as well as the libraries found in each module's lib directory. |
| opencms.tld | A Taglib Descriptor for the OpenCms custom tag library. |
| setupdata/ | TODO |
| web.xml | Defines the OpenCms servlets. |
Runtime structure of the OpenCms web application
As OpenCms writes to the location where its WAR file is unpacked the initial content will change after initial deployment, setup and during the use of OpenCms.
The following folders are created during setup and export of files:
| File/Folder | Explanation |
|---|---|
| export/ | Contains statically exported files. |
| resources/ | Contains resource files, mostly button and icon images, of the workplace and your modules. |
OpenCms creates these folders in order to speed up access to those often needed files.
If you start editing content with OpenCms you will notice that you cannot find it on the disk. This is because OpenCms stores all content within its own Virtual File System (VFS) which is located in the database.
