Main Page

Welcome to the OpenCms Wiki

OpenCms is a professional level Open Source Website Content Management System. You can find more information about OpenCms on the project homepage.

The current version of OpenCms is 7.5.2. Read the release notes for more details.

If you are a newbie or new to this wiki you should take a look at the FAQ page.

Getting OpenCms Up and Running

Installation

• Hardware requirements
• Finding and installing the prerequisites
• Database Setup
• App server related topics
• OS related topics
• Post-installation checkout

Configuration

• Important Configuration Files
• Importing Existing Data
• Defining OpenCMS structured XML content
• Removing /opencms/opencms from site url
• MultiSite configuration instructions (apache + mod_proxy)
• Avoiding /opencms/opencms in the URL (apache + mod_proxy)
• MultiSite configuration instructions (apache + mod_jk)
• Securing the site - implementing your security policy
• Removing OpenCMS documents and non-essential components - What to keep
• Changing the default request encoding
• Changing from Servlet 2.3 to Servlet 2.4 (JSP 2.0)
• Disable structured content
• Disallow creation of resource types
• Workplace: Custom footer

Performance Tuning

• Load Balancing with Alkacon Clustering OCEE
• Static Export configuration
• Flex Cache tuning
• Clustering OpenCms
• Performance Tuning Example

OpenCms Versions

• New/Different Features in OpenCms 7

OpenCms Bundles

• OpenCms 7.0.5 Web Site Framework

Using / Maintaining an installation of OpenCms

• Backing up OpenCms

Using the Workplace

• Explorer view
• Administration view
• Editors
  • FCKEditor
  • HTML cleanup control

Workflow

• Workflow in core OpenCms
• Workflow using third party workflow engines

Admin Tools/Maintenance Tools

• Project Management
• Account Management
• Database Management
• Module Management
• File History
• Link Validation
• Gallery Overview
• Search Management
• Scheduled Jobs Management
• Flex Cache Administration
• Content Tools
• Workplace Tools
• CMS Shell

User Management

• How to create a restricted area on your homepage
• How OpenCms Permissions work

Security

• Authentication per Page
• Https/SSL
• External password authentication

Help

• OpenCms Website
• Official Mailing List Archives
• Mailing List Archive at Nabble.com (Good search function and threaded display)
• Managing and Customizing OpenCMS 6 A book about OpenCms administration and usage
• OpenCms 7 Development A developers guide for new and experienced users extending and customizing OpenCms 7 through its Java API

Demo

• German or english test-drive of OpenCms 7
• german Demo of OpenCms 7.0.5

Forums

• OpenCms Forum
• German OpenCms forum
• OpenCms Goodies
• The first OpenCms forum in Spanish
• OpenCms Facebook Page
• OpenCms Facebook Group
• OpenCms User Group on Xing.com

Additional sites with OpenCms documentation:

• OpenCms documentation project at sourceforge
• German documentation for OpenCms Users
• Javadoc and browsable source code
• OpenCmsHispano the first Spanish Community
• The first OpenCMS Brazilian Community for Developer and Support

Companies offering OpenCms support

• IT consultancy/Solution provider

Third Party Integration and Modules

• Integration HOWTOs (Struts, Spring, JSF, etc.)
• Available Modules and Extensions

The future development of OpenCms

• Wishlist
• Development Roadmap

What Can OpenCms Do

Overview

• OpenCms Administration Guide
• OpenCms philosophy
• OpenCms terminology
• Introduction to the OpenCms application structure and tools
• Alternative site structures
• Planning and documenting your site
• Best Practices
• Other Overview Guides

• OpenCms Reference Sites

Template Development

• basics and overview
• example template with tree menu
• common and frequent mistakes, NPEs
• oc-taglibrary specifics
• Building from Scratch
• Using existing Template One
• Using existing Template Two
• Other example templates
• The Ubuntu Framework for a kickstart into template development
• Tags cloud for blog

Search

• Configuration
• Sample search results pages
• common mistakes
• writing only specific xml-element-data to the lucene index
• lucene related: writing custom analyzers, stemmers, documents

Other Major Features

• XMLContent
• Localization / Multilanguage / I18N
• Categories
• Customizability for Several Clients

Troubleshooting

• HTTP 404 with OpenCms URLs
• Installing OpenCms to an existing database
• Log Settings
• Getting Static Export working properly
• OpenCms won't start!
• Direct edit mode moves page elements around
• Running OpenCms on JRun 4.0
• No WYSIWYG-Editor (FCKeditor) after Firefox-Update (3.6)

Writing JSP and developing in OpenCms

Jsp Basics

• Basic Steps to writing JSPs
• Including your template elements within your JSPs
• Using Direct Edit with JSP
• OpenCms features available via taglibs
• OpenCms features javadoc
• OpenCms downloadable sample modules
• How Opencms Handles JSP- Advanced
• Scriptlets
• Creating Navigation
• Using Cookies, e.g. for CSS-Switching

Using the OpenCms API

• Adding and modifying users
• Creating and editing files
• Working with users and groups
• Working with projects
• Getting server information
• Using OpenCms's Database connection pool
• Listing OpenCms's scheduled jobs

Development Process-Best Practices

• Transferring an existing website to a different server

Development Environment Setup

• Synchronizing with Ant
• Debugging
• OpenCms 7: WebDAV access to the OpenCms VFS
• Automated builds with OpenCms-Maven

Development tips

• Eclipse integration
• Eclipse Integration on the MAC
• Ftpd module
• Synchronization with external directories
• Remote debugging OpenCms with Eclipse and Netbeans
• ManifestBuilder Task
• Structured Content Tips and Tricks

Updating

Migration of content

• Export/Import site while keeping the 'unpublished' flags

Extending OpenCms

Module Development

• Development Lifecycle
• Action classes (e.g. do something when a resource was published or changed)
• Create Module HowTo
• Adding Jar Files
• Advanced module config
• Available Open Source Modules
• Available Commercial Modules

Advanced Customization

• Custom Login Page
• Custom File and Folder Types
• Custom Views
• Custom Widgets
• Custom XML Content Validation
• Create a Custom Scheduled Job
• Configure the Structured Content Editor
• Custom Content Parser

Admin Tools

• Adding Admin Tools

Advanced development topics

• core stuff
• event handling
• acegi integration
• OpenCms startup

Common HowTos

• RSS
• Send email
• Google Sitemap.xml