Liferay Administrator’s Guide, 2nd Edition

Book Description:

The Liferay Portal Administrator’s Guide is your complete guide to installing, integrating, configuring, and maintaining Liferay Portal. This comprehensive guide will show you how to install Liferay Portal, configure it for your use, and maintain your Liferay-powered site on a day-to-day basis. From installing a bundle to configuring a Liferay cluster, every aspect of running Liferay Portal is covered. This newly-updated guide is your roadmap to a successful implementation of Liferay Portal. Now covering Liferay Portal 5.1 and below, this book contains the information you need to keep your portal environment running smoothly.

Table of Contents

1. Introduction.......................................................................................15

CREATED FOR THE ENTERPRISE....................................................................................15

Personalization and easy customization..............................................15

Workflow adaptable...............................................................................16

Branding friendly...................................................................................16

Flexible organization.............................................................................16

Built With The End-User In Mind.........................................................16

Award-winning UI............................................................................16

One-Click Look and Feel Changes...................................................16

Web OS..............................................................................................16

TECHNOLOGY TO HELP DEVELOPERS.............................................................................16

Standards Compliant..............................................................................17

Ready Integration...................................................................................17

Liferay Plugins Catalog..........................................................................17

SUPPORTED TECHNOLOGIES ........................................................................................17

LANGUAGES ...........................................................................................................18

2. Initial Setup.......................................................................................19

OBTAINING LIFERAY.................................................................................................20

INSTALLING A BUNDLE..............................................................................................20

INSTALLING LIFERAY FOR A DEVELOPER.........................................................................21

Standalone Liferay..................................................................................22

Download the Tomcat Bundle.........................................................22

Uncompress the Bundle..................................................................23

Install a Lightweight SQL Database................................................23

Connect Liferay to the SQL Database..............................................24

Launch Liferay!.................................................................................25

Installing the Liferay Extension Environment.....................................26

Install the Necessary Tools....................................................................26

Java Development Kit.......................................................................27

Apache Ant 1.7.0 or Above...............................................................27

A Liferay-supported Database.........................................................28

Obtain the Liferay Source................................................................30

Create Configuration Files...............................................................31

Create the Extension Environment................................................32

Install an Application Server..........................................................33

Deploy the Extension Environment................................................34

INSTALLING LIFERAY FOR AN ENTERPRISE.......................................................................34

Database Setup........................................................................................35

Turning a Bundle into an Enterprise Portal.........................................36

Further Configuration.....................................................................37

Installing Liferay on an Existing Application Server..........................37

Geronimo 1.1 with Tomcat 5.0.28/5.5.17........................................38

Glassfish 2.x......................................................................................39

Jetty 5.1.1..........................................................................................41

JBoss 4.03sp1/4.04/4.05 with Jetty 5.1.1.........................................43

JBoss 4.03sp1/4.04/4.05/ 4.2 with Tomcat.....................................46

Oracle Application Server (OC4J)....................................................48

iiiResin 3.0.X / 3.1.X............................................................................56

Tomcat 5.0.X/5.5.X...........................................................................57

WebLogic8 sp5..................................................................................59

WebLogic 9 / 10................................................................................63

WebSphere 6.0.X.X...........................................................................65

WebSphere 6.1..................................................................................78

Making Liferay Coexist with Other Java EE Applications....................88

3. Configuration.....................................................................................91

LIFERAY’S USER INTERFACE........................................................................................91

Navigating Liferay..................................................................................92

Adding the Administrative Portlets......................................................94

PORTAL ARCHITECTURE.............................................................................................95

Users........................................................................................................96

User Groups.............................................................................................96

Roles.........................................................................................................97

Organizations..........................................................................................97

Communities...........................................................................................97

USING LIFERAY’S ADMINISTRATIVE PORTLETS.................................................................98

Adding Users...........................................................................................98

User Management.................................................................................100

Organizations........................................................................................101

User Groups..........................................................................................103

User Groups and Page Templates.................................................104

Roles.......................................................................................................109

Defining Permissions on a Role....................................................109

GLOBAL SERVER SETTINGS.......................................................................................111

Password Policies..................................................................................112

Settings..................................................................................................113

General............................................................................................113

Authentication: General Settings.................................................113

Authentication: LDAP....................................................................114

Single Sign-On................................................................................119

Authentication: Central Authentication Service (CAS)...............119

Authentication: NTLM...................................................................121

Authentication: OpenID.................................................................121

Authentication: OpenSSO..............................................................122

Default User Associations..............................................................122

Reserved Screen Names.................................................................122

Mail Host Names.............................................................................123

Email Notifications.........................................................................123

The Admin Portlet................................................................................123

Resources........................................................................................123

Log Levels........................................................................................123

System Properties..........................................................................124

Portal Properties............................................................................124

Shutdown........................................................................................124

OpenOffice......................................................................................124

Instances.........................................................................................125

Plugins.............................................................................................125

SUMMARY............................................................................................................125

4. Advanced Liferay Configuration......................................................127

The portal-ext.properties File.............................................................127

ivProperties Override.......................................................................128

Portal Context................................................................................128

Resource Repositories Root...........................................................129

Technology Compatibility Kit.......................................................129

Schema............................................................................................129

Upgrade...........................................................................................129

Verify..............................................................................................130

Auto Deploy....................................................................................130

Hot Deploy......................................................................................132

Hot Undeploy..................................................................................132

Plugin..............................................................................................132

Portlet.............................................................................................133

Theme..............................................................................................133

Resource Actions............................................................................134

Model Hints....................................................................................134

Spring..............................................................................................134

Hibernate........................................................................................135

Custom SQL.....................................................................................136

Ehcache...........................................................................................137

Commons Pool................................................................................137

JavaScript........................................................................................137

SQL Data..........................................................................................141

Company.........................................................................................141

Users................................................................................................142

Groups and Roles............................................................................142

Organizations.................................................................................144

Languages and Time Zones...........................................................144

Look and Feel..................................................................................146

Request............................................................................................146

Session.............................................................................................146

JAAS.................................................................................................148

LDAP................................................................................................149

CAS...................................................................................................151

NTLM...............................................................................................151

OpenID.............................................................................................152

OpenSSO..........................................................................................152

Authentication Pipeline.................................................................152

Auto Login.......................................................................................155

SSO with MAC (Message Authentication Code)...........................156

Passwords.......................................................................................156

Permissions.....................................................................................157

Captcha...........................................................................................158

Startup Events................................................................................159

Shutdown Events............................................................................159

Portal Events...................................................................................159

Login event.....................................................................................160

Logout event...................................................................................160

Default Landing Page.....................................................................160

Default Logout Page.......................................................................161

Default Guest Public Layouts........................................................161

Default User Private Layouts.........................................................162

Default User Public Layouts..........................................................163

vDefault Admin................................................................................163

Layouts............................................................................................164

Default Settings Layouts................................................................164

Portlet URL.....................................................................................168

Preferences.....................................................................................169

Struts...............................................................................................169

Images.............................................................................................169

Editors.............................................................................................169

Fields...............................................................................................170

Mime Types.....................................................................................170

Amazon License Keys.....................................................................170

Instant Messenger..........................................................................170

Lucene Search.................................................................................171

SourceForge....................................................................................173

Value Object....................................................................................174

Last Modified..................................................................................174

XSS (Cross Site Scripting)..............................................................174

Communication Link.....................................................................175

Content Delivery Network.............................................................175

Counter...........................................................................................175

Lock.................................................................................................175

JBI....................................................................................................176

JCR...................................................................................................176

OpenOffice......................................................................................176

POP..................................................................................................176

Quartz..............................................................................................177

Scheduler........................................................................................177

Social Bookmarks...........................................................................177

Velocity Engine..............................................................................178

Virtual Hosts...................................................................................178

HTTP................................................................................................179

Servlet Filters.................................................................................179

Upload Servlet Request..................................................................180

Web Server......................................................................................180

WebDAV..........................................................................................181

Main Servlet....................................................................................181

Axis Servlet.....................................................................................182

JSON Tunnel Servlet.......................................................................182

Liferay Tunnel Servlet...................................................................182

Spring Remoting Servlet...............................................................182

WebDAV Servlet.............................................................................182

Admin Portlet.................................................................................182

Announcements Portlet.................................................................183

Blogs Portlet...................................................................................183

Calendar Portlet.............................................................................184

Communities Portlet......................................................................184

Document Library Portlet.............................................................184

Image Gallery Portlet.....................................................................186

Invitation Portlet............................................................................186

Journal Portlet................................................................................186

Journal Articles Portlet..................................................................188

Mail Portlet.....................................................................................188

viMessage Boards Portlet.................................................................190

My Places Portlet............................................................................191

Navigation Portlet..........................................................................191

Nested Portlets Portlet..................................................................191

Portlet CSS Portlet.........................................................................191

Shopping Portlet............................................................................192

Software Catalog Portlet................................................................192

Tags Compiler Portlet....................................................................193

Tags Portlet.....................................................................................193

Tasks Portlet...................................................................................193

Translator Portlet..........................................................................193

Web Form Portlet...........................................................................193

Wiki Portlet.....................................................................................193

PLUGIN MANAGEMENT............................................................................................195

Portlets..................................................................................................195

Themes..................................................................................................197

Layout Templates.................................................................................197

Web Plugins...........................................................................................197

Installing  Plugins  from  Liferay’s  Official  and  Community

Repositories...........................................................................................198

Installing Plugins Manually.................................................................200

Plugin Troubleshooting.......................................................................202

Liferay Configuration Issues.........................................................202

The Container Upon Which Liferay Is Running..........................204

Changing the Configuration Options in Multiple Places............204

How Liferay Is Being Launched.....................................................204

Creating Your Own Plugin Repository................................................205

The Software Catalog Portlet........................................................206

Manually Creating A Software Catalog.........................................212

Connecting to a Software Catalog.................................................213

LIFERAY SERVICES ORIENTED ARCHITECTURE................................................................213

Accessing Liferay’s WSDL....................................................................215

5. Enterprise Configuration.................................................................217

LIFERAY CLUSTERING..............................................................................................218

All Nodes Should Be Pointing to the Same Liferay Database............219

Jackrabbit Sharing................................................................................219

Search Configuration...........................................................................220

Pluggable Enterprise Search.........................................................220

Lucene Configuration....................................................................222

Hot Deploy.............................................................................................223

DISTRIBUTED CACHING............................................................................................223

Hibernate Cache Settings..............................................................225

Clustering Jackrabbit.....................................................................226

WORKFLOW..........................................................................................................226

Installation and Test.............................................................................227

Using Different Databases....................................................................228

Technical Explanations........................................................................228

Process Definitions.........................................................................228

Integrating with Users, Communities, and Roles........................228

Data Types and Error Checking....................................................230

Sample Process Definitions...........................................................232

Warning Messages.........................................................................233

viiAdministration......................................................................................234

Deploying Workflows.....................................................................234

Managing Instances.......................................................................236

Managing Tasks..............................................................................237

Future Enhancements..........................................................................238

Logging............................................................................................238

Customizable Front-End................................................................238

File Upload Data Type....................................................................239

Frequently Asked Questions................................................................239

How do you write a new process definition?...............................239

Why  are  there  “Duplicate  File”  exceptions  when  I  change

databases for jBPM?.......................................................................239

DEPLOYING A CUSTOMIZED LIFERAY...........................................................................239

Deploying Directly on the Server........................................................240

Deploying from a Client Machine........................................................241

PERFORMANCE TUNING...........................................................................................241

Memory.................................................................................................241

Properties File Changes.......................................................................242

Servlet Filters........................................................................................243

Portlets..................................................................................................243

6. Maintaining A Liferay Portal...........................................................245

LIFERAY MONITORING USING GOOGLE ANALYTICS.........................................................245

BACKING UP A LIFERAY INSTALLATION.......................................................................246

Source Code...........................................................................................246

Liferay’s File System.............................................................................247

Database................................................................................................247

LIFERAY’S LOGGING SYSTEM.....................................................................................247

UPGRADING LIFERAY..............................................................................................249

Liferay Upgrade Procedure..................................................................249

Upgrade Steps.................................................................................250

Upgrading Liferay 4.3 to Liferay 4.4....................................................250

Prerequisite ...................................................................................250

If Your Developers Have Customized Liferay..............................250

Upgrading Liferay 4.4 to Liferay 5.0....................................................251

Prerequisite ...................................................................................251

If Your Developers Have Customized Liferay..............................251

Converting wiki pages (optional) .................................................251

Upgrade Troubleshooting ............................................................252

Upgrading Liferay 5.0 to Liferay 5.1....................................................252

Changes in configuration properties ...........................................252

How to keep the old values ..........................................................252

What has been changed? ..............................................................252

If Your Developers Have Customized Liferay..............................252

Upgrading Themes ........................................................................253

The Parent Element of the Dock May Change Positioning When

Upgrading.......................................................................................254

The Class Names for Different UI Components Have Changed . 254

Change in Theme CSS Fast Load...................................................254

Change in Javascript Fast Load.....................................................255

Upgrading PHP Portlets ................................................................255

Javascript changes .........................................................................255

7. Appendix: Documentation License...................................................257

viiiCREATIVE COMMONS LICENSE...................................................................................257

License...................................................................................................257

Creative Commons Notice....................................................................263

8. Colophon..........................................................................................265

Index....................................................................................................268