From portal-commits at lists.jboss.org Tue Jul 15 11:49:02 2008 Content-Type: multipart/mixed; boundary="===============4805004594700478564==" MIME-Version: 1.0 From: portal-commits at lists.jboss.org To: portal-commits at lists.jboss.org Subject: [portal-commits] JBoss Portal SVN: r11452 - docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules. Date: Tue, 15 Jul 2008 11:49:02 -0400 Message-ID: --===============4805004594700478564== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: thomas.heute(a)jboss.com Date: 2008-07-15 11:49:02 -0400 (Tue, 15 Jul 2008) New Revision: 11452 Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installa= tion.xml docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/supporte= d.xml Log: Changed supported versions Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/i= nstallation.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/install= ation.xml 2008-07-15 14:12:50 UTC (rev 11451) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/install= ation.xml 2008-07-15 15:49:02 UTC (rev 11452) @@ -1,193 +1,391 @@ Installation - Depending on your needs, there are several different methods to i= nstall JBoss Portal. Pre-configured clustered versions (JBo= ss Portal Binary (Clustered)) are available from the - JBoss Portal Downloads page. Clustered versions of JBoss Port= al must be deployed in the JBOSS_INSTALLATION_DIRECTORY/server/al= l/deploy/ directory. All JBoss AS instances must reference the s= ame datasource. Refer to for details= on how to configure JBoss Portal for clustering. + + Depending on your needs, there are several different methods to inst= all JBoss + Portal. Pre-configured clustered versions ( + JBoss Portal Binary (Clustered) + ) are available from the + + JBoss Portal Downloads + + page. Clustered versions of JBoss Portal must be deployed in the + JBOSS_INSTALLATION_DIRECTORY/server/all/deploy/ + directory. All JBoss AS instances must reference the same datasource= . Refer to + + for details on how to configure JBoss Portal for clustering. - An environment variable, JBOSS_HOME, is = configured in . References to $JBOSS_HOME assume this to be your J= BOSS_INSTALLATION_DIRECTORY. - + An environment variable, + JBOSS_HOME + , is configured in + + . References to + $JBOSS_HOME + assume this to be your + JBOSS_INSTALLATION_DIRECTORY + . + The JBoss Portal and JBoss AS Bundle - This is the easiest and fastest way to get JBoss Portal instal= led and running. The JBoss Portal and JBoss AS bundle contains JBoss AS, JB= oss Portal, and the embedded Hypersonic SQL database. To install the JBoss = Portal and JBoss AS bundle: + + This is the easiest and fastest way to get JBoss Portal installed= and running. + The JBoss Portal and JBoss AS bundle contains JBoss AS, JBoss Por= tal, and the + embedded Hypersonic SQL database. To install the JBoss Portal and= JBoss AS + bundle: - - - - Get the bundle: the bundle is = available from the JBoss Portal Downloads page. Bundles use the JBoss Portal + JBoss AS naming convention. - - - - - Extract the bundle: extract th= e ZIP archive. It does not matter which directory is used. On Windows, the = recommended directory is C:\jboss-version-number. - - - - - Start the server: change into = the JBOSS_PORTAL_INSTALLATION_DIRECTORY/bin/ directory= . On Windows, execute run.bat. On Linux, run the sh run.sh command. To specify a configuration to use, for examp= le, the default configuration, append the -c default op= tion to the run.bat or sh run.sh comm= ands. - - - - - Log in to JBoss Portal: using = a Web browser, navigate to to open the JBoss Portal homepage. Log in using one of the two default= accounts: username user, password user, or username admin, password admin: - - - - - - - - - - - - - SQL Errors - - Tables are automatically created the first time JBoss Portal starts= . When deployed for the first time, JBoss Portal checks for the existence o= f the initial tables, which have not been created yet. This causes errors s= uch as the following, which can safely be ignored: - - - - + + + Get the bundle: + the bundle is available from the + + JBoss Portal Downloads + + page. Bundles use the + JBoss Portal + JBoss AS + naming convention. + + + + + Extract the bundle: + extract the ZIP archive. It does not matter which direct= ory is used. On + Windows, the recommended directory is + + C:\jboss- + version-number + + . + + + + + Start the server: + change into the + JBOSS_PORTAL_INSTALLATION_DIRECTORY/bin/ + directory. On Windows, execute + run.bat + . On Linux, run the + sh run.sh + command. To specify a configuration to use, for example,= the default + configuration, append the + -c default + option to the + run.bat + or + sh run.sh + commands. + + + + + Log in to JBoss Portal: + using a Web browser, navigate to + + to open the JBoss Portal homepage. Log in using one of t= he two default + accounts: username + user + , password + user + , or username + admin + , password + admin + : + + + + + + + + + + + + + SQL Errors + + Tables are automatically created the first time JBoss Portal s= tarts. When + deployed for the first time, JBoss Portal checks for the exist= ence of the + initial tables, which have not been created yet. This causes e= rrors such as + the following, which can safely be ignored: + + + + - - + + Installing the Binary Download - The binary package typically consists of the - jboss-portal.sar/ directory, documentation s= uch as the JBoss Portal User Guide and the JBoss Portal Reference Guide, an= d a set of pre-configured Datasource descriptors that allow - JBoss Portal to communicate with an external database. This insta= llation method is recommended for users who already have JBoss EAP or JBoss= AS installed, or those who need to install JBoss Portal in a clustered env= ironment. + + The binary package typically consists of the + jboss-portal.sar/ + directory, documentation such as the JBoss Portal User Guide and = the JBoss Portal + Reference Guide, and a set of pre-configured Datasource descripto= rs that allow + JBoss Portal to communicate with an external database. This insta= llation method + is recommended for users who already have JBoss EAP or JBoss AS i= nstalled, or + those who need to install JBoss Portal in a clustered environment. + Setting up your Environment Getting the Binary - The binary download is available from the JBoss Portal Downloads page. Look for the JBoss Portal Binary package. Once the binary ZIP file has been downloaded and extracted, the= folder hierarchy will look similar to the following: - - + The binary download is available from the + + JBoss Portal Downloads + + page. Look for the + JBoss Portal Binary + package. Once the binary ZIP file has been downloaded and e= xtracted, the + folder hierarchy will look similar to the following: + + - + - - - Files contained in this download are used in later sections. Down= load and extract the JBoss Portal binary ZIP file before proceeding. + + Files contained in this download are used in later sections= . Download and + extract the JBoss Portal binary ZIP file before proceeding. + JBoss EAP and JBoss AS Setup - Before deploying JBoss Portal, make sure you have JBoss EAP or = JBoss AS installed. Customers who have access to the JBoss Customer Support Portal (CSP) are advised to download and install JBoss EAP 4.3. Customers who do = not have access to the JBoss CSP are advised to use JBoss AS. For JBoss AS installatio= n instructions, please refer to the JBoss AS Installation Guide. - - - Use the JBoss EAP and JBoss AS ZIP file - - Only use the JBoss EAP and JBoss AS ZIP file versions. DO NOT ATTEMPT to deploy JBoss Portal on the installer versi= on of JBoss EAP or JBoss AS. - - - - - Operating System Environment Settings - For JBoss EAP, JBoss AS, and build targets to work, you must confi= gure a JBOSS_HOME environment variable. This environme= nt variable must point to the root directory of the JBoss EAP or JBoss AS i= nstallation directory, which is the directory where the JBoss EAP or JBoss = AS files were extracted to. - - On Windows, this is accomplished by going to - Start > Settings > Control Panel > System > Advanced > Enviro= nment Variables. Under the - System Variables - section, click - New. Set the JBOSS_HOME - environment variable to the location of your JBoss EAP or JBoss AS inst= allation directory: - - - - - - - - To configure the JBOSS_HOME environment variable o= n Linux: - - - - - - Add the following line to the ~/.bashrc file. N= ote: this must be configured while logged in as the user who runs JBoss EAP= or JBoss AS: - - - -export JBOSS_HOME=3D/path/to/jboss/installation/ - - - - - - Run the following command to enable the JBOSS_HOME environment variable: - - - -source ~/.bashrc - - - - - - - JBoss EAP <filename>JBOSS_HOME</filename> Environment Variable</= title> - <para> - If you are running JBoss EAP, configure the <filename>JBOSS_HOME</file= name> environment variable to point to the <filename>/path/to/jboss-eap-<re= placeable>version</replaceable>/jboss-as/</filename> directory. - </para> - </note> - </sect3> + <para> + Before deploying JBoss Portal, make sure you have JBoss EAP= or JBoss AS + installed. Customers who have access to the + <ulink url=3D"https://support.redhat.com/portal/login.html"> + JBoss Customer Support Portal (CSP) + </ulink> + are advised to download and install JBoss EAP 4.3. Customer= s who do not + have access to the JBoss CSP are advised to use + <ulink url=3D"http://labs.jboss.com/jbossas/downloads/">JBo= ss AS</ulink> + . For JBoss AS installation instructions, please refer to t= he + <ulink url=3D"http://labs.jboss.com/jbossas/docs/index.html= "> + JBoss AS Installation Guide + </ulink> + . + </para> + <warning> + <title>Use the JBoss EAP and JBoss AS ZIP file + + Only use the JBoss EAP and JBoss AS ZIP file versions. + + DO NOT ATTEMPT to deploy JBoss Portal on the installe= r version of + JBoss EAP or JBoss AS. + + + + + + Operating System Environment Settings + + For JBoss EAP, JBoss AS, and build targets to work, you mus= t configure a + JBOSS_HOME + environment variable. This environment variable must point = to the root + directory of the JBoss EAP or JBoss AS installation directo= ry, which is the + directory where the JBoss EAP or JBoss AS files were extrac= ted to. + + + On Windows, this is accomplished by going to + + Start > Settings > Control Panel > System > Advanced > E= nvironment + Variables + + . Under the + System Variables + section, click + New + . Set the + JBOSS_HOME + environment variable to the location of your JBoss EAP or J= Boss AS + installation directory: + + + + + + + + To configure the + JBOSS_HOME + environment variable on Linux: + + + + + + Add the following line to the + ~/.bashrc + file. Note: this must be configured while logged i= n as the user + who runs JBoss EAP or JBoss AS: + + + + export JBOSS_HOME=3D/path/to/jboss/installation/ + + + + + + Run the following command to enable the + JBOSS_HOME + environment variable: + + + source ~/.bashrc + + + + + + + JBoss EAP + <filename>JBOSS_HOME</filename> + Environment Variable + + + If you are running JBoss EAP, configure the + JBOSS_HOME + environment variable to point to the + + /path/to/jboss-eap- + version + /jboss-as/ + + directory. + + + Database Setup - - A database is required for JBoss Portal to run. JBoss EAP and JBoss AS = include an embedded Hypersonic SQL database that JBoss Portal can use; howe= ver, this is only recommended for developer use. The following databases ar= e recommended for production use, and have had test suites run against them= : MySQL 4 and 5, Microsoft SQL= Server, PostgreSQL 8, and Orac= le Database 9 and 10. JBoss Portal can use any database that is= supported by Hibernate. - - - To configure a database to use with JBoss Portal: - - + + A database is required for JBoss Portal to run. JBoss EAP a= nd JBoss AS + include an embedded Hypersonic SQL database that JBoss Port= al can use; + however, this is only recommended for developer use. The fo= llowing + databases are recommended for production use, and have had = test suites run + against them: + MySQL + 4 and 5, + Microsoft + SQL Server + , PostgreSQL 8, and + Oracle + Database 9 and 10. JBoss Portal can use any database that i= s supported by + Hibernate. + + To configure a database to use with JBoss Portal: + - Create a new database: this gui= de assumes that the new database is called jbossportal. + Create a new database: + this guide assumes that the new database is called + jbossportal + . - Grant access rights for a user to the jbossportal database: JBoss Portal needs to cre= ate tables and modify table data. Grant access rights to a desired user to = the jbossportal database. Configure the same username = and password in the Datasource descriptor. + + Grant access rights for a user to the + jbossportal + database: + + JBoss Portal needs to create tables and modify tab= le data. Grant + access rights to a desired user to the + jbossportal + database. Configure the same username and password= in the + Datasource descriptor. - - Deploy an RDBMS J= DBC connector: an RDBMS JDBC connector is required f= or JBoss Portal to communicate with a database. Copy the connector into the= $JBOSS_HOME/server/default/lib/ directory. For exampl= e, an RDBMS JDBC connector for MySQL can be download from . For the correct RDMBS JD= BC connector, please refer to the database documentation. + + + Deploy an RDBMS + JDBC + connector: + + an RDBMS JDBC connector is required for JBoss Port= al to + communicate with a database. Copy the connector in= to the + $JBOSS_HOME/server/default/lib/ + directory. For example, an RDBMS JDBC connector fo= r MySQL can be + download from + + . For the correct RDMBS JDBC connector, please ref= er to the + database documentation. - + Datasource Descriptors - - The JBoss Portal binary download that was extracted in , contains pre-configured Datasource descriptors = for the more popular databases. Datasource descriptors are provided for the= MySQL 4 and 5, PostgreSQL, Microsoft SQL Server, and Oracle databases, and= can be found in the setup subdirectory where the JBos= s Portal binary was extracted to: - - - - - - - - Copy the Datasource descriptor that matches your database into th= e $JBOSS_HOME/server/configuration/dep= loy/ directory, where configuration i= s either all, default, minimal or production. The production configuration = only exists on JBoss EAP, and not JBoss AS. For example, if you are using t= he all configuration, copy the Datasource descriptor into the $JB= OSS_HOME/server/all/deploy/ directory. - - - After the Datasource descriptor has been copied into the deploy directory, make sure the user-name, password, co= nnection-url, and driver-class, are correct for your chosen database. Datasource descriptor files ca= n be deployed to test before being used in production. The following is an = example Datasource descriptor for a PostgreSQL database: - - - + + The JBoss Portal binary download that was extracted in + + , contains pre-configured Datasource descriptors for the mo= re popular + databases. Datasource descriptors are provided for the MySQ= L 4 and 5, + PostgreSQL, Microsoft SQL Server, and Oracle databases, and= can be found in + the + setup + subdirectory where the JBoss Portal binary was extracted to: + + + + + + + + Copy the Datasource descriptor that matches your database i= nto the + + $JBOSS_HOME/server/ + configuration + /deploy/ + + directory, where + configuration + is either all, default, minimal or production. The producti= on configuration + only exists on JBoss EAP, and not JBoss AS. For example, if= you are using + the all configuration, copy the Datasource descriptor into = the + $JBOSS_HOME/server/all/deploy/ + directory. + + + After the Datasource descriptor has been copied into the + deploy + directory, make sure the + user-name + , + password + , + connection-url + , and + driver-class + , are correct for your chosen database. Datasource descript= or files can be + deployed to test before being used in production. The follo= wing is an + example Datasource descriptor for a PostgreSQL database: + + + PortalDS @@ -197,43 +395,87 @@ portalpassword ]]> - - For further details about Datasource descriptors, please refer to= the JBoss JDBC Datasource Wiki page. - + + For further details about Datasource descriptors, please re= fer to the + + JBoss JDBC Datasource Wiki page + + . + Deploying JBoss Portal - - To start JBoss EAP or JBoss AS and deploy JBoss Portal: - + To start JBoss EAP or JBoss AS and deploy JBoss Portal: - Datasource descriptor: if you have= not done so already, change into the setup subdirecto= ry where the JBoss Portal binary was extracted to. Copy the correct Datasou= rce descriptor file (*-ds.xml) you modified in the pre= vious steps into the $JBOSS_HOME/server/configuratio= n/deploy/ directory. - - - - - Start the server: change into the <= filename>$JBOSS_HOME/bin/ directory. On Windows, execute run.bat. On Linux, run the sh run.sh command= . To specify a configuration to use, for example, the default configuration= , append the -c default option to the run.bat<= /command> or sh run.sh commands. - - - - - Log in to JBoss Portal: using a Web= browser, navigate to = to open the JBoss Portal homepage. Log in using one of the two default acco= unts: username user, password user, or username admin, password admin. - - - - - - SQL Errors - - Tables are automatically created the first time JBoss Portal starts. Wh= en deployed for the first time, JBoss Portal checks for the existence of th= e initial tables, which have not been created yet. This causes errors such = as the following, which can safely be ignored: - - - -Datasource descriptor: + if you have not done so already, change into the + setup + subdirectory where the JBoss Portal binary was extrac= ted to. Copy the + correct Datasource descriptor file ( + *-ds.xml + ) you modified in the previous steps into the + + $JBOSS_HOME/server/ + configuration + /deploy/ + + directory. + + + + + Start the server: + change into the + $JBOSS_HOME/bin/ + directory. On Windows, execute + run.bat + . On Linux, run the + sh run.sh + command. To specify a configuration to use, for examp= le, the default + configuration, append the + -c default + option to the + run.bat + or + sh run.sh + commands. + + + + + Log in to JBoss Portal: + using a Web browser, navigate to + + to open the JBoss Portal homepage. Log in using one o= f the two + default accounts: username + user + , password + user + , or username + admin + , password + admin + . + + + + + + SQL Errors + + Tables are automatically created the first time JBoss Porta= l starts. When + deployed for the first time, JBoss Portal checks for the ex= istence of the + initial tables, which have not been created yet. This cause= s errors such as + the following, which can safely be ignored: + + + + - + Installing from the Sources Getting the Sources - - The JBoss Portal source files can be obtained from the - JBoss Portal Downloads page. The source files download uses a = JBoss Portal Source Code naming convention. As well, t= he sources can be obtained from SVN. The latest sources for the 2.6.x versions are located at . - - - Several modules have been extracted from the JBoss Portal SVN reposit= ory. These modules have a different lifecycle and a different version schem= e. The following is a list of modules used in JBoss Portal 2.6.5, and the l= ocations of their source code: - - - - - - JBoss Portal Common 1.1.1: http://anonsvn.jboss.org/repo= s/portal/modules/common/tags/JBP_COMMON_1_1_1 - - - - - JBoss Portal Web 1.1.0: http://anonsvn.jboss.org/repos/p= ortal/modules/web/tags/JBP_WEB_1_1_0 - - - - - JBoss Portal Test 1.0.1: http://anonsvn.jboss.org/repos/= portal/modules/test/tags/JBP_TEST_1_0_1 - - - - - JBoss Portal Portlet 1.0.3: http://anonsvn.jboss.org/rep= os/portal/modules/portlet/tags/JBP_PORTLET_1_0_3 - - - - - JBoss Portal Identity 1.0.3: http://anonsvn.jboss.org/re= pos/portal/modules/identity/tags/JBP_IDENTITY_1_0_3 - - - - - - After checking out the source from SVN, or after extracting the JBoss Portal Source Code ZIP file, a directory structure sim= ilar to the following will be created: - - - - - - - - If the source files were obtained from SVN, change into the trunk/src/ directory to see the directories from the above ima= ge. As well, there is an empty thirdparty directory. T= his directory contains files after building the JBoss Portal source code (r= efer to ). For more info= rmation about the JBoss Portal SVN repository, and accessing different vers= ions of the JBoss Portal codebase, refer to the JBoss Portal SVN Repo = page on the JBoss Wiki. - - + + The JBoss Portal source files can be obtained from the + + JBoss Portal Downloads + + page. The source files download uses a + JBoss Portal Source Code + naming convention. As well, the sources can be obtained from S= VN. The latest + sources for the 2.7. + x + versions are located at + + . + + + Several modules have been extracted from the JBoss Portal SVN = repository. + These modules have a different lifecycle and a different versi= on scheme. The + following is a list of modules used in JBoss Portal 2.7.0, and= the locations + of their source code: + + + + + + JBoss Portal Common 1.2.0: + + http://anonsvn.jboss.org/repos/portal/modules/comm= on/tags/JBP_COMMON_1_2_0 + + + + + + JBoss Portal Web 1.2.0: + + http://anonsvn.jboss.org/repos/portal/modules/web/= tags/JBP_WEB_1_2_0 + + + + + + JBoss Portal Test 1.0.2: + + http://anonsvn.jboss.org/repos/portal/modules/test= /tags/JBP_TEST_1_0_2 + + + + + + JBoss Portal Portlet 2.0.1: + + http://anonsvn.jboss.org/repos/portal/modules/port= let/tags/JBP_PORTLET_2_0_1 + + + + + + JBoss Portal Identity 1.0.4: + + http://anonsvn.jboss.org/repos/portal/modules/iden= tity/tags/JBP_IDENTITY_1_0_4 + + + + + + + After checking out the source from SVN, or after extracting the + JBoss Portal Source Code + ZIP file, a directory structure similar to the following will = be created: + + + + + + + + If the source files were obtained from SVN, change into the + trunk/src/ + directory to see the directories from the above image. As well= , there is an + empty + thirdparty + directory. This directory contains files after building the JB= oss Portal + source code (refer to + + ). For more information about the JBoss Portal SVN repository,= and accessing + different versions of the JBoss Portal codebase, refer to the + + JBoss Portal SVN Repo + + page on the JBoss Wiki. + + - JBoss EAP and JBoss AS Setup + JBoss EAP and JBoss AS Setup JBoss Application Server Setup - Before deploying JBoss Portal, make sure you have JBoss EAP or = JBoss AS installed. Customers who have access to the JBoss Customer Support Portal (CSP) are advised to download and install JBoss EAP 4.3. Customers who do = not have access to the JBoss CSP are advised to use JBoss AS. For JBoss AS installatio= n instructions, please refer to the JBoss AS Installation Guide. - - - Use the JBoss EAP and JBoss AS ZIP file - - Only use the JBoss EAP and JBoss AS ZIP file versions. DO NOT ATTEMPT to deploy JBoss Portal on the installer version = of JBoss EAP or JBoss AS. We are currently working on aligning t= he Application installer with JBoss Portal. - - + + Before deploying JBoss Portal, make sure you have JBoss EAP= or JBoss AS + installed. Customers who have access to the + + JBoss Customer Support Portal (CSP) + + are advised to download and install JBoss EAP 4.3. Customer= s who do not + have access to the JBoss CSP are advised to use + JBo= ss AS + . For JBoss AS installation instructions, please refer to t= he + + JBoss AS Installation Guide + + . + + + Use the JBoss EAP and JBoss AS ZIP file + + Only use the JBoss EAP and JBoss AS ZIP file versions. + + DO NOT ATTEMPT to deploy JBoss Portal on the installe= r version of + JBoss EAP or JBoss AS. + + We are currently working on aligning the Application ins= taller with + JBoss Portal. + + Operating System Environment Settings - For JBoss EAP, JBoss AS, and build targets to work, you must co= nfigure a JBOSS_HOME environment variable. This enviro= nment variable must point to the root directory of the JBoss EAP or JBoss A= S installation directory, which is the directory where the JBoss EAP or JBo= ss AS files were extracted to. - - On Windows, this is accomplished by going to - Start > Settings > Control Panel > System > Advan= ced > Environment Variables. Under the + + For JBoss EAP, JBoss AS, and build targets to work, you mus= t configure a + JBOSS_HOME + environment variable. This environment variable must point = to the root + directory of the JBoss EAP or JBoss AS installation directo= ry, which is the + directory where the JBoss EAP or JBoss AS files were extrac= ted to. + + + On Windows, this is accomplished by going to + + Start > Settings > Control Panel > System > Advanced > E= nvironment + Variables + + . Under the System Variables section, click - New. Set the JBOSS_HOME - environment variable to the location of your JBoss EAP or J= Boss AS installation directory: + New + . Set the + JBOSS_HOME + environment variable to the location of your JBoss EAP or J= Boss AS + installation directory: - + - To configure the JBOSS_HOME environment variabl= e on Linux: - - - - - - Add the following line to the ~/.bashrc file= . Note: this must be configured while logged in as the user who runs JBoss = EAP or JBoss AS: - - - -export JBOSS_HOME=3D/path/to/jboss/installation/ - - - - - - Run the following command to enable the JBOSS_HOME environment variable: - - - -source ~/.bashrc - - - - - - - JBoss EAP <filename>JBOSS_HOME</filename> Environment Variable<= /title> - <para> - If you are running JBoss EAP, configure the <filename>JBOSS_HOME</fil= ename> environment variable to point to the <filename>/path/to/jboss-eap-<r= eplaceable>version</replaceable>/jboss-as/</filename> directory. - </para> - </note> - </sect3> + To configure the + <filename>JBOSS_HOME</filename> + environment variable on Linux: + </para> + <para> + <orderedlist> + <listitem> + <para> + Add the following line to the + <filename>~/.bashrc</filename> + file. Note: this must be configured while logged i= n as the user + who runs JBoss EAP or JBoss AS: + </para> + <para> + <programlisting> + export JBOSS_HOME=3D/path/to/jboss/installation/ + </programlisting> + </para> + </listitem> + <listitem> + <para> + Run the following command to enable the + <filename>JBOSS_HOME</filename> + environment variable: + </para> + <para> + <programlisting>source ~/.bashrc</programlisting> + </para> + </listitem> + </orderedlist> + </para> + <note> + <title> + JBoss EAP + <filename>JBOSS_HOME</filename> + Environment Variable + + + If you are running JBoss EAP, configure the + JBOSS_HOME + environment variable to point to the + + /path/to/jboss-eap- + version + /jboss-as/ + + directory. + + + - + Building and Deploying from the Sources - - During the first build, third-party libraries are obtained from an onli= ne - repository, so you must be connected to the Internet, and if you are be= hind a proxy server, you need to define your proxy server address and proxy= server port number. To define a proxy server, add the following line to th= e $JBOSS_HOME/bin/run.conf file: - - - - - - - Replace proxy-hostname with the proxy server= 's hostname, and proxy-port with the correct pro= xy server port number. - - To build and deploy JBoss Portal from the sources, change into the = JBOSS_PORTAL_SOURCE_DIRECTORY/build/ directory, where= JBOSS_PORTAL_SOURCE_DIRECTORY is the directory where = the JBoss Portal source code was downloaded to. Then, Windows users need to= run the build.bat deploy command, and Linux users need = to run the sh build.sh deploy command. - - - At the end of the build process, the jboss-portal.sar file is copied into the $JBOSS_HOME/server/default/deploy/ directory: - - - - - - + + During the first build, third-party libraries are obtained fro= m an online + repository, so you must be connected to the Internet, and if y= ou are behind a + proxy server, you need to define your proxy server address and= proxy server + port number. To define a proxy server, add the following line = to the + $JBOSS_HOME/bin/run.conf + file: + + + + + + + + + + Replace + proxy-hostname + with the proxy server's hostname, and + proxy-port + with the correct proxy server port number. + + + To build and deploy JBoss Portal from the sources, change into= the + JBOSS_PORTAL_SOURCE_DIRECTORY/build/ + directory, where + JBOSS_PORTAL_SOURCE_DIRECTORY + is the directory where the JBoss Portal source code was downlo= aded to. Then, + Windows users need to run the + build.bat deploy + command, and Linux users need to run the + sh build.sh deploy + command. + + + At the end of the build process, the + jboss-portal.sar + file is copied into the + $JBOSS_HOME/server/default/deploy/ + directory: + + + + + + - - - - Portal Modules - - The previous steps install a bare version of JBoss Portal. In previous v= ersions, several additional modules were deployed as well, but this has sin= ce been modularized to provide greater flexibility. To deploy additional mo= dules, refer to the Portal's module list for more information. To dep= loy all modules at once, change into the build directo= ry. If you are running Linux, run the sh build.sh deploy-all command. On Windows, run the build.bat deploy-all c= ommand. - = - - - - To build the clustered version on Linux operating systems: - - - - - - Change into the JBOSS_PORTAL_SOURCE_DIRECTORY/build/ directory, and run the following command: - - - -sh build.sh main - - - - - - Change into the JBOSS_PORTAL_SOURCE_DIRECTORY/core/ directory, and run the following command: - - - -sh build.sh deploy-ha - = - - - After the sh build.sh deploy-ha command completes,= the jboss-portal-ha.sar file is copied into the $JBOSS_HOME/server/all/deploy/ directory. - - - - - - To build the clustered version on Windows, repeat the previous steps, r= eplacing sh build.sh with build.bat. - - - - Database Setup - - A database is required for JBoss Portal to run. JBoss EAP and JBoss AS i= nclude an embedded Hypersonic SQL database that JBoss Portal can use; howev= er, this is only recommended for developer use. The following databases are= recommended for production use, and have had test suites run against them:= MySQL 4 and 5, Microsoft SQL Server, PostgreSQL 8, and Oracle Database 9 a= nd 10. JBoss Portal can use any database that is supported by Hibernate. - - - To configure a database to use with JBoss Portal: - - - - - - Create a new database: this gu= ide assumes that the new database is called jbossportal. - - - - - Grant access rights for a user to the jbossportal database: JBoss Portal needs to cr= eate tables and modify table data. Grant access rights to a desired user to= the jbossportal database. Configure the same username= and password in the Datasource descriptor. - - - - - Deploy an RDBMS JDBC connector: an RDBMS JDBC connector is required for JBoss Portal to communicate with = a database. Copy the connector into the $JBOSS_HOME/server/defaul= t/lib/ directory. For example, an RDBMS JDBC connector for MySQL= can be download from . For the correct RDMBS JDBC connector, please refer to the da= tabase documentation. - - - - - - - Datasource Configuration - - The JBoss Portal binary download that was extracted in , contains pre-configured Datasource descripto= rs for the more popular databases. Datasource descriptors are provided for = the MySQL 4 and 5, PostgreSQL, Microsoft SQL Server, and Oracle databases, = and can be found in the setup subdirectory where the J= Boss Portal binary was extracted to: - - - - - - - - Copy the Datasource descriptor that matches your database into the $JBOSS_HOME/server/configuration/deploy/<= /filename> directory, where configuration is eit= her all, default, minimal, or production. For example, if you are using the= production configuration, copy the Datasource descriptor into the $JBOSS_HOME/server/production/deploy/ directory. The productio= n configuration only exists on JBoss EAP installations, and not JBoss AS. - - - After the Datasource descriptor has been copied into the dep= loy directory, make sure the user-name, password, connect= ion-url, and driver-class= , are correct for your chosen database. Datasource descriptor files can be = deployed to test before being used in production. The following is an examp= le Datasource descriptor for a PostgreSQL database: - - - - - PortalDS - jdbc:postgresql:jbossportal - org.postgresql.Driver - portal - portalpassword - - - ]]> - - For further details about Datasource descriptors, please refer to t= he JBoss JDBC Datasource Wiki page. - - - - - Deploying JBoss Portal - - To start JBoss EAP or JBoss AS and deploy JBoss Portal: - - - - - - Datasource descriptor: if yo= u have not done so already, change into the setup subd= irectory where the JBoss Portal binary was extracted to. Copy the correct D= atasource descriptor file (*-ds.xml) you modified in t= he previous steps into the $JBOSS_HOME/server/config= uration/deploy/ directory. - - - - - Start the server: change int= o the $JBOSS_HOME/bin/ directory. On Windows, execute = run.bat. On Linux, run the sh run.sh = command. To specify a configuration to use, for example, the default config= uration, append the -c default option to the r= un.bat or sh run.sh commands. - - - - - Log in to JBoss Portal: usin= g a Web browser, navigate to to open the JBoss Portal homepage. Log in using one of the two defau= lt accounts: username user, password user, or username admin, password admin<= /emphasis>. - - - - - - SQL Errors - - Tables are automatically created the first time JBoss Portal star= ts. When deployed for the first time, JBoss Portal checks for the existence= of the initial tables, which have not been created yet. This causes errors= such as the following, which can safely be ignored: - - - - - - - - - Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/s= upported.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/support= ed.xml 2008-07-15 14:12:50 UTC (rev 11451) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/support= ed.xml 2008-07-15 15:49:02 UTC (rev 11452) @@ -36,7 +36,7 @@ JBoss Application Server - JBoss Portal 2.6.5 is tested with JBoss Application Server (AS= ) 4.2.1, JBoss AS 4.2.2, JBoss Enterprise Application Platform (EAP) 4.2 an= d JBoss EAP 4.3. It is highly recommended that customers who have access to= the JBoss Cust= omer Support Portal (CSP) use JBoss EAP 4.3 (It is mandatory to get= access to professional support). Customers who do not have access to the J= Boss CSP should use JBoss AS<= /ulink>. + JBoss Portal 2.7.0 is tested with JBoss Application Server (AS= ) JBoss AS 4.2.2, JBoss Enterprise Application Platform (EAP) 4.2 and JBoss= EAP 4.3. It is highly recommended that customers who have access to the JBoss Customer Su= pport Portal (CSP) use JBoss EAP 4.3. Customers who do not have acc= ess to the JBoss CSP should use JBoss AS. JBoss AS versions 4.0.x are not = supported. --===============4805004594700478564==--