Liferay Administration Guide

5/26/2018 Liferay Administration Guide

1/313

Portal Administrator's Guide

Richard L. Sezov, Jr.


2/313

Liferay Administrator's Guideby Richard L. Sezov, Jr.Copyright !""# by Liferay, $nc.$S%& #()")*()"!!#)+his -or is offered under the Creative Commons Attribution)Share A/ie 0nported

/icense.

1ou are free2 to share3to copy, distribute, and transmit the -or to remi43to adapt the -or

0nder the fo//o-ing conditions2 Attribution. 1ou must attribute the -or in the manner specified by the

author or /icensor 5but not in any -ay that suggests that they endorse youor your use of the -or6.

Share Alike. $f you a/ter, transform, or bui/d upon this -or, you maydistribute the resu/ting -or on/y under the same, simi/ar or a compatib/e/icense.

he fu// version of this /icense appears in the appendi4 of this boo, or you may vie-it on/ine here2http277creativecommons.org7/icenses7by)sa78."

Contributors2Ray Auge, Jian Cao 5Steven6, %rian Chan, A/ice Cheng, %ryan Cheung, $van Cheung,Shepherd Ching, A/e4ander Cho-, %runo 9arache, Jorge 9errer, :ie ;an, JR ;oun,

Scott Lee, d Shin, Joseph Shum, :ichae/ 1oung
http://creativecommons.org/licenses/by-sa/3.0http://creativecommons.org/licenses/by-sa/3.0http://creativecommons.org/licenses/by-sa/3.0


3/313

Table of ContentsTable of Contents

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

CR>A>=9?R;>>&>R@R$S>..................................................................................*@ersona/ization and easy customization..............................................*L@=>B>L?@>RS...........................................................................+Standards Comp/iant..............................................................................Ready $ntegration...................................................................................Liferay @/ugins Cata/og..........................................................................

S0@@?R>=>C;&?L?G$>S......................................................................................LA&G0AG>S ........................................................................................................

2. Initial Setup.......................................................................................19>=$$?&S?9L$9>RA1.............................................................................................#?%A$&$&GL$9>RA1...............................................................................................!"$&SALL$&GA%0&=L>............................................................................................!"$&SALL$&GL$9>RA19?RA&>&>R@R$S>.....................................................................!!

Samp/e =ata............................................................................................!!

Liferay ;ome...........................................................................................!!=atabase Setup........................................................................................!8

=efau/t :ethod2 Automatic.............................................................!8:anua/ :ethod................................................................................!8

urning a %und/e into an >nterprise @orta/.........................................!he porta/)e4t.properties 9i/e.........................................................!*

$nsta//ing Liferay on an >4isting App/ication Server..........................!$nsta//ing Liferay in " >asy Steps..................................................!G/ass9ish !.4.....................................................................................!(G/ass9ish 8.4.....................................................................................8

Jetty +................................................................................................8J%oss ."8sp 7 ." 7 ."* 7 .! 7 .8..............................................8+J%oss *.4............................................................................................8#?rac/e App/ication Server 5?CJ6....................................................!Resin 8..4.........................................................................................Resin 8.!.4.........................................................................................#omcat *.*.D.....................................................................................*"


4/313

&avigating Liferay..................................................................................(&avigating the Contro/ @ane/................................................................("

@?RALARC;$>C0R>...........................................................................................(0sers........................................................................................................(!0ser Groups.............................................................................................(!Ro/es.........................................................................................................(!

?rganizations..........................................................................................(8Communities...........................................................................................(80S$&G;>C?&R?L@A&>L.....................................................................................(

Adding 0sers...........................................................................................(0ser :anagement..................................................................................(+?rganizations..........................................................................................(Communities...........................................................................................(#

Community @rovisioning................................................................#"0ser Groups.............................................................................................#!

0ser Groups and @age emp/ates...................................................#8Ro/es.........................................................................................................#(

=efining @ermissions on a Ro/e......................................................#(Specia/ &ote about the @o-er 0sers Ro/e...................................."

GL?%ALS>RB>RS>$&GS....................................................................................."@ass-ord @o/icies.................................................................................."Settings.................................................................................................."!

Genera/............................................................................................"!Authentication2 Genera/ Settings................................................."!Authentication2 L=A@...................................................................."8Sing/e Sign)?n................................................................................"#Authentication2 Centra/ Authentication Service 5CAS6..............."#

Authentication2 &L:..................................................................."Authentication2 ?pen$=.................................................................Authentication2 ?penSS?..............................................................Authentication2 Site:inder..........................................................!=efau/t 0ser Associations..............................................................!Reserved Credentia/s.....................................................................!:ai/ ;ost &ames.............................................................................8>mai/ &otifications.........................................................................8$dentification..................................................................................8:isce//aneous2 =isp/ay Settings....................................................8

:onitoring............................................................................................8@/ugins Configuration..........................................................................8Server Administration.........................................................................

Resources........................................................................................Log Leve/s........................................................................................System @roperties..........................................................................@orta/ @roperties............................................................................*Shutdo-n........................................................................................*?pen?ffice......................................................................................*

@orta/ $nstances....................................................................................+@/ugins $nsta//ation..............................................................................+

S0::AR1.........................................................................................................+4. Lifera Collaboration Suite..............................................................119

SC?@>S.............................................................................................................#ARC;$B>=S>0@S...............................................................................................!

iv


5/313

@>R:$SS$?&S......................................................................................................!S;AR$&G...........................................................................................................!!

Any ntries.....................................................................!(

CAL>&=AR.........................................................................................................!#Configuring the Ca/endar @ort/et........................................................!#

>vent 9rom.....................................................................................!#>vent Reminder >mai/...................................................................!#=isp/ay Settings..............................................................................8"

0sing the Ca/endar @ort/et..................................................................8"C;A...............................................................................................................8:A$L...............................................................................................................8!:>SSAG>%?AR=S...............................................................................................88

>mai/ 9rom............................................................................................8:essage Added >mai/...........................................................................8:essage 0pdated >mai/.......................................................................8hread @riorities..................................................................................80ser Rans.............................................................................................8RSS.........................................................................................................8*Anonymous @osting..............................................................................8*Ratings...................................................................................................8*@ermissions...........................................................................................8*

Adding Categories.................................................................................8+0sing the :essage %oards...................................................................8:essage %oard Administrative 9unctions..........................................8#

:oving hreads.............................................................................."=e/eting hreads............................................................................"%anning 0sers................................................................................"Sp/itting hreads............................................................................">diting @osts..................................................................................."@ermissions.....................................................................................


6/313

Resource Repositories Root...........................................................#echno/ogy Compatibi/ity Eit.......................................................#Schema............................................................................................#0pgrade...........................................................................................#Berify..............................................................................................*"Auto =ep/oy....................................................................................*"

;ot =ep/oy......................................................................................*!;ot 0ndep/oy..................................................................................*8@/ugin..............................................................................................*8@ort/et.............................................................................................*8@ort/et Coordination......................................................................*heme..............................................................................................*Resource Actions............................................................................**:ode/ ;ints....................................................................................**Service %ui/der...............................................................................**Spring..............................................................................................**;ibernate........................................................................................*+

J=%C.................................................................................................*(Custom SFL.....................................................................................+"=atabase..........................................................................................+">hcache...........................................................................................+"

JavaScript........................................................................................+SFL =ata..........................................................................................+Company.........................................................................................+*0sers................................................................................................++Groups and Ro/es............................................................................+?rganizations.................................................................................+#

Languages and ime ones..........................................................."Loo and 9ee/..................................................................................!ReHuest............................................................................................!Session.............................................................................................!

JAAS.................................................................................................L=A@................................................................................................*CAS...................................................................................................&L:...............................................................................................?pen$=.............................................................................................(?penSS?..........................................................................................(

Site:inder......................................................................................(Authentication @ipe/ine.................................................................#Auto Login.......................................................................................(SS? -ith :AC 5:essage Authentication Code6...........................(!@ass-ords.......................................................................................(8@ermissions.....................................................................................(Captcha...........................................................................................(*Startup >vents................................................................................(*Shutdo-n >vents............................................................................(+@orta/ >vents...................................................................................(+Login event.....................................................................................(+Logout event...................................................................................(=efau/t Landing @age.....................................................................(=efau/t Logout @age.......................................................................(=efau/t Guest @ub/ic Layouts........................................................(

vi


7/313

=efau/t 0ser @rivate Layouts.........................................................((=efau/t 0ser @ub/ic Layouts..........................................................(#=efau/t Admin................................................................................#"Layouts............................................................................................#"=efau/t Settings Layouts................................................................#@ort/et 0RL.....................................................................................#*

@references.....................................................................................#+Struts...............................................................................................#+$mages.............................................................................................#+9i/eSystem;oo..............................................................................#>ditors.............................................................................................#9ie/ds...............................................................................................#:ime ypes.....................................................................................#Amazon...........................................................................................#(%ro-ser Launcher..........................................................................#(Contro/ @ane/..................................................................................#($nstant :essenger..........................................................................##Lucene Search.................................................................................##Source9orge....................................................................................!"Ba/ue ?bIect....................................................................................!"!Communication Lin.....................................................................!"!Content =e/ivery &et-or.............................................................!"8Counter...........................................................................................!"8Loc.................................................................................................!"8

J%$....................................................................................................!"8JCR...................................................................................................!"8Live 0sers........................................................................................!"

Loc.................................................................................................!":ai/..................................................................................................!"?pen?ffice......................................................................................!"+@?@..................................................................................................!"+Fuartz..............................................................................................!"Schedu/er........................................................................................!"Search Container............................................................................!"Sharepoint......................................................................................!"Socia/ %oomars...........................................................................!"(Be/ocity >ngine..............................................................................!"(

Birtua/ ;osts...................................................................................!"#;@................................................................................................!"#Serv/et 9i/ters.................................................................................!"0p/oad Serv/et ReHuest..................................................................!


8/313

Asset @ub/isher @ort/et..................................................................!%/ogs @ort/et...................................................................................!Ca/endar @ort/et.............................................................................!Communities @ort/et......................................................................!*=ocument Library @ort/et.............................................................!*$mage Ga//ery @ort/et.....................................................................!+

$nvitation @ort/et............................................................................!Journa/ @ort/et................................................................................!Journa/ Artic/es @ort/et..................................................................!#Journa/ Content Search @ort/et.....................................................!#:essage %oards @ort/et.................................................................!#:y @/aces @ort/et............................................................................!!"&avigation @ort/et..........................................................................!!"&ested @ort/ets @ort/et..................................................................!!@ort/et CSS @ort/et.........................................................................!!Shopping @ort/et............................................................................!!Soft-are Cata/og @ort/et................................................................!!!ags Compi/er @ort/et....................................................................!!!ags @ort/et.....................................................................................!!!ass @ort/et...................................................................................!!8rans/ator @ort/et..........................................................................!!8:>&..........................................................................................!!*@ort/ets..................................................................................................!!*hemes..................................................................................................!!+Layout emp/ates.................................................................................!!;oo @/ugins.........................................................................................!!

RA1CL0S>R$&G............................................................................................!*"A// &odes Shou/d %e @ointing to the Same Liferay =atabase............!*=ocument Library Configuration........................................................!*

Jacrabbit Sharing................................................................................!*!Search Configuration...........................................................................!*8

@/uggab/e >nterprise Search.........................................................!*8Lucene Configuration....................................................................!**

;ot =ep/oy.............................................................................................!*+=$SR$%0>=CAC;$&G..........................................................................................!*+

;ibernate Cache Settings..............................................................!*(

viii


9/313

C/ustering Jacrabbit.....................................................................!*#


10/313

Changes in configuration properties ...........................................!#";o- to eep the o/d va/ues ..........................................................!#"/ement of the =oc :ay Change @ositioning


11/313

PPREFACEREFACE

Liferay @orta/ is the /eading open source porta/ in the maretp/acetoday. $t has received a-ards from mu/tip/e /eading industry pub/ications,and has an impressive do-n/oad rate 5over +",""" do-n/oads a month andover a mi//ion do-n/oads tota/6.


12/313

What's New in the Third ditionCertain/y, Liferay @orta/ has not stood sti// since the /ast edition -as

-ritten. his edition has been updated so that it covers Liferay @orta/ up toversion *.!. Chapter * 5Advanced Liferay Configuration6 has been comp/ete/yrevamped to that it covers a// of the ne- porta/ properties, and the rest ofthe boo has been e4haustive/y gone through and updated.

he chapter on @orta/ Administration 5Chapter 86 has been overhau/edso that it covers Liferay administration using the ne- Contro/ @ane/. hischapter a/so goes over porta/ design, /isting the things you might -ant toconsider as you bui/d your -eb site on Liferay @orta/.

9or this edition of the boo, a ne- chapter on Liferay's unpara//e/edco//aboration suite of port/ets has been provided. his chapter -i// guide

you through enab/ing your users to co//aborate using the robust set of too/sthat Liferay provides2 b/ogs, ca/endar, chat, mai/, message boards, and -iis.

?ther chapters have been e4panded to inc/ude additiona/ information.9or e4amp/e, Chapter 5Maintaining a Liferay Portal6 no- covers databasesharding among other things, and an updated section on upgrading Liferay.

!onventionsSections are broen up into mu/tip/e /eve/s of headings, and these are

designed to mae it easy to find information.

Source code and configuration file directives are presented likethis.

If source code goes multi-line, the lines will be \

separated by a backslash character like this.

Italicsare used to represent /ins or buttons to be c/iced on in a userinterface and to indicate a /abe/ or a name of a Java c/ass.

-oldis used to describe fie/d /abe/s and port/ets.

@age headers denote the chapters, and footers denote the particu/arsection -ithin the chapter.

Pu"lisher Notes$t is our hope that this boo -i// be va/uab/e to you, and that it -i// be

an indispensab/e resource as you begin to administer a Liferay porta/ server.$f you need any assistance beyond -hat is covered in this boo, Liferay, $nc.offers training, consu/ting, and support services to fi// any need that youmight have. @/ease seehttp277---./iferay .com7-eb7guest7services for fur)ther information about the services -e can provide.

4ii

Ti#$This is a tip. Tips are used to indicate a suggestion or apiece of information that affects whatever is being talked aboutin the surrounding text. They are always accompanied by thisgray box and the icon to the left.
http://www.liferay.com/web/guest/serviceshttp://www.liferay.com/web/guest/serviceshttp://www.liferay.com/web/guest/serviceshttp://www.liferay.com/web/guest/serviceshttp://www.liferay.com/web/guest/serviceshttp://www.liferay.com/web/guest/services


13/313

As a/-ays, -e -e/come any feedbac. $f there is any -ay you thin -ecou/d mae this boo better, p/ease fee/ free to mention it on our forums.1ou can a/so use any of the emai/ addresses on our Contact Us page5http277---./iferay .com7-eb7guest7aboutMus7contactMus6. nterprise >dition of the product. A /ot ofhard -or -ent into po/ishing the materia/ and maing it as error)free aspossib/e. ?f course, no one is perfect, and so if -e find any prob/ems -iththe materia/, they -i// be corrected on the errata page for the boo inLiferay's -ii 5http277 -ii ./iferay.com6.

$ have endeavored to give credit to everyone -ho made a contribution5it's on the copyright page6, but if $ missed somebody3-hich -ou/d not besurprising3p/ease /et me no- so your name is not /eft out of the ne4t edi)tionN $ cannot e4press enough ho- -onderfu/ it is to be surrounded by somany ta/ented peop/e -ho do everything they can to mae this product thebest it can be3even -hen a particu/ar tas is not their primary Iob.

he engineering team at Liferay is a fantastic group of peop/e, and myIob -ou/d be a /ot more difficu/t -ere it not for their patience -ith me -hen$ interrupt their -or -ith some 5pretty dumb, sometimes6 Huestions. Sospecia/ thans are due to Ray Auge, &ate Cavanaugh, %rian Chan, A/e4 Cho-,%runo 9arache, Jorge 9errer, and :ie 1oung.

$'d a/so /ie to than my daughter Ju/ia for checing in on me from timeto time and bringing some good cheer -ith her. And of course, $ -ant tothan my -ife, =eborah, -ho continua//y has to put up -ith /ong hours as a

computer -ido-, for her understanding and support. $ cou/dn't do any ofthis -ithout her.

Rich Sezov

http277---./iferay .com7-eb7rsezov7b/og

4iii
http://www.liferay.com/web/guest/about_us/contact_ushttp://www.liferay.com/web/guest/about_us/contact_ushttp://wiki.liferay.com/http://www.liferay.com/web/rsezov/bloghttp://www.liferay.com/web/rsezov/bloghttp://www.liferay.com/web/guest/about_us/contact_ushttp://www.liferay.com/web/guest/about_us/contact_ushttp://www.liferay.com/web/guest/about_us/contact_ushttp://wiki.liferay.com/http://wiki.liferay.com/http://wiki.liferay.com/http://www.liferay.com/web/rsezov/bloghttp://www.liferay.com/web/rsezov/bloghttp://www.liferay.com/web/rsezov/blog


14/313


15/313

1.1. IINTRODUCTIONNTRODUCTION

Liferay @orta/ is the -or/d's /eading open source enterprise porta/ so/ution usingthe /atest in Java and


16/313

$ntroduction

the organizationa/ and persona/ /eve/.

Wor%low ada#ta"le

LiferayOs techno/ogy is bui/t to Huic/y adapt business and organizationa/changes, ensuring minima/ do-ntime in todayOs fast)changing maret.

(randin) %riendl&

Liferay @orta/ is coded to easi/y adapt to your organizationOs desired brandingand /oo and fee/.

*le+i"le or)anization

Liferay @orta/ is high/y sca/ab/e for /arge, gro-ing user bases. $t accommodatesthe functiona/ needs of even the most comp/e4 of enterprises))9or e4amp/e, your suborganizations can each be given its o-n porta/ e4perience -ith uniHue 0RL, /ogin,/oo and fee/ and security permissionsN

(uilt With The nd-ser n /ind

Liferay @orta/Os a-ard -inning user interface offers dynamic, intuitive and timesaving features that fosters user adoption across your entire organization.

AWAR0WNNNG-Liferay @orta/ offers dynamic, intuitive and time saving features that foster user

adoption across your entire organization.


17/313

$ntroduction

Standards !om#liant

Liferay @orta/ comp/ies -ith ey industry standards, maing it easy to -or andintegrate -ith.

Read& nte)ration

@artnerships -ith /eading ?pen Source p/ayers such as A/fresco, $C>soft, Spring)Source, and @entaho ensure unpara//e/ed integration and support for these -ide/y)used techno/ogies.

Li%era& Plu)ins !atalo)

his e4c/usive feature of Liferay @orta/ eeps trac of ne- versions of the soft)

-are and instant/y updates the techno/ogy -ithout troub/esome restarts.

Liferay supports ALL maIor app servers, databases, and operating systems -ithover "" dep/oyment configurations.

@/ease see our dep/oyment matri4 for more detai/s.

Su##orted Technolo)ies

echno/ogies 0sed2

Apache Service:i4 ehcache ;ibernate $C>faces Java J!>>7J>> I%@: JGroups IFuery JavaScript

9rame-or Lucene :u/eSource >S% @;@ Ruby Seam Spring P A?@ Struts P i/es apestry

Be/ocity

Standards2

AJAD iCa/endar P :icroformat JSR)!(+ JSR)! JSR)" Seats on the JSR)!(+ 5@ort/et !."6 and JS9)8

5JS9 !."6 committees ?penSearch ?pen p/atform -ith support for -eb services

inc/uding2 JS?& ;essian %ur/ap R>S R:$


18/313

$ntroduction

speaers of the /anguages from Liferay's open source community. Additiona/ /an)guages can be added very easi/y, and this has been done many times over the /ife ofthe product.

( Languages


19/313

2.2. IINITIALNITIALSSETUPETUP

Liferay @orta/ is one of the most f/e4ib/e app/ications -ith regard to app/icationserver environment on the maret today. 1ou can insta// Liferay @orta/ on everythingfrom a shared omcat insta//ation to a mu/ti)node c/uster running a commercia/ ap)p/ication server, and on everything in bet-een. $n fact, Liferay is used successfu//y ina// of these scenarios every day.

1ou -i// find that because Liferay is e4treme/y f/e4ib/e in its dep/oyment options,it is easy to insta// as -e//. $f you a/ready have an app/ication server, you can simp/yuse the too/s for dep/oyment that came -ith your app/ication server. $f you do nothave an app/ication server, Liferay provides severa/ app/ication server bund/es from-hich to choose. hese are very easy to insta// and -ith a sma// amount of configura)tion can be made into production)ready systems.

ditions o% Li%era&Liferay ships in t-o different editions2 Liferay @orta/ Standard >dition 5S>6 and

Liferay @orta/ >nterprise >dition 5>>6. S> is the same Liferay @orta/ that has beenavai/ab/e for years2 freHuent/y updated and bursting -ith the /atest features, thestandard edition of Liferay @orta/ is offered for free under the business)friend/y :$open source /icense. Liferay @orta/ >> is a supported version of Liferay @orta/ for theenterprise. ;ardened for security and designed to be roc so/id stab/e, >> is offered-ith a subscription and support pacage, a//o-ing organizations to bui/d their porta/son a stab/e version of the product that is offered over an e4tended period of time.

%ecause the re/ease cyc/e for >> is /onger than that for S>, each enterprise re)/ease is supported for years. A// bug fi4es in Liferay @orta/ are bacported to yourversion of Liferay for the duration of your subscription. his gives organizations thepeace of mind that comes from no-ing that their Liferay)po-ered -eb site is stab/eand -i// run for years to come, enab/ing them to bui/d their sites on a proven, stab/ep/atform. Additiona//y, Liferay's professiona/ services team offers training and con)su/ting on the >nterprise >dition to ensure /ong)term support and stabi/ity for our c/i)


20/313

$nitia/ Setup

ents.

1"tainin) Li%era&

he S> version of Liferay is free/y do-n/oadab/e from our -eb site athttp277---./iferay .com .C/ic on theDownloads/in at the top of the page, and you-i// be presented -ith mu/tip/e options for getting a copy of Liferay, inc/uding ourconvenient bund/es or a .-ar pacage for insta//ation on your app/ication server ofchoice.

he >> version of Liferay -i// be provided to you as a resu/t of your support sub)scription. 1ou -i// be provided -ith do-n/oad /ins -hich -i// a//o- you to obtain acopy of a Liferay bund/e or a .-ar pacage for insta//ation on your app/ication serverof choice.

$f you -ant to insta// a bund/e, there is a /ist of bund/es avai/ab/e. $f you do notcurrent/y have an app/ication server, it is best to do-n/oad the omcat bund/e, asomcat is one of the sma//est and most straightfor-ard bund/es to configure. $f youhave an app/ication server preference, you can a/so choose the server you prefer fromthe avai/ab/e Liferay @orta/ bund/es. ;aving a J=E 5Java =eve/opment Eit6 a/ready in)sta//ed is a prereHuisite to running any of the bund/es.

@/ease note that Liferay is not ab/e to provide app/ication server bund/es for pro)prietary app/ication servers such as


21/313

$nitia/ Setup

Licen$e)Contains both Liferay's /icense and a fi/e -hich describes the /icensesfor many of the other open source proIects that are used interna//y by Liferay.

Application Ser!er/)here -i// a/so be an app/ication server fo/der -hich is

different depending on -hich bund/e you have do-n/oaded. his fo/der contains theapp/ication server in -hich Liferay has been insta//ed.

$n most cases, insta//ing a bund/e is as easy as uncompressing the archive andthen starting the app/ication server. 9or e4amp/e, if you -ere to insta// Liferay @orta/on omcat, you -ou/d simp/y unzip the bund/e to a /ocation of your choice.

&o- you -ou/d start omcat in the same -ay as you -ou/d if you had do-n)/oaded it manua//y. omcat is /aunched by -ay of a script -hich is found in its binfo/der. $f you drop to a command prompt and go to this fo/der, you can /aunch omcatvia the fo//o-ing command on


22/313

$nitia/ Setup

can do.

$nsta//ing a different bund/e is done in e4act/y the same -ay2 unzip the bund/einto the fo/der of your choice, /aunch the app/ication server, and then vie- the porta/

in your -eb bro-ser.As you can see, bund/es are the easiest -ay to get started -ith Liferay. hey

come pre)configured -ith a running Liferay that can be used immediate/y to e4p/orea// of the things that Liferay can do. And -ith minima/ e4tra configuration 5-hich -e-i// see /ater6, bund/es can be converted into fu// production)ready systems.

nstallin) Li%era& %or an nter#rise>ventua//y, you -i// -ant to insta// Liferay onto a rea/ server, after you've com)

p/eted your eva/uation and you -ant to begin bui/ding your -eb site. $t is easiest to do

this by starting -ith a bund/e and then reconfiguring that bund/e so that it is enter)prise)ready. %ecause this is by far the Huicest and easiest method to get a productionLiferay system running, -e -i// /oo at this first. ?ften, ho-ever, enterprises -i//have an estab/ished Java >> infrastructure upon -hich they -ou/d /ie to insta//Liferay. $n this situation, a bund/e -i// not suffice. :ost of this section, therefore, -i//focus on insta//ing Liferay onto an a/ready)estab/ished app/ication server.

Sam#le 0ata


23/313

$nitia/ Setup

fo/der for most app/ication servers is one fo/der higher than the /ocation of the ap)p/ication server itse/f. $n the case of a server -hich defines different domains for dif)ferent instances of the server, this fo/der may be one fo/der up from the domain in-hich Liferay is running.

$f Liferay is unab/e to create the resources it needs in this fo/der, or if it finds it)se/f running on certain app/ication servers, it -i// fa// bac to defining the homefo/der in the home fo/der of the user $= that is running Liferay.

As described above in the"undlessection, the home fo/der is very important tothe operation of Liferay. he aforementioned fo/ders 5data$ de%loy$ and license6 -i// becreated there, and you can a/so put a specia/ configuration fi/e ca//ed%ortal&ext'%ro%er&tiesthere.

his fi/e -i// be fu//y documented in Chapter *2 Advanced Liferay Configuration, but

-e -i// use it in this chapter for some basic configuration, inc/uding setting up Liferayto ta/ to our database.

0ata"ase Setu#

0*A-LT/T310$ A-T1/AT!

$f you create your database and grant a user $= fu// access to it, Liferay can usethat user $= to create its inde4es and tab/es automatica//y. his is the recommended-ay to set up Liferay, as it a//o-s you to tae advantage of Liferay's abi/ity to auto)

matica//y maintain its database through various p/ugin insta//s -hich may createtab/es of their o-n and through upgrades of the p/atform. $t is by far the best -ay toset up your Liferay insta//ation.

$f you -i// be setting up Liferay's database -ith the recommended permissions,you can sip the ne4t section.

/AN-AL/T310

>ven though Liferay can create its database automatica//y, some enterprisesprefer notto a//o- the user $= configured in an app/ication server to have the permis)sions over the database necessary for Liferay and its p/ugins to maintain their tab/es.9or these organizations, Se/ect, $nsert, 0pdate, and =e/ete are genera//y a// the per)missions that are granted, and so -e -i// go over ho- to set up the database manu)a//y. $f your organizationis-i//ing to grant the Liferay user $= permissions to createand drop tab/es in the database3and this is the recommended configuration3you cansip this section.

?ne other caveat is this2 Liferay has an automatic database upgrade function-hich runs -hen the version of Liferay is upgraded to a ne- re/ease. $f the user $=that accesses the database does not have enough rights to create 7 modify 7 drop

tab/es in the database, you -i// need to grant those rights to the $= before you startyour upgraded Liferay for the first time. ?nce the upgrade is comp/ete, you can re)move those rights unti/ the ne4t upgrade. Additiona//y, many p/ugins provided byLiferay reHuire that ne- tab/es be added to Liferay's database. hese p/ugins cannotbe insta//ed if Liferay does not have permission to create these tab/es automatica//y. $f

$nsta//ing Liferay for an >nterprise !8


24/313

$nitia/ Setup

you -ish to insta// these p/ugins, you -i// need to grant rights to create tab/es in thedatabase before you attempt to insta// them.

Liferay provides an SFL script archive do-n/oad on the -eb site. 9or the S> ver)

sion, it is in the Additional (ilessection of the =o-n/oads page. 9or the >> version, you-i// be provided a /in to this archive. =o-n/oad this fi/e and unzip it. 1ou -i// findthat it contains a fo/der structure that is broen do-n by the type of script 5fu//, min)ima/, or upgrade6, and then further by database vendor type.

$t is best to use the create&minimalscript if you are insta//ing a fresh version ofLiferay on a deve/opment, FA, or production server. his script creates the necessaryLiferay tab/es in the database, -ith a minimum configuration. his is most appropri)ate for a ne- insta//ation of Liferay.

he createscript, by contrast, configures a Liferay database -ith a portion of the

content fromhttp277---./iferay .com embedded in it. his can be usefu/ from a de)ve/opment perspective, as it contains -oring e4amp/es of the use of many ofLiferay's features, inc/uding the Journa/ Content :anagement System.

$nside the create or create&minimal fo/ders are scripts for every database thatLiferay supports. A =%A can use the script provided to create the Liferay database,comp/ete -ith the inde4es necessary for optima/ performance. ?nce this is done, besure that the $= that the porta/ -i// use to connect to the database has at /east Se/ect,$nsert, 0pdate, and =e/ete permissions. @referab/y, ho-ever, the $= shou/d a/so haverights to create, modify, and drop tab/es and inde4es, as this maes upgrading easier.his, ho-ever, is not necessary for the dai/y operation of Liferay.

?nce your =%A has created the database and provided the credentia/s for access)ing it, you are ready to begin 6 maing a bund/e enterprise)ready or !6 manua//y in)sta//ing Liferay on your app/ication server.

Turnin) a (undle into an nter#rise Portal

Liferay @orta/ is distributed -ith the fo//o-ing bund/e options for serv/et con)tainers and fu// Java >> app/ication servers2

GeronimoQomcat

G/assfish ! and 8

J%ossQomcat .!

J%ossQomcat *."

Jetty

J?nASQJetty

J?nASQomcat

Resin omcat *.*

omcat +."

! $nsta//ing Liferay for an >nterprise
http://www.liferay.com/http://www.liferay.com/http://www.liferay.com/http://www.liferay.com/http://www.liferay.com/http://www.liferay.com/


25/313

$nitia/ Setup

Choose your preferred bund/e and do-n/oad it from the do-n/oads page onLiferay's -eb site or via the >> /ins that -ere provided to you. A prereHuisite forrunning any of the bund/es is that you have the proper version of the Java =eve/o)ment Eit 5.* or higher6 insta//ed on the machine to -hich you are insta//ing Liferay.

:ae sure that you have a/so created the JABAM;?:> environment variab/e and havepointed it to your Java insta//ation.

0nzip the bund/e to the /ocation from -hich you are going to run it. 9or e4)amp/e, you might use =2apps in


26/313

$nitia/ Setup

-ith Liferay. 1ou are going to override the defau/t configuration -hich points Liferayto the embedded ;SFL database.

here are t-o -ays to set up the connection2

0se your app/ication server's connection poo/.

0se the bui/t)in connection poo/.

$f you -ant to use your app/ication server's connection poo/, you -i// have to cre)ate one in your app/ication server that points to your database. $t shou/d be ca//ed*dbc+LiferayPool. o cause Liferay to use this connection poo/, add the fo//o-ing direct)ive to your%ortal&ext'%ro%ertiesfi/e2

jdbc.default.jndi.namejdbc/!iferay"ool

o use the bui/t)in connection poo/3based on C8@",add the temp/ate -hich is

provided in Chapter * for your particu/ar database. he temp/ate for :ySFL isprovided as an e4amp/e be/o-.

#

# $yS%!

#

jdbc.default.driver&lass'amecom.mys(l.jdbc.)river

jdbc.default.urljdbc*mys(l*//localhost/lportal+usenicodetruecharactern-coding0-1use0ast)ate"arsingfalse

jdbc.default.username

jdbc.default.password

1ou -ou/d provide the user name and pass-ord to the database as va/ues for theusernameand%assworddirectives.

9or mai/, there is a simi/ar procedure. Again, you have t-o -ays to configureyour server2

0se your app/ication server's mai/ session.

0se the bui/t)in mai/ session.

o use your app/ication server's mai/ session, you -i// have to create one in your

app/ication server that points to your mai/ server. ?nce you have done that, add thefo//o-ing directive to your%ortal&ext'%ro%ertiesfi/e2

mail.session.jndi.namemail/$ailSession

o use the bui/t)in mai/ session, add the fo//o-ing directives to your %ortal&ext'&%ro%ertiesfi/e, substituting your mai/ server information2

mail.session.mail.pop2.hostlocalhost

mail.session.mail.pop2.password

mail.session.mail.pop2.port334

mail.session.mail.pop2.user

mail.session.mail.smtp.authfalse

mail.session.mail.smtp.hostlocalhost

mail.session.mail.smtp.password

mail.session.mail.smtp.port56

!+ $nsta//ing Liferay for an >nterprise


27/313

$nitia/ Setup

mail.session.mail.smtp.user

mail.session.mail.store.protocolpop2

mail.session.mail.transport.protocolsmtp

Save the fi/e. 1ou can no- start your app/ication server.

nstallin) Li%era& on an +istin) A##lication Server

his section contains detai/ed instructions for insta//ing Liferay @orta/ using its> app/ications in your app/ication server of choice.

NSTALLNGL*RA5N67 AS5STPS

here are " generic steps to insta//ing Liferay on an e4isting app/ication server2

. ?btain the Liferay .-ar fi/e and the dependencies archive.

!. :ae sure you do not have an app/ication /istening at the root 576 of yourserver. $f you do, move it to a different conte4t or undep/oy it.

8. =ecide -hether you -ant to use your app/ication server's data sources or ifyou -ant to use the one inc/uded -ith Liferay. $f you -ant to use your ap)p/ication server's data source, create a data source for Liferay ca//ed*dbc+LiferayPool.

. =ecide -hether you -ant to use your app/ication server's mai/ session or ifyou -ant to use the one inc/uded -ith Liferay. $f you -ant to use your ap)p/ication server's mai/ session, create one ca//ed mail+Mail)ession.

*. Shut your app/ication server do-n.

+. >4tract the dependencies to a /ocation on your server's g/oba/ c/ass path.his a//o-s both Liferay and p/ugins to access these dependencies.

. Create a%ortal&ext'%ro%ertiesfi/e and p/ace it in the Liferay ;ome fo/der. Gen)era//y, this is one fo/der up from -here your app/ication server is insta//ed.

See the notes on specific app/ication servers be/o- for the /ocation of thisfo/der for your app/ication server.

(. Add either the J&=$ name of your data source or the J=%C parameters aboveto connect Liferay to your database.

#. Add either the J&=$ name of your mai/ session or the mai/ parameters aboveto connect Liferay to your mai/ server.

". Start your app/ication server, dep/oy the Liferay .-ar fi/e, and start it.

he instructions be/o- are specific for each app/ication server that Liferay sup)

ports. Liferay supports a -ide combination of app/ication servers and databases. %e)cause of this, for brevity this section assumes :ySFL as the database, that the data)base has a/ready been created, and that you are using your app/ication server's mai/session and data source. o use other databases, substitute the J=%C driver and 0RLconstruct for your database in p/ace of the :ySFL ones sho-n here.

$nsta//ing Liferay for an >nterprise !


28/313

$nitia/ Setup

nterprise

Illustration 2! .lassfish 3D"C Connection Pool

Ti#$Note that Liferay 5.x requiresJD !.5 or greater. Do not attempt to in"stall Liferay 5.x on an application server that runs under Java !.# or lower$it will not work. %f you are running an application server that ships with aJD and that JD is !.# or lower& you will need to upgrade your application

server in order to user Liferay 5.x. Liferay #.x& however& will run fine onthese application servers.
http://localhost:4848/http://localhost:4848/http://localhost:4848/http://localhost:4848/


29/313

$nitia/ Setup

. 0nder 0ther 4as5s, se/ect Create 6ew 3D"C Connection Pool'

!. $n the first screen, give it a name ofLiferayPool, a Resource ype of*avax's7l'&ConnectionPoolData)ource, and se/ect My)8L as the =atabase Bendor. C/ic

6ext'8. ?n the ne4t page, scro// do-n to the Additional Pro%erties section. 9ind the

property ca//ed U9L, and set its va/ue to2

jdbc*mys(l*//localhost/lportal+usenicodetrueamp7characterncod-ing0-1amp7emulate!ocatorstrue

$f your database is not on the same server as G/assfish, substitute your data)base server's host name for localhostabove.

. C/ic Add Pro%erty, and add a property ca//ed user-ith a va/ue of the username to connect to the database.

*. C/ic Add Pro%ertyagain, and add a property ca//ed%assword-ith a va/ue ofthe pass-ord to connect to the database.

+. C/ic(inish'

. 1ou -i// no- see a /ist of Connection @oo/s. o test your connection, c/ictheLiferayPooland c/ic thePingbutton. $f you get a &ing Succeededmes)sage, everything has been set up correct/y.

(. C/ic3D"C 9esources. 1ou -i// see a /ist of J=%C Resources by J&=$ &ame.

#. C/ic 6ew.". :ae the J&=$ &ame *dbc+LiferayPooland se/ect the Liferay@oo/ you created

ear/ier.

. C/ic 0:'

/AL!1N*G-RAT1N$f you -ant G/ass9ish to manage your mai/ session, fo//o- the instructions be/o-.

$f you -ant Liferay to manage your mai/ session, you can sip this section.

$nsta//ing Liferay for an >nterprise !#

Illustration ;! .lassfish Mail )ession


30/313

$nitia/ Setup

. 0nder9esources, c/ic3avaMail )essions.

!. C/ic 6ew'

8. Give the Java:ai/ Session a J&=$ name of mail+Mail)ession, and fi// out the

rest of the form -ith the appropriate information for your mai/ server.

. C/ic 0:'

0PL15L*RA5

. C/icA%%lication )erverat the top of the tree hierarchy on the /eft.

!. C/ic3


31/313

$nitia/ Setup

Save and c/ose the fi/e.

(. Start G/ass9ish. 4tract the Liferay dependencies archive into your domain's libfo/der. >4)tract your database's J=%C driver here as -e//.

0ATA(AS!1N*G-RAT1N

$f you -ant G/ass9ish to manage the data source, use the fo//o-ing instructions.$f you -ant to use the bui/t)in Liferay data source, you can sip this section.

. Go to the G/ass9ish conso/e 0RL2http277/oca/host2((.

$nsta//ing Liferay for an >nterprise 8
http://localhost:8080/http://localhost:8080/http://localhost:8080/http://localhost:4848/http://localhost:4848/http://localhost:8080/http://localhost:4848/


32/313

$nitia/ Setup

!. 0nder 0ther 4as5s, se/ect Create 6ew 3D"C Connection Pool'

8. $n the first screen, give it a name ofLiferayPool, a Resource ype of*avax's7l'&ConnectionPoolData)ource, and se/ect My)8L as the =atabase Bendor. C/ic6ext'

. ?n the ne4t page, scro// do-n to the Additional Pro%erties section. 9ind theproperty ca//ed U9L, and set its va/ue to2

jdbc*mys(l*//localhost/lportal+usenicodetrueamp7characterncod-ing0-1amp7emulate!ocatorstrue

*. $f your database is not on the same server as G/assfish, substitute your data)base server's host name for localhostabove.

+. C/ic Add Pro%erty, and add a property ca//ed user-ith a va/ue of the username to connect to the database.

. C/ic Add Pro%ertyagain, and add a property ca//ed%assword-ith a va/ue ofthe pass-ord to connect to the database.

(. C/ic(inish'

#. 1ou -i// no- see a /ist of Connection @oo/s. o test your connection, c/ictheLiferayPooland c/ic thePingbutton. $f you get a &ing Succeededmes)sage, everything has been set up correct/y.

". C/ic3D"C 9esources. 1ou -i// see a /ist of J=%C Resources by J&=$ &ame.

. C/ic 6ew.

!. :ae the J&=$ &ame *dbc+LiferayPooland se/ect the Liferay@oo/ you createdear/ier.

8. C/ic 0:'

/AL!1N*G-RAT1N

At the time of this -riting, Java:ai/ is not yet imp/emented in G/ass9ish 8. 9orthis reason, you -i// have to use the mai/ session that is provided by Liferay.

8! $nsta//ing Liferay for an >nterprise

Illustration ?! .lassfish 3D"C Connection Pool


33/313

$nitia/ Setup

0PL15L*RA5

. Create a fi/e ca//ed %ortal&ext'%ro%erties. Add the fo//o-ing directives to thefi/e2



jdbc.default.usernameroot

jdbc.default.passwordroot

$f you are using G/ass9ish's data source, add the J&=$ name instead2


=o the same thing for the :ai/ Session. $f you are using the bui/t)in config)uration, set the fo//o-ing properties for your system2










mail.session.mail.store.protocolpop2mail.session.mail.transport.protocolsmtp

G/ass9ish 8 has not yet imp/emented Java:ai/, so you do not have the optionto use one via J&=$.


!. Go to the G/ass9ish conso/e 0RL2http277/oca/host2((

8. C/ic @eb A%%licationsin the tree on the /eft.

. C/ic theDe%loybutton.

*. C/ic"rowseand bro-se to the /ocation of the Liferay .-ar fi/e.

+. Leave the rest of the defau/ts and c/ic 0:.

Liferay -i// be dep/oyed and started automatica//y.

http://localhost:4848/http://localhost:4848/http://localhost:4848/


34/313

$nitia/ Setup

JTT5:

Lifera o+eis one fo/der above Jetty's insta// /ocation.

. =o-n/oad and insta// Jetty +.

!. =o-n/oad the Liferay @orta/ .-ar fi/e.

8. =o-n/oad Liferay @orta/ =ependencies.

. Create a-3144/H0M1+lib+extdirectory and copy the dependencies to it.

*. >dit-3144/H0M1+extra+etc+start&%lus'config.

@Ajetty.homeB/lib/e


35/313

$nitia/ Setup

9Set nameDserD:9/Set:

9Set nameD"asswordD:9/Set:

9/'ew:

9/8rg:

98rg:

9'ew classDorg.enhydra.jdbc.pool.Standard;8"ool)ata-SourceD:

98rg typeDIntegerD:=9/8rg:

9Set nameD$inSi>eD:=9/Set:

9Set nameD$aeD:369/Set:

9/'ew:

9/8rg:

9/&all:

9/'ew:

9/8rg:9/&all:

. =o-n/oad mys7l&connector&*ava&-version&bin'*ar and copy to to-3144/H0M1+lib+ext. his is the J=%C driver for :ySFL. $f you are using adifferent database, copy the appropriate driver.

(. Create a mai/ session bound to mail+Mail)essionby editing-3144/H0M1+etc+*etty'xml2

9&all nameDaddServiceD:

98rg:

9'ew classDorg.mortbay.jetty.plus.$ailServiceD:

9Set nameD'ameD:$ailService9/Set:

9Set nameDE')ID:mail/$ailSession9/Set:

9"ut nameDmail.smtp.hostD:localhost9/"ut:

9/'ew:

9/8rg:

9/&all:

#. Create-3144/H0M1+etc+*aas'config.

"ortalFealm G

com.liferay.portal.kernel.security.jaas."ortal!ogin$odule re(uired7

H7

". Create directory-3144/H0M1+weba%%s+rootand unpacthe Liferay .-ar fi/einto it.

. Go to -3144/H0M1+weba%%s+root+@1"&I6(+lib and de/ete xercesIm%l'*ar andxml&a%is'*ar.

*. Copy -3144/H0M1+weba%%s+root+@1"&I6(+lib+commons&logging'*ar to-3144/H0M1+ext5over-riting e4isting one6.

+. Create batch fi/e.. Create a directory-3144/H0M1+bin'

!. Create run'bat5&ote, this is for nterprise 8*


36/313

$nitia/ Setup

forms, configure according/y6.

echo off

if DD DJE8K8LMN$JD goto errorEavaMome

JE8K8LMN$J/bin/java -;moneO$ -)java.security.auth.login.config../etc/jaas.config-)S8F../e.

8. =o-n/oad the Liferay @orta/ .-ar fi/e and dependencies.

. >dit -3"0))/H0M1+server+default+de%loy+*boss&web'de%loyer+conf+web'xml. Re)p/ace the defau/t serv/et 5/ines #)#6 2

9servlet:

9servlet-name:default9/servlet-name:

9servlet-class:org.apache.catalina.servlets.)efaultSer-vlet9/servlet-class:

9init-param:

9param-name:debug9/param-name:

9param-value:49/param-value:

9/init-param:

9init-param:

9param-name:listings9/param-name:

9param-value:true9/param-value:

9/init-param: 9load-on-startup:39/load-on-startup:

9/servlet:

-ith2

8+ $nsta//ing Liferay for an >nterprise


37/313

$nitia/ Setup

9servlet:

9servlet-name:default9/servlet-name:

9servlet-class:org.apache.catalina.servlets.)efaultSer-vlet9/servlet-class:

9init-param: 9param-name:debug9/param-name:

9param-value:49/param-value:

9/init-param:

9init-param:

9param-name:listings9/param-name:

9param-value:false9/param-value:

9/init-param:

9init-param:

9param-name:input9/param-name:

9param-value:=4P?9/param-value: 9/init-param:

9init-param:

9param-name:output9/param-name:

9param-value:=4P?9/param-value:

9/init-param:

9load-on-startup:39/load-on-startup:

9/servlet:

*. Go to -3"0))/H0M1+server+default+lib+, do-n/oad mysH/)connector)Iava)XWversionY)bin.Iar and copy to this directory. his is the J=%C driver for

:ySFL. $f you are using a different database, copy the appropriate driver.

+. @ut the Liferay @orta/ dependency .Iars into-3"0))/H0M1+server+default+lib.

0ATA(AS!1N*G-RAT1N

$f you -ant J%oss to manage the data source, use the fo//o-ing instructions. $fyou -ant to use the bui/t)in Liferay data source, you can sip this section.

Create-3"0))/H0M1+server+default+de%loy+liferay&ds'xml-ith fo//o-ing content2

9datasources:

9local-t


38/313

$nitia/ Setup

/AL!1N*G-RAT1N

$f you -ant J%oss to manage the mai/ configuration, use the fo//o-ing instruc)tions. $f you -ant to use the bui/t)in Liferay mai/ session, you can sip this section.

Set mai/ properties by rep/acing the contents of -3"0))/H0M1+server+default+de&%loy+mail&service'xml-ith2

9+


39/313

$nitia/ Setup

remove hibernate8.Iar, Iboss)hibernate.Iar from-3"0))/H0M1+server+default+lib'

>dit-3"0))/H0M1+server+default+de%loy+*boss*ca&service'xml. Change the =ebug at)

tribute in /ine +8 from true to fa/se29attribute nameD)ebugD:false9/attribute:

>dit-3"0))/H0M1+server+default+de%loy+*ms+*bossm7&destinations&service'xml. C/earout te4t bet-een server tags2

9+nterprise 8#


40/313

$nitia/ Setup

!. =o-n/oad the /atest version of the Liferay @orta/ .-ar fi/e.

8. Go to -3"0))/H0M1+server+default+lib+. =o-n/oad mysH/)connector)Iava)XWversionY)bin.Iar and copy to this directory. 5his is the J=%C connector for

:ySFL. 0se the appropriate driver for your database.6. =o-n/oad Liferay's @orta/ =ependencies. 0nzip to -3"0))/H0M1+server+de&

fault+lib.

*. Configure JAAS. >dit -3"0))/H0M1+server+default+conf+login&config'xml andcomment out the entire D:L for po/icy other in /ines *)8.

9Q--9application-policy name DotherD:--:

...

9Q--9authentication:

9login-module code Dorg.jboss.security.

auth.spi.sersFoles!ogin$oduleD

flag Dre(uiredD /:

9/authentication:

9/application-policy:--:

0ATA(AS!1N*G-RAT1N

$f you -ant J%oss to manage the data source, use the fo//o-ing instructions. $fyou -ant to use the bui/t)in Liferay data source, you can sip this section.

Create-3"0))/H0M1+server+default+de%loy+liferay&ds'xml-ith fo//o-ing content29datasources:

9local-t


41/313

$nitia/ Setup

9mbean codeDorg.jboss.mail.$ailServiceD nameDjboss*service$ailSessionD:

9attribute nameDE')I'ameD:mail/$ailSession9/attribute:

9attribute nameDserD:nobody9/attribute:

9attribute nameD"asswordD:password9/attribute:

9attribute nameD&onfigurationD:

9configuration:

9property nameDmail.store.protocolD valueDimapD /:

9property nameDmail.transport.protocolD valueDsmtpD /:

9property nameDmail.imap.hostD valueDlocalhostD /:

9property nameDmail.pop2.hostD valueDlocalhostD /:

9property nameDmail.smtp.hostD valueDlocalhostD /:

9/configuration:

9/attribute:

9/mbean:

9/server:

0PL15L*RA5

. =e/ete a// the fi/es and fo/ders inWJ%?SSM;?:>7server7defau/t7dep/oy7R??.-ar

!. 0nzip the Liferay .-ar fi/e to the R??.-ar directory.

8. Go to-3"0))/H0M1+server+default+de%loy+9004'war+lib'

. Remove Ia4en.Iar, Ia4rpc.Iar, sta4.Iar, 4erces$mp/.Iar, 4m/)apis.Iar from-3"0))/H0M1+server+default+de%loy+9004'war+@1"&I6(+lib

*. &avigate tothe Liferay ;ome fo/der, -hich is one fo/der above J%oss's insta///ocation.

+. Create a fi/e ca//ed %ortal&ext'%ro%erties. Add the fo//o-ing directives to thefi/e2



jdbc.default.usernamerootjdbc.default.passwordroot

$f you are using J%oss's data source, add the J&=$ name instead2





mail.session.mail.pop2.port334mail.session.mail.pop2.user




$nsta//ing Liferay for an >nterprise


42/313

$nitia/ Setup





$f you are using J%oss's mai/ session, add the J&=$ name instead2



Start J%oss. ?pen your bro-ser to http277/oca/host2("(". 1ou shou/d see the de)fau/t Liferay home page.

1RA!LAPPL!AT1NSR>R?1!;J@

Lifera o+eis /ocated in the home fo/der of the user running ?CJ.

hese instructions assume you have an insta//ed ?CJ container "..8.." in afo/der that -i// be referred to as-0C;3/H0M1.

0nzip the dependencies archive 5-hich is do-n/oadab/e from Liferay's -eb site6into-0C;3/H0M1+*#ee+home+a%%lib. @ut your J=%C driver here as -e//.

?CJ contains a startup script in the binfo/der of the app/ication server direct)ory. 1ou -i// need to edit this fi/e and change some of the arguments. ?n


43/313

$nitia/ Setup

the connection factory c/ass for :ySFL is com'mys7l'*dbc'*dbc#'o%tional'Mys7l&ConnectionPoolData)ource.

*. 9i// out the J=%C 0RL to your database. 1ou shou/d have a/ready configured

your database and optiona//y run the Liferay create script.

+. C/ic (inish. 0nderData )ources, c/ic Create. Se/ect Managed Data )ource5de)fau/t6 and c/ic Continue.

. Give it a name 5LiferayData)ource6 and a J&=$ /ocation of*dbc+LiferayPool.

(. Se/ect the Connection @oo/ you created in the previous step and then c/ic(inish.


Illustration G! 0C;3! Connection Pool


44/313

$nitia/ Setup

#. C/ic the 4est Connection icon. $f you are not using an ?rac/e database,change the test SFL to something /ie )1L1C4 from User/, and then c/icest. 1ou shou/d get a message saying Connection to LiferayData)ource es&

tablished successfully. $f not, go bac and chec your settings.". C/ic the 0C;3! home/in in the top /eft of the page.

NSTALLNGL*RA5

. C/icA%%lications.

!. C/ic De%loy. Leave the defau/t se/ected under Archive, and c/ic the"rowsebutton. %ro-se to -here your Liferay .-ar fi/e is.

8.


45/313

$nitia/ Setup

. he ne4t screen a//o-s you to give the app/ication a name and set its conte4troot. 0seLiferay for the name and+%ortal as the conte4t root. C/ic 6ext.

*. C/ic the 6ext /in at the bottom right of the page.

+. C/ic the 0: button at the top of this page. 1ou -i// be brought bac to theprevious screen. C/ic theDe%loy button at the top right of the screen. ?CJ-i// then dep/oy Liferay.

. C/ic the9eturn button at the top of the page.

(. &e4t, navigate to the Liferay ;ome fo/der. Create a fi/e ca//ed%ortal&ext'%ro%&erties in this fo/der. Add a directive for @orta/ Conte4t, then give it a va/ue of+%ortal'

portal.ct


46/313

$nitia/ Setup



#. Shut do-n and restart the server. $n your bro-ser, go to

http277/oca/host2((((7porta/. 1ou shou/d see Liferay's defau/t home page.

4P/4=/51 36*4?*6= !oading code-source*/0*/!iferay/ools/8pplication Servers/oc=jLeing Service$anager

544P-=-51 36*4T*52 com.sun.portal.container.service.Service$anager addSer-vice

I'0N* "S&L&S"&S44= * Service added, 'ame* com.sun.portal.container.service.-&oordinationService, Implementation* com.sun.

portal.container.service.coordination.impl.&oordinationServiceImpl


I'0N* "S&L&S"&S44= * Service added, 'ame* com.sun.portal.container.ser-vice.&achingService, Implementation* com.sun.porta

l.container.service.caching.impl.&achingServiceImpl


I'0N* "S&L&S"&S44= * Service added, 'ame* com.sun.portal.container.ser-vice.&lient&achingService, Implementation* com.sun

.portal.container.service.caching.impl.&lient&achingServiceImpl


I'0N* "S&L&S"&S44= * Service added, 'ame* com.sun.portal.container.ser-vice.)eploymentServiceL!ocal, Implementation* com.

sun.portal.container.service.deployment.impl.)eploymentService!ocalImpl


I'0N* "S&L&S"&S44= * Service added, 'ame* com.sun.portal.container.service.-&ontainerventService, Implementation* com.su

n.portal.container.service.coordination.impl.&ontainerventServiceImpl

+ $nsta//ing Liferay for an >nterprise


47/313

$nitia/ Setup


I'0N* "S&L&S"&S44= * Service added, 'ame* com.sun.portal.container.service.-"olicyService, Implementation* com.liferay.po

rtal.portletcontainer."olicyServiceImpl544P-=-51 36*4T*52 com.sun.portal.container.service.Service$anager addSer-vice

544P-=-51 36*4T*5= com.sun.portal.container.service.Service$anager&onte


48/313

$nitia/ Setup

9/database:

9resource jndi-nameDmail/$ailSessionD typeDjava


49/313

$nitia/ Setup

". ?pen your bro-ser to http277/oca/host2("(". 1ou shou/d see the defau/tLiferay home page.

RSN9.8.4Lifera o+eis one fo/der up from Resin's insta// /ocation.

. =o-n/oad and insta// Resin 8.!. into your preferred directory. 9rom no-on, the directory -here you insta//ed Resin -i// be referred to as -91)&I6/H0M1.

!. >dit-91)I6/H0M1+conf+resin'conf. Rep/ace /ines /ine #)8 -ith2

9tree-loader [email protected]/e


50/313

$nitia/ Setup

I6/H0M1+common+lib.

#. o start the server, open a command prompt, navigate to the WR>S$&M;?:>and type2

". Iava )Iar /ib7resin.Iar start

?pen your bro-ser to http277/oca/host2("(". 1ou shou/d see the defau/t Liferayhome page.

T1/!AT=.=.4

Lifera o+eis one fo/der above omcat's insta// /ocation.

. =o-n/oad and insta// omcat *.*.D into your preferred directory. 9rom no-on, the directory -here you insta//ed omcat -i// be referred to as W?:)

CAM;?:>.

ote) 9or J=E * users2 move -40MCA4/H0M1+weba%%s+9004+@1"&I6(+lib+xercesIm%l'*ar to -40MCA4/H0M1+common+endorsed. J=E . is no/onger supported in Liferay *.4 and above.

!. Create and edit -40MCA4/H0M1+conf+Catalina+localhost+9004'xml to set upthe porta/ -eb app/ication.

9&ontedit-40MCA4/H0M1+conf+Catalina+localhost+9004'xml.9&ontenterprise


51/313

$nitia/ Setup

authD&ontainerD

typeDjavadit -40MCA4/H0M1+bin+catalina'bat 5on


52/313

$nitia/ Setup

ence the /ogin modu/e.

rem -----


53/313

$nitia/ Setup

0ATA(AS!1N*G-RAT1N

$f you -ant nterprise *8

Illustration #! @ebLogic! Data)ources


54/313

$nitia/ Setup

. C/ic theActivate Changes button on the /eft side of the screen, above the =o)main Structure tree.

0PL15

L*RA5

. C/ic theDe%loymentsoption in the =omain Structure tree on the /eft side ofthe screen.

!. C/ic the Loc5 1dit buttonabove the =omain Structuretree.

8. C/ic the Install button on theright side of the screen.

. C/ic the U%load your fileNsO/in.*. %ro-se to -here you have

stored the Liferay .-ar fi/e, se)/ect it, and then c/ic 6ext.

+. Se/ect the Liferay .-ar fi/e fromthe /ist and c/ic 6ext.

. Leave Install this de%loyment asan a%%licationse/ected and c/ic&e4t.

(. Give the app/ication a name5the defau/t name is fine6. Leave the other defau/ts se/ected and then c/ic(inish.

#.


55/313

$nitia/ Setup








mail.session.mail.smtp.hostlocalhostmail.session.mail.smtp.password





$f you are using


56/313

$nitia/ Setup

0ATA(AS!1N*G-RAT1N

$f you -ant nter thedatabase name, the host name, the port, the database user name, and thepass-ord. nterprise

Illustration ?! Creating a data source in @ebLogic J'2


57/313

$nitia/ Setup

J=%C 0RL to connect to your database. C/ic 6ext.

*.


58/313

$nitia/ Setup





$f you are using nterprise

Ti#$Throughout this installation and configuration process& 'eb(phere willprompt you to )lick (ave to apply changes to *aster )onfiguration. Do sointermittently to save your changes.

Ti#$+fter Liferay completes installing& you may see an error initiali,ing the'eb -roxy portlet. ecause the /(L parser configured by default within'ebLogic cannot compile a style sheet in this portlet& Liferay disables it bydefault. To re"enable this portlet& extract xalan.0ar and seriali,er.0ar fromthe Liferay .war archive and copy them to your JD1s endorsed folder for

libraries. %f you are using J2ockit& you may find this folder in

3ea 4ome60rockit7!8979560re6lib6ext.


59/313

$nitia/ Setup

cies archive into @eb)%here+A%%)erver+*ava+*re+lib+ext, as


60/313

$nitia/ Setup

(. C/ear any te4t in c/ass path. 1ou a/ready copied the necessary .Iars to a /ocationon the server's c/ass path.

#. C/ic 6ext.

". C/ic(inish'

. C/icData )ourcesunderAdditional Pro%erties.

!. C/ic 6ew.

8. >nter a name2 liferaydatabasesource.

. >nter J&=$2*dbc+LiferayPool.

*. >verything e/se shou/d stay at the defau/t va/ues.

+" $nsta//ing Liferay for an >nterprise

Illustration F! @eb)%here B' 6ew 3D"C Provider

Illustration G! Clear out anything in the class %ath'

Illustration K! 3D"C Provider summary screen


61/313

$nitia/ Setup

+. C/ic 6ext'. 0nderAdditional Pro%erties, c/ic Custom Pro%erties.

(. C/ic 6ew.

#. Create three custom properties by entering &ame, Ba/ue and c/icing ?E foreach ro- in the fo//o-ing tab/e.

Name >alue

!. user root

:. serverName localhost

;. databaseName lportal

$nsta//ing Liferay for an >nterprise +

Illustration #J! Liferay data source on @eb)%here B'


62/313

$nitia/ Setup

!". nterprise

Illustration #! @eb)%here B' Custom Pro%erties 1ntry


63/313

$nitia/ Setup

!. C/icData )ources)V 4est Connectionto test.

/AL!1N*G-RAT1N

. C/ic9esources)V Mail Providers.

!. C/ic"uilt&in Mail Provider.

8. C/ic Mail )essions.

. C/ic 6ew.

. a+e)liferaymail

!. *I a+e2 mail+Mail)ession

$nsta//ing Liferay for an >nterprise +8

Illustration ##! Liferay Custom Pro%erties


64/313

$nitia/ Setup

*. C/ic 0:.

+. C/ic )ecurity.

. C/ic )ecure administration$ a%%lications$ and infrastructure.

(. Se/ect1nable a%%lication security.

#. =ese/ect Use 3ava # security to restrict a%%lication access to local resources'

+ $nsta//ing Liferay for an >nterprise

Illustration #2! Creating a Mail )ession on @eb)%here B'


65/313

$nitia/ Setup

NSTALLL*RA5

. C/icA%%lications)V Install new a%%lications'

!. %ro-se for /iferay)porta/)4.4.4.-ar.

8. >nter conte4t root+.

. C/ic 6ext. 9or Steps to 8, c/ic 6extto app/y defau/ts.

$nsta//ing Liferay for an >nterprise +*

Illustration #;! Installing the Liferay 'war file on @eb)%here B'


66/313

$nitia/ Setup

*. Choose the :ai/ Session and =ata Source, and then c/ic 6ext

+. Specify the virtua/ host upon -hich you -ant Liferay to run.

++ $nsta//ing Liferay for an >nterprise

Illustration #?! )elect the installation o%tions


67/313

$nitia/ Setup

. At the Summary Screen, c/ic(inish'

(.


68/313

$nitia/ Setup

settings2


jdbc.default.urljdbc*mys(l*//localhost/lportal+usenicodetruecharacterncoding0-1use0ast)ate"arsingfalse

jdbc.default.usernameroot

jdbc.default.passwordroot

$f you are using nterprise


69/313

$nitia/ Setup

8. 0ninsta//DefaultA%%lication,Plants"y@eb)%hereand )am%les.allery.

. Se/ect liferay&%ortal'war, c/ic )tart'

*. ?pen up bro-ser and point to http277/oca/host2#"(". he defau/t Liferayhome page -i// be disp/ayed.

W(SP3RB.7Lifera o+eis in a fo/der ca//ed liferayin the home fo/der of the user $= that is run)ning


70/313

$nitia/ Setup

!. ?pen Administrative Conso/e and /og in.

8. C/ic9esources3D"C Providers.

. C/ic 6ew.

" $nsta//ing Liferay for an >nterprise

Illustration #K! @eb)%here F'J 3D"C Providers


71/313

$nitia/ Setup

*. 9or name, enter the name of J=%C provider 5e.g. My)8L 3D"C Provider6.

+. 9or $mp/ementation c/ass name, enter2

com.mys(l.jdbc.jdbc5.optional.$ys(l&onnection"ool)ataSource

. C/ic 6ext.

(. C/ear any te4t in c/ass path. 1ou a/ready copied the necessary .Iars to a /oca)tion on the server's c/ass path.

#. C/ic 6ext.

". C/ic(inish'

. C/icData )ourcesunderAdditional Pro%erties.

$nsta//ing Liferay for an >nterprise

Illustration 2J! @eb)%here F'J! )elect 3D"C Provider

Illustration 2! @eb)%here F'J! Database Pro%erties


72/313

$nitia/ Setup

!. C/ic 6ew.

8. >nter a name2 liferaydatabasesource.

. >nter J&=$2*dbc+LiferayPool.

*. >verything e/se shou/d stay at the defau/t va/ues. Save the data source.

1".


73/313

$nitia/ Setup

8. C/ic Mail )essions, and then c/ic the 6ewbutton.

. Give it a name of liferaymailand a J&=$ name of mail+Mail)ession. C/ic 0:and save to master configuration.

*. C/ic )ecurity .lobal )ecurity and dese/ect Use 3ava # security to restrict a%&%lication access to local resourcesif it is se/ected. C/icA%%ly.

NSTALLL*RA5

. C/icA%%lications &R 6ew A%%lication &R 6ew 1nter%rise A%%lication.

!. %ro-se to the Liferay .-ar fi/e and c/ic 6ext.

8. Leave(ast Pathse/ected and c/ic 6ext, and then c/ic 6extagain.

. :ae sure your server is se/ected and c/ic 6ext.*. Eeep the conte4t root set to 7 and c/ic 6ext.

+. C/ic(inish.


74/313

$nitia/ Setup


8. Save and c/ose the fi/e.

. C/icA%%lication 4y%es &R @eb)%here 1nter%rise A%%lication.

*. 0ninsta// the defau/t app/ication.

+. Se/ect the Liferay app/ication and c/ic )tart.

/ain) Li%era& !oe+ist with 1ther Java A##lications

Liferay @orta/ by defau/t is configured to sit at the root 5i.e., +6 of your app/icationserver. =edicating your app/ication server to running on/y Liferay @orta/ is a goodpractice, a//o-ing for separation bet-een your porta/ environment and your -eb ap)p/ication environment. his is genera//y a best practice for porta/s, -hich by defini)

tion are app/ication deve/opment p/atforms in and of themse/ves. 9or that reason,your instance of Liferay is /ie/y to be hosting many app/ications, and even integrat)ing severa/ of them together on a sing/e page. 9or this reason, you are going to -antto mae sure your porta/ environment has a// the resources it needs to do this, andconfiguring it so that it is the so/e consumer of any other .-ar fi/es that get dep/oyedto the app/ication server he/ps to mae sure that your system performs optima//y.

$f, ho-ever, you -ant Liferay to share space on an app/ication server -ith otherapp/ications, there is no reason -hy you cannot do that. $n this instance, you may not-ant to mae Liferay the defau/t app/ication in the root conte4t of the server.

here are t-o steps to modifying this behavior2. =ep/oy Liferay in a conte4t other than root 5for e4amp/e+%ortal6.

!. :odify the%ortal&ext'%ro%ertiesfi/e to te// Liferay the conte4t to -hich it hasbeen dep/oyed.

o change the fi/e, open it in a te4t editor. @/ace the %ortal'ctx property at the topof the fi/e2

portal.ct


75/313

$nitia/ Setup

Summar&his chapter is a guide to everything about insta//ing Liferay.


76/313


77/313

3.3. CCONFIGURATIONONFIGURATION

?nce Liferay is successfu//y insta//ed, you can begin configuring it to fit it to yourenvironment and your particu/ar porta/ proIect. 1ou can perform many of these con)figuration tass through Liferay's port/et)driven user interface.

1ou -i// -ant to customize your porta/ by configuring various settings for it,such as emai/ notifications, integration -ith services such as L=A@, creating users,user groups, organizations, and ro/es, and readying your porta/ to have its contentand app/ications /oaded by your deve/opers. his chapter covers these activities2

LiferaySs User Interface!;o- to navigate around Liferay and mae use of theContro/ @ane/.

Liferay Administration!;o- to administer a Liferay porta/.

.lobal Portal )ettings!@ass-ord po/icies, Settings, :onitoring, and more.

Li%era&'s -ser nter%aceLiferay is a%ortal server. his means that it is designed to be a sing/e environment

-here a// of the app/ications a user needs can run, and these are integrated togetherin a consistent and systematic -ay. $f an app/ication /ives outside of the porta/, theporta/ shou/d be ab/e to consume some resource of the app/ication 5such as an RSSfeed or a subset of functiona/ity in a Kdashboard app/ication6 so that the end user cansee everything he or she interacts -ith at a g/ance.

o achieve this, a// of the app/ication functiona/ity -ithin Liferay @orta/ is infragments of the page ca//ed%ortlets. @ort/ets are -eb app/ications that run in a por)tion of a -eb page. he heart of any porta/)based -eb site is its port/ets, because port)/ets are -here a// of the functiona/ity is imp/emented. Liferay's core is a port/et con)tainer, and the container's Iob is to aggregate the set of port/ets that are to appear onany particu/ar page and disp/ay them proper/y to the user. $n this -ay, one or manyapp/ications can reside on a page, and the user can 5at the administrator's discretion6


78/313

Configuration

arrange them in the -ay that -ors best for the user.

@ort/et app/ications, /ie serv/et app/ications, have become a Java standard -hichvarious porta/ server vendors have imp/emented. he Java standard defines the port)

/et specification. A JSR)+( or JSR)!(+ standard port/et shou/d be dep/oyab/e on anyport/et container -hich supports those standards. @ort/ets are p/aced on the page in acertain order by the end user and are served up dynamica//y by the porta/ server.

@orta/ app/ications come genera//y in t-o f/avors2 6 mu/tip/e port/ets can be-ritten to provide sma// amounts of functiona/ity and then are aggregated by theporta/ server into a /arger app/ication, or !6 -ho/e app/ications can be -ritten toreside in on/y one or a fe- port/et -indo-s. he choice is up to those designing theapp/ication. =eve/opers on/y have to -orry about -hat happens inside of the port/etitse/fU the po

Liferay Administration Guide

Documents

Transcript of Liferay Administration Guide