Main Page

Welcome to the OpenCms user wiki

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

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

Please note: The information in this user contributed wiki does not necessarily represent the latest OpenCms version. Refer to the official OpenCms documentation website for the latest version information.

If you are unfamiliar with wikis in general you should take a look at the FAQ page.

OpenCms HowTos

• A short introduction

OpenCms Tutorials

• Configuration of OpenCms Sitemap Properties
• Using formatters in OpenCms
• Creating OpenCms 8 Container Templates
• Upgrading from OpenCms 7.x to OpenCms 8
• Creating Mobile Templates with OpenCms 8
• Creating Plug & Play Modules for OpenCms 8
• The OpenCms 8 Demo Template Modules in Detail
• The OpenCms 8 Content Subscription Engine

PDF downloads

• OpenCms 8 content manager user manual

Getting OpenCms Up and Running

Installation

• OpenCms in the Cloud
• Hardware requirements
• Finding and installing the prerequisites
• Database Setup
• Installing on Oracle 9
• Installing on PostgreSQL
• 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) - out of date
• Disable structured content
• Disallow creation of resource types
• Workplace: Custom footer
• Workplace - Explorer View: Hide Advanced property button

Performance Tuning

• Load Balancing with Alkacon Clustering OCEE
• Static Export configuration
• 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
• 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

Official Website

• OpenCms Website

Bug reports

• OpenCms Issue Tracker on GitHub

Forums

• Official Mailing List Archives
• Mailing List Archive at Nabble.com (Good search function and threaded display)
• The first OpenCms forum in Spanish
• OpenCms Facebook Page
• OpenCms Facebook Group
• OpenCms User Group on Xing.com, german, "... dient primär als Plattform für das Knüpfen von Kontakten zwischen OpenCms Entwicklern und (potentiellen) Auftraggebern."
• German OpenCms forum DEAD

Books

• 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 latest OpenCms version
• German Demo of OpenCms 8

Additional sites with OpenCms documentation:

• OpenCms documentation project at sourceforge - out of date
• German documentation for OpenCms Users
• Javadoc and browsable source code
• OpenCmsHispano the first Spanish Community
• The first OpenCMS Brazilian Community for Developer and Support
• German User Guide for / Deutsches Handbuch für OpenCms 8.5.1

Companies offering OpenCms support

• IT consultancy/Solution provider

What Can OpenCms Do

Overview

• OpenCms Administration Guide
• OpenCms philosophy
• OpenCms terminology
• Introduction to the OpenCms application structure and tools
• Best Practices
• Other Overview Guides

• OpenCms Reference Sites

Template Development

• basics and overview
• example template with tree menu
• common and frequent mistakes, NPEs
• Building from Scratch
• Using existing Template One
• Using existing Template Two
• Available Modules

Search

• Configuration
• Sample search results pages
• writing only specific xml-element-data to the lucene index
• lucene related: writing custom analyzers, stemmers, documents
• Solr - configuration for Chinese and correct results for german umlauts

Other Major Features

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

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)
• No WYSIWYG-Editor (FCKeditor) after IE-Update (IE9)
• Deleting broken resources via SQL

Writing JSP and developing in OpenCms

Building OpenCms

• Building Opencms 9.5.x from the sources

Jsp Basics

• 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 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

IDE Integration

• Developing OpenCms with Eclipse
• Developing OpenCms with Maven (incl. Eclipse)
• Eclipse integration
• Eclipse Integration on the MAC

Development Environment Setup

• Development Environment Setup Options
• Synchronizing with Ant
• Debugging
• Remote debugging OpenCms with Eclipse and Netbeans
• OpenCms 7: WebDAV access to the OpenCms VFS
• Automated builds with OpenCms-Maven
• Gradle OpenCms Build Script

Development tips

• Synchronization with external directories
• ManifestBuilder Task
• Structured Content Tips and Tricks