Added: portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/applications/jsaudit.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/applications/jsaudit.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/applications/jsaudit.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/applications/jsaudit.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,67 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Jetspeed Auditing Reports</title> + <subtitle>Welcome to Jetspeed Auditing Reports App</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]" /> + </authors> + </properties> + <body> +<section name="Catalog of Jetspeed Auditing Reports"> +<p>This portlet application provides a set of report portlets for querying information gathering during administrative operations of the portal.</p> +<table> +<tr> +<th>Portlet</th> +<th>Description</th> +</tr> +<tr> +<td>AdminActivityReport</td> +<td>Filtered Report displaying activity of administrators like adding and removing users, adding roles to users, resetting passwords, updating security attributes. Displays before and after values when applicable, as well as timestamp, IP address.</td> +</tr> +<tr> +<td>PasswordResetReport</td> +<td>Presents a Password Reset activity report on the queried user(s) displaying information about when a password was last reset and by whom (administrator or user), shows IP address from where user reset password</td> +</tr> +<tr> +<td>SystemSecurityReport</td> +<td>Presents a system security report on the queried user(s) displaying general system security settings: password expire date, number of attempted logins, and security policy settings: lockout duration policy, password complexity, user id complexity, password history</td> +</tr> +<tr> +<td>UserCreationReport</td> +<td>Presents a User Creation activity report on the queried user(s) displaying a log of all user creation activity with timestamps, and which admin user created the user from which IP address</td> +</tr> +<tr> +<td>UserDeletionReport</td> +<td>Presents a User Deletion activity report on the queried user(s) displaying a log of all user deletion activity with timestamps, and which admin user deleted the user from which IP address</td> +</tr> +<tr> +<td>UserStatusReport</td> +<td>Presents user login statistics (filtered) about all users who have visited the portal including name, email, last login timestamp, last login IP, last password change timestamp, user status (enabled/disabled), created by administrator</td> +</tr> +</table> +<subsection name='Excel Reports'> +<p>In order to view the Excel reports, you will need to set this property in the WEB-INF/conf/override.properties:</p> +<p> +merge.portal.parameters.with.portlet.parameters=<b>true</b> +</p> +</subsection> +</section> +</body> +</document> \ No newline at end of file
Added: portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/applications/mfa.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/applications/mfa.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/applications/mfa.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/applications/mfa.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,204 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Jetspeed MFA Portlet App</title> + <subtitle>Welcome to Jetspeed Portlet Application Multifaceted Authentication</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Using the Jetspeed MFA Portlet"> + <p>This portlet application provides multi-faceted login portlet functionality including captcha and personal questions. Since this is a login portlet, it has minimal hooks to authenticate against Jetspeed. You should be able to easily adapt this portlet application to other portals by changing the authentication code.</p> + <subsection name='Usage with Jetspeed'> + <p>There is one portlet found in the portlet.xml: <b>MFALogin</b>. This portlet is configured in the portlet.xml with the following init parameters:</p> +<table> +<tr> +<th>param name</th> +<th>default value</th> +<th>description</th> +</tr> +<tr> +<td>cookieLifetime</td> +<td>345600</td> +<td>The lifetime of the stored cookie in seconds (4 days)</td> +</tr> +<tr> +<td>maxNumberOfAuthenticationFailures</td> +<td>5</td> +<td>Maximum number of authentication failures before disabling a user</td> +</tr> +<tr> +<td>randomQuestions</td> +<td>What was the first and last name of our favorite teacher? In what city did you get married? ...</td> +<td>A list of 24 personal questions which will be displayed to the user in random order separated by question marks (?)</td> +</tr> +</table> +<p><b>IMPORTANT</b>The Jetspeed web.xml must be modified. The <i>LoginProxyServlet</i> servlet must have its <i>credentialsFromRequest</i> init param set to false:</p> +<source><![CDATA[ +<servlet> + <servlet-name>LoginProxyServlet</servlet-name> + <servlet-class>org.apache.jetspeed.login.LoginProxyServlet</servlet-class> + <init-param> + <param-name>credentialsFromRequest</param-name> + <param-value>false</param-value> + </init-param> +</servlet> +]]></source> + </subsection> + <subsection name='Captcha'> +<p> +The following Captcha properties are configured in the mfa.properties found in the WEB-INF directory of your web application. +</p> +<h2>Property File</h2> +<table border='1'> +<tr> +<th>Property</th> +<th>Default Value</th> +<th>Description</th> +<tr> +<td>captcha.directory</td> +<td>/captchas</td> +<td>The directory where all captchas will be stored when generated. For web applications, this directory should be a in a public viewable area. +The directory name is relative to either the running program, or in the case of a web application, relative to the root of the web application</td> +</tr> +<tr> +<td>captcha.effects.noise</td> +<td>false</td> +<td>Turn on the default noise generation for a capcha. Noise generation is not yet configurable to a fine grain but instead enables a set of general noise algorithms including +drawing an XORed oval behind the text, and generating gray noise throughout the image. +This feature is turned off by default and should not be used with an image background.</td> +</tr> +<tr> +<td>captcha.image.background</td> +<td>images/jetspeedlogo98.jpg</td> +<td>Uses an image file as the background for the capcha image. The default provide is a company logo that has been run through a matte effect.</td> +</tr> +<tr> +<td>captcha.image.background.use</td> +<td>true</td> +<td>Enable or disable using the background image defined in the captcha.image.background property.</td> +</tr> +<tr> +<td>catcha.image.format</td> +<td>.jpg</td> +<td>The image format of the output captcha file. Known supported formats are .jpg and .png</td> +</tr> +<tr> +<td>captcha.font.antialiasing</td> +<td>true</td> +<td>Enable or disable antialiasing. By enabling, you will generate a clearer image at the cost of slower rendering times.</td> +</tr> +<tr> +<td>captcha.font.size</td> +<td>36</td> +<td>The point size of the font.</td> +</tr> +<tr> +<td>captcha.font.style</td> +<td>0</td> +<td>The style of the font. Valid values are: PLAIN == 0, BOLD == 1, ITALIC == 2, BOLD_ITALIC == 3</td> +</tr> +<tr> +<td>captcha.font.names</td> +<td>Times</td> +<td>A comma-separated list of font names. Make sure your server supports all listed fonted. When more than one font listed, fonts will be randomized.</td> +</tr> +<tr> +<td>captcha.scanrate.seconds</td> +<td>300</td> +<td>Configures the cleanup thread for removal of captchas images. The cleanup thread will run by default every 300 seconds.</td> +</tr> +<tr> +<td>captcha.timetolive.seconds</td> +<td>120</td> +<td>Configures the lifetime of a captcha image. Default is 120 seconds before it is deleted.</td> +</tr> +<tr> +<td>captcha.text.maxlength</td> +<td>8</td> +<td>The maximum number of characters generated for the captcha string. Randomly used with captcha.text.minlength to vary the size of the captcha string.</td> +</tr> +<tr> +<td>captcha.text.margin.left</td> +<td>2</td> +<td>The left-side margin where to start drawing the captcha string in in a device-independent coordinates.</td> +</tr> +<tr> +<td>captcha.text.margin.bottom</td> +<td>10</td> +<td>The bottom margin where to start drawing the captcha string in in a device-independent coordinates.</td> +</tr> +<tr> +<td>captcha.text.minlength</td> +<td>6</td> +<td>The minimum number of characters generated for the captcha string. Randomly used with captcha.text.maxlength to vary the size of the captcha string.</td> +</tr> +<tr> +<td>captcha.text.rise.range</td> +<td>30</td> +<td>The rise from the bottom margin where to start drawing the captcha string. Setting to zero turns off the rising feature. +If a positive number is used, the rise will randomly vary between the bottom margin and maximum rise value.</td> +</tr> +<tr> +<td>captcha.text.rotation</td> +<td>10</td> +<td>Sets the rotation (vertical alignment variance) of a glyph to control this. The value is in radians. +Value should be a positive number or zero. For example, setting to 35, will rotate the glyph randomly between -35 and 35 radians. +Setting this value to 0 will turn off rotation. +</td> +</tr> +<tr> +<td>captcha.text.shear</td> +<td>0</td> +<td>Shearing slides one edge of an image along the X or Y axis, creating a parallelogram. +The default value is 0, turning off all shearing effects. Shearing effects can make it more difficult for non-human readers to read the image. +Shear values are specified in radians, with values closer to 1.0 creating a more drastic shearing effect.</td> +</tr> +<tr> +<td>captcha.text.spacing</td> +<td>2</td> +<td>The space between captcha characters in device-independent coordinates. 0 is a valid value, but can make it difficult to read glyphes when combined with rotations.</td> +</tr> +<tr> +<td>captcha.timestamp</td> +<td>true</td> +<td>Boolean value to enable printing a timestamp at the bottom of the captcha image in a small monospaced font.</td> +</tr> +<tr> +<td>captcha.timestamp.24hr</td> +<td>true</td> +<td>Boolean value set to true when using 24 hour clock on timestamp, otherwise 12 hour clock.</td> +</tr> +<tr> +<td>captcha.timestamp.tz</td> +<td>America/New_York</td> +<td>The Time Zone ID (TZID). The timestamp will be displayed for this timezone. You can also use timezone abbreviations such as EDT (Eastern Daylight Time).</td> +</tr> +<td>captcha.timestamp.font.size</td> +<td>8</td> +<td>The font size of the timestamp.</td> +</tr> + +</table> + + </subsection> + </section> + </body> +</document> \ No newline at end of file Added: portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/demo.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/demo.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/demo.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/demo.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,42 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Jetspeed Demos</title> + <subtitle>Live Jetspeed Demos</subtitle> + <authors> + <person name="David Le Strat" email="[email protected]" /> + <person name="Philip Mark Donaghy" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Live Jetspeed Demo"> + <p>To get a quick look at the Jetspeed decorators, themes, + <a href="features.html">functionalities</a>, + and the admin interface point your browser to + <ul> + <li> + <a href="http://portals.zones.apache.org/jetspeed/ui/";>the Jetspeed latest Demo Portal</a></li> + </ul> + Use the username <i>admin</i> connects using the password <i>j2</i>. Note: It is probable that + someone changes the password therefore we will regenerate the site on a regular basis. + </p> + </section> + </body> +</document> + Added: portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/documentation.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/documentation.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/documentation.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/documentation.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,98 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Documentation for Jetspeed 2</title> + <subtitle>Documentation Guideline</subtitle> + <authors> + <person name="David Le Strat" email="[email protected]" /> + <person name="Ate Douma" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Documentation Process Overview"> + <p> + Documentation is critical to make Jetspeed's adoption as smooth as possible. Jetspeed documentation + process can be found + <a href="http://wiki.apache.org/portals/Jetspeed2/DocumenationProcessWebsite";>on Jetspeed's Wiki</a>. + Please submit documentation patches, or contribute to the Wiki. + </p> + </section> + <section name="Generating full Site Documentation"> + <p> + To generate the full site documentation for Jetspeed run the following maven command: + </p> + <source> + <![CDATA[ +maven allSite]]> + </source> + <p> + Note: make sure Jetspeed builds without problems as this goal will take quite some time. + </p> + <p> + To speed up this goal, I recommend running it without an internet connection (link checks can take very long) + and with maven.mode.online=false (or use -o on the commandline). + </p> + </section> + <section name="Generating PDF Documentation"> + <subsection name="Installing Maven PDF Plugin"> + <p>If you are using Maven 1.0 or above, to automatically install the plugin, type the following on a single line:</p> + <source> + <![CDATA[ +maven plugin:download -DgroupId=maven -DartifactId=maven-pdf-plugin + -Dversion=2.3]]> + </source> + <p> + Once, the plugin is install copy xalan.jar to the ${MAVEN_HOME}/lib/endorsed. When build Jetspeed, Xalan is download as a dependency. You + can copy the Jetspeed version of Xalan from + <code>${REPO_HOME}/xalan/jars</code> + . + </p> + <p> + More information on the PDF plugin can be found + <a href="http://maven.apache.org/reference/plugins/pdf/";>on the Maven PDF plugin site</a> + . + </p> + </subsection> + <subsection name="Generating the PDF documentation"> + <p>To create the PDF documentation for a specific component, go to the component root directory and run:</p> + <source> + <![CDATA[ +maven pdf]]> + </source> + </subsection> + </section> + <section name="Updating the website"> + <p> + Once you generated a new version of the site documentation, you can bring it online as follows: + </p> + <ul> + <li>(tar.g)zip the contents of ${JETSPEED_2_HOME}/target/docs</li> + <li>upload the resulting archive on people.apache.org</li> + <li>extract the archive in /www/portals.apache.org/jetspeed-2</li> + </ul> + <p> + More information can be found at: <a href="http://www.apache.org/dev/committers.html#web";>Committers' FAQ</a> + </p> + <p> + Note: the above link points at information assuming the site itself is under svn. For Jetspeed-2 this + isn't (yet) the case. + </p> + </section> + </body> +</document> \ No newline at end of file Added: portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/download.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/download.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/download.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/download.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,144 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>How to Download Jetspeed-2</title> + <subtitle>Documentation on How to Download Jetspeed-2</subtitle> + <authors> + <person name="David Le Strat" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Download Jetspeed-2 Distribution"> + <p> + Jetspeed-2 is distributed in several formats for your + convenience and distributed under the + <a href="license.html"> + Apache License, version 2.0 + </a> + . + </p> + <p> + With version 2.2.2, there is a single binary distribution: an installer. From the installation program, you can choose either the demo or minimal installation. + The demo option is best for seeing more features, capabilities, and demo portlet applications. + The minimal option could be useful for basing your own custom-portal distribution upon, or just seeing the basic feature set of Jetspeed. + <ol> + <li>Minimal Installer Option - only contains a Jetspeed Portal and the Jetspeed Administrative Portlets, with a minimal Site map and set of users</li> + <li>Full or Demo Option - contains a Jetspeed Portal, the Jetspeed Administrative Portlets, a full demo Site Map, 10 users. Additionally, + there several portlet applications including an RSS application, a Database Browser application, a Web Content application, and a set of demo portlets + including Google Maps, weather portlets, and lots of programming examples to get you started. + </li> + </ol> + </p> + <subsection name="Jetspeed-2 2.3.0 Installer Distribution"> + <table> + <tr> + <th>Distribution</th> + <th>Mirrors</th> + <th>Checksum</th> + <th>Signature</th> + </tr> + <tr> + <td>Jetspeed-2 Standard Installer with both Minimal and Demo choices</td> + <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/binaries/jetspeed-installer-2.3.0.jar";>jetspeed-installer-2.2.2.jar</a></td> + <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-installer-2.3.0.jar.md5";>here</a></td> + <td><a href="http://www.apache.org/dist/portals/jetspeed-2/binaries/jetspeed-installer-2.3.0.jar.asc";>here</a></td> + </tr> + </table> + <p> + The installer supports the following databases: Derby (default), DB2, MySQL, MSSQL, Oracle, PostgreSQL, SapDB, + as well as manual (do it yourself) configuration of other databases. + </p> + <p>An Ant script is provided for after installation, reinitializing or switching to another database in a one simple step operation. + </p> + <p>Complete instructions for getting started using the installer is available <a href="getting-started-installer.html">here</a>.</p> + </subsection> + <subsection name="Jetspeed-2 2.3.0 Portal Source Distribution"> + <table> + <tr> + <th/> + <th>Mirrors</th> + <th>Checksum</th> + <th>Signature</th> + </tr> + <tr> + <td>jetspeed-2-2.3.0-source-release.zip</td> + <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/sources/jetspeed-2-2.3.0-source-release.zip";>here</a></td> + <td><a href="http://www.apache.org/dist/portals/jetspeed-2/sources/jetspeed-2-2.3.0-source-release.zip.md5";>here</a></td> + <td><a href="http://www.apache.org/dist/portals/jetspeed-2/sources/jetspeed-2-2.3.0-source-release.zip.asc";>here</a></td> + </tr> + </table> + </subsection> + <subsection name="J2-admin 2.3.0 Portal Administration Source Distribution"> + <table> + <tr> + <th/> + <th>Mirrors</th> + <th>Checksum</th> + <th>Signature</th> + </tr> + <tr> + <td>j2-admin-2.3.0-source-release.zip</td> + <td><a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/sources/j2-admin-2.3.0-source-release.zip";>here</a></td> + <td><a href="http://www.apache.org/dist/portals/jetspeed-2/sources/j2-admin-2.3.0-source-release.zip.md5";>here</a></td> + <td><a href="http://www.apache.org/dist/portals/jetspeed-2/sources/j2-admin-2.3.0-source-release.zip.asc";>here</a></td> + </tr> + </table> + </subsection> + <subsection name="System Requirements"> + <p> + The list of systems requirements for Jetspeed-2 is available <a href="getting-started.html#Requirements">here</a>. + </p> + </subsection> + <subsection name="Migrating Guide"> + <p> + Important information for migrating existing Jetspeed-2.0, 2.1.x, 2.2.x installations to Jetspeed-2.3 is provided in the <a href="guide-migration.html">migration guide</a>. + </p> + </subsection> + <subsection name="Verify the integrity of the files"> + <p> + It is essential that you verify the integrity of the downloaded files using the PGP or MD5 signatures. + Please read <a href="http://www.apache.org/info/verification.html";>Verifying Apache Software Foundation Releases</a> + for more information on why you should verify our releases. + </p> + <p> + The PGP signatures can be verified using PGP or GPG. + First download these <a href="http://www.apache.org/dist/portals/jetspeed-2/KEYS";>KEYS</a> as well as the asc signature file for the relevant distribution. + Make sure you get these files from the main distribution site, rather than from a mirror. + Then verify the signatures using + <source><![CDATA[ % pgpk -a KEYS + % pgpv downloaded_file.asc +or + % pgp -ka KEYS + % pgp downloaded_file.asc +or + % gpg --import KEYS + % gpg --verify downloaded_file.asc]]></source> + </p> + <p> + Alternatively, you can verify the MD5 signature on the files. A unix program called md5 or md5sum is included in many unix distributions. + It is also available as part of <a href="http://www.gnu.org/software/textutils/textutils.html";>GNU Textutils</a>. + Windows users can get binary md5 programs from <a href="http://www.fourmilab.ch/md5/";>here</a>, + <a href="http://www.pc-tools.net/win32/freeware/console/";>here</a>, or <a href="http://www.slavasoft.com/fsum/";>here</a>. + </p> + </subsection> + </section> + + </body> +</document> + Added: portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/faq.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/faq.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/faq.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/faq.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,132 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Frequently Asked Questions</title> + <subtitle>Jetspeed-2 FAQs</subtitle> + <authors> + <person name="David Le Strat" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="How do I create new users, roles, and groups?"> + <p>There are several ways to create new users, roles and groups:</p> + <ul> + <li>With the administrative user/role/group browser/details portlets</li> + <li>With the self-registration portlet</li> + <li>With Jetspeed Seed Data</li> + <li>Programmatically, writing your own portlet</li> + </ul> + <subsection name='Administrative Portlets'> + <p>Creating a new user with the Administrative portlets is easy: + </p> + <ul> + <li>Login as admin (the default password is admin)</li> + <li>From the LHS menu, navigate to the <b>Jetspeed Administrative Portlets</b> link</li> + <li>The User Management page is the first tab on the administrative menu across the top</li> + <li>Here you see the User Browser on the left, and the User Details on the right</li> + </ul> + <p>From here you can create a new user. Choose a unique username with no spaces. Then enter a secure password. + You can require the password to be changed on the first login. You can also select the default role assigned to this user, + as well as a default profiling rule. Last, you can assign this user to a subsite</p> + <img src="adminguide/images/add-user.png"/> + <p>Going into edit mode, you an further configure the User Details portlet. Note that the following fields can be defaulted: + </p> + <img src="adminguide/images/add-user-editmode.png"/> + <ul><li>Default Role for New User</li> + <li>Required Role for New User (not shown on view mode)</li> + <li>Default Profile for new user</li> + <li>New User Template Directory - leave blank to not use a template</li> + <li>Subsite Root Folder</li> + <li>Default Subsite for new user</li> + </ul> + <p>The User Details configuration is useful for delegated security scenarios. For example, setting up a User Management page for all users + with the <i>Developer</i> role. First, setup the User Browser preference to FilterByRole on <i>Developer</i>. Then you can assign a default role, + required role, new user template, and subsite area all for new developers, managed by a user with the <i>DeveloperManager</i> role. This user + then can create only developer type users complete with the correct roles and user templates. The edit mode of the User Details portlet can be + secured so that the global admin can only edit the configuration, limiting the development manager to only creating or deleting developers</p> + <p>The Group and Role administration pages work similarly to the User administration page. You can add/edit/delete both groups and roles</p> + </subsection> + <subsection name='Self-Registration portlet'> + <p>Users can also be created in the portal by the end user, requiring no administrative actions. Self-registration is probably one of the most customization + areas of the portal, as all portals have different requirements for self-registration. The self-registration portlet also has preferences that + can be configured by the administrator: + <ul> + <li>A list of one or more groups</li> + <li>A list of one or more roles comma-separated</li> + <li>A subsite root folder</li> + <li>A boolean flag to send email notification or not</li> + <li>A new user template</li> + <li>Profiling rule names and values comma-seperated</li> + </ul> + </p> + </subsection> + <!-- + <subsection name='Populating Users, Groups and Roles with XML Seed Data'> + <p>The <i>out of the box</i> default Users, Groups and Roles are originally populated into the Jetspeed Portal during the installation process as well as during the Jetspeed build. + There are specific targets in the build which populate the default <i>seed</i> data from XML files. The installer uses the same XML files to populate the seed data. + Lets take a look at what the seed data looks like for roles: + </p> + </subsection> + <subsection name='Creating users, groups, roles programmatically'> + </subsection> + </section> + <section name='How do I create security constraints?'> + </section> + <section name='How do I create profiles?'> + <p>What happens if it fails in the Profiler Admin</p> + </section> + <section name='How do I debug decorators?'> + </section> + <section name='Where to debug when Jetspeed wonât get started?'> + </section> + <section name='What to do when Jetspeed does not show portlets that you have deployed?'> + </section> + <section name='How do I turn the feature to Clear All Window States and Portlet Modes when Navigating (changing) pages?'> + <ul> + <li>1. In pipelines.xml, edit the <b>pageHistoryValve</b> bean. Set the <b>valveDisabled</b> flag to false.</li> + <li>2. In portal-url-generation.xml, edit the <b>NavigationalState</b> bean. Modify the <b>NavigationalState</b>, changing the constructor-arg 3 to the boolean value true. + </li> + </ul> + </section> + <section name='How do I turn the feature to Maximize on Edit mode and Edit Defaults mode?'> + <ul> + <li></li> + <li> + </li> + </ul> + </section> + <section name='How do I turn the feature to Maximize on Edit mode, Edit Defaults and Configure modes?'> + <ul> + <li></li> + <li> + </li> + </ul> + </section> + <section name='How do I turn the feature - Auto-switching for Edit Defaults and Configure modes?'> + <ul> + <li></li> + <li> + </li> + </ul> + </section> + --> + </section> + </body> +</document> + Added: portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/features.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/features.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/features.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/features.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,282 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Features</title> + <subtitle>Features</subtitle> + <authors> + <person name="David Le Strat" email="[email protected]" /> + <person name="Marky Goldstein" email="[email protected]" /> + <person name="David Sean Taylor" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Features"> + <p> + The Apache Portals Jetspeed Team is pleased to present the Jetspeed-2 Open Source Enterprise Portal. This open source project has matured past several releases, + and has been fully-compliant with the Portlet Specification 1.0 (JSR-168) since version 2.0. + Jetspeed-2 passes the TCK (Test Compatibility Kit) suite and is fully CERTIFIED to the Java Portlet Standard. + </p> + <p>Jetspeed is fully-compliant with the Portlet Specification 2.0 (JSR-286), pasing the Portlet 2.0 TCK (Test Compatibility Kit) suite and is fully CERTIFIED to the Java Portlet Standard. + </p> + + <subsection name='New Features for 2.3.0'> + <p> + Overview of new features in version 2.3.0: + <ul> + <li>AutoRefresh - portlets can now be configured to auto-refresh themselves in the jetspeed-portlet.xml deployment descriptor</li> + <li>Responsive Decorators and Layouts - a new set of responsive decorators and layouts have been introduced to work with mobile and full web devices</li> + <li>New Responsive Profiler Admin Portlet</li> + <li>New WebContent 2 Framework for IFrames and Secure rendering of remote content</li> + <li>Jetspeed API now fully supports Java generics</li> + <li>Support Tomcat7 out of box as default application server</li> + <li>New User Browser supporting large user data sets</li> + <li>Added support for Anding PSML Security constraints</li> + <li>Upgrading all JAR dependencies to latest versions</li> + <li>Set default compiler to Java 1.7</li> + <li>Improved Portlet Preferences and Security Caching</li> + <li>Upgrade Jetspeed to Servlet Spec 3.0</li> + <li>Upgrade Jetspeed to Portlet Spec 2.1.0</li> + </ul> + </p> + </subsection> + + <subsection name='New Features for 2.2.2'> + <p> + Overview of new features in version 2.2.2: + <ul> +<li>Many JetUI improvements, see also <a href="http://portals.apache.org/jetspeed-2/deployguide/guide-jetui.html";>Intoduction to JetUI</a></li> +<li>Portlet Cloning: allow site editors to quickly create new portlet variants based on modified preference and other descriptor settings: <a href="http://issues.apache.org/jira/browse/JS2-1232";>JS2-1232</a></li> +<li>Support for bulk migration of DBPSML based installations from 2.1.X to 2.2.X: <a href="http://issues.apache.org/jira/browse/JS2-1127";>JS2-1127</a></li> +<li>Admin roles security restriction on admin roles maintenance: <a href="http://issues.apache.org/jira/browse/JS2-915";>JS2-915</a></li> +<li>Enforced portlet level security constraints checking at render time through custom jetspeed-portlet.xml metadata: <a href="http://issues.apache.org/jira/browse/JS2-1262";>JS2-1262</a></li> +<li>Apache Solr based portlet search engine: <a href="http://issues.apache.org/jira/browse/JS2-1246";>JS2-1246</a></li> + </ul> + </p> + </subsection> + <subsection name='New Features for 2.2.1'> + <p> + Overview of new features in version 2.2.1: + <ul> +<li>Jetui Client Side Customization Engine</li> +<li>Drag and Drop Support of portlets</li> +<li>Jetspeed Toolbox dockable portlet selector, layout selector, and skin selector</li> +<li>Dockable Jetspeed Navigator to navigate over spaces, maintenance over pages, folders, links</li> +<li>Jetspeed Spaces, secured areas of the portal site for workgroups and projects</li> +<li>JAX RS Services for Portal Customization and Registry manipulations</li> +<li>Open ID Support</li> +<li>Preview Portlet Mode from Jetspeed Toolbox</li> +<li>Improved LDAP synchronization, authentication, and maintenance of LDAP credentials</li> +<li>CAS Authentication</li> +<li>Dynamic PSML - dynamically overlay external site maps such as other web sites or content repositories onto the Jetspeed site map to dynamically navigate of external content within portal</li> +<li>PSML Templates - templacized, secured pages that overlay over URL addressable pages to merge template-portlets such as toolbox and navigator into a single page</li> +<li>Fragment References - also known as Portlet Instances - allow for referencing preconfigured portlets with preferences from a standard page</li> +<li>Improved Portlet API 2.0 Support and Compliance</li> +<li>Improved Installer to support two kinds of installations (min, demo)</li> +<li>New User Manager supporting true paging over large user databases</li> + </ul> + </p> + </subsection> + <subsection name='New Features for 2.2.0'> + <p> + Overview of new features in version 2.2.0: + <ul> +<li>Portlet API 2.0 Support and Compliance</li> +<li>Inter-Portlet Communication via Events</li> +<li>New High Speed Preferences Database Storage</li> +<li>New Extensible Security Model with LDAP Synchronization</li> +<li>Improved Documentation including 5 New Guides (Users Guide, Admin Guide, Developers Guide, Build Guide, Deploy Guide)</li> +<li>New Improved Administrative Portlets</li> +<li>New Skins</li> +<li>New Maven-2 Custom Build</li> +<li>Improved integration support for popular web development frameworks like Wicket, Spring MVC, and JSF</li> +<li>EAR deployment on Websphere 6.1</li> + </ul> + </p> + </subsection> + + <subsection name="Standardized"> + <ul> + <li>Fully compliant with Java Portlet API Standard 2.0 (JSR 286)</li> + <li>Fully compliant with Java Portlet API Standard 1.0 (JSR 168)</li> + <li>Passed JSR-168 TCK Compatibility Test Suite</li> + <li>Passed JSR-286 TCK Compatibility Test Suite</li> + <li>J2EE Security based on JAAS Standard, JAAS DB Portal Security Policy</li> + <li>LDAP Support for User Authentication</li> + <li>Implements and fully Supports Portlet Events and other standardized inter-portlet communication features of the Portlet API 2.0</li> + </ul> + </subsection> + <subsection name='Portal Engine Features'> + <ul> + <li>The Jetspeed Portal - Server-Side Parallel JSR-168/286 Portlet Rendering Engine</li> + <li>The Jetspeed Desktop - Web 2.0 Client-Side JSR-168/286 Portlet Rendering Engine</li> + <li>Full Support for JSR-168/286 Portlet Caching and per portlet cache configuration</li> + <li>Portlet Timeout Tracking with mimimal render time limits</li> + <li>Portlet Service Manager for automated removal of slow or dead portlets.</li> + <li>Parallel rendering on Websphere 6.1</li> + <li>New Fast Preferences Engine with version 2.2.0</li> + </ul> + </subsection> + <subsection name="Customization Features"> + <ul> + <li>Portal Page Customizer</li> + <li>Desktop Page Customizer</li> + <li>Nested Fragment Customization</li> + <li>Drag and drop moving of portlets</li> + <li>Resizing of desktop portlet windows</li> + <li>Portlet Selector with Portlet Categorizations, Full-Text Search of Portlets</li> + <li>Customizable Themes (Skins)</li> + </ul> + </subsection> + <subsection name='Security'> + <ul> + <li>New Extensible Security Model with version 2.2.0</li> + <li>Portlet-level Security checks based on Security Constraints or Security Permissions</li> + <li>Declarative Security Constraints and JAAS Database Security Policy</li> + <li>Fully swappable Security Constraint or Security Permission support</li> + <li>Jetspeed SSO (Single Sign-on)</li> + <li>Delegation of Security</li> + <li>Administrative actions logged to Audit Activity database</li> + <li>LDAP Synchronization</li> + </ul> + </subsection> + <subsection name="Distributed Cluster Support"> + <ul> + <li>Jetspeed Distributed Cluster - support for distributed deployments of the portal on multiple application server platforms</li> + <li>Distributed Cache for portal components including preferences, registry and portlet entities.</li> + <li>Distributed invalidation of portlet cache</li> + </ul> + </subsection> + <subsection name="Foundation Component Architecture"> + <ul> + <li>Spring-based Components and Scalable Architecture</li> + <li>Configurable Pipeline Request Processor</li> + <li>Auto Deployment of Portlet Applications</li> + <li>Jetspeed Component Java API</li> + <li>Jetspeed AJAX XML API</li> + <li>PSML: Extended Portlet Site Markup Language + <ul><li>Database Persistent</li> + <li>Content Management Facilities</li> + <li>Security Constraints</li></ul> + </li> + <li>Full security maintenance using LDAP is now supported for many LDAP providers</li> + </ul> + </subsection> + <subsection name="Portal Core Features"> + <ul> + <li>Runtime Portlet API Standard Role-based Security</li> + <li>Portal Content Management and Navigations: Pages, Menus, Folders, Links</li> + <li>PSML Folder CMS Navigations, Menus, Links</li> + <li>Rules-based Profiler for page and resource location</li> + <li>Role-based Aggregation of Visible Pages</li> + <li>Integrates with most popular databases including Derby, MySQL, MS SQL, Postgres, Oracle, DB2</li> + <li>Client independent capability engine (html, xhtml, wml,vml)</li> + <li>Support for Pocket PC</li> + <li>Internationalization: Localized Portal Resources in 12 Languages</li> + <li>Statistics Logging Engine</li> + <li>Portlet Registry</li> + <li>Full Text Search of Portlet Resources with Lucene</li> + <li>User Registration</li> + <li>Forgotten Password</li> + <li>Rich Login and Password Configuration Management</li> + </ul> + </subsection> + <subsection name="Administrative Portlets"> + <ul> + <li>User, Role, Group, Password, and Profile Management</li> + <li>Portal Site Manager</li> + <li>Remote Portal Application Deployer (RPAD) - hot deploy portlet applications from remote locations on the Web</li> + <li>JSR 168 Generic User Attributes Editor</li> + <li>JSR 168 Preferences Editor</li> + <li>SSO Manager</li> + <li>Permission Management (JAAS Security)</li> + <li>Security Constraints Management</li> + <li>Portlet Application and Lifecycle Management</li> + <li>Profiler Administration</li> + <li>Statistics Reports</li> + <li>Portlet Out of Service Manager</li> + <li>PSML and XML Import / Export Admin Portlet</li> + <li>Cache Manager</li> + </ul> + </subsection> + <subsection name="Web Framework Support and Sample Portlets"> + <ul> + <li>Bridges to other Web Frameworks: Wicket, JSF, Groovy, Struts, PHP, Perl, Velocity</li> + <li>Sample Portlets: + <ul><li>RSS, IFrame, Calendar XSLT, Struts Petstore, Bookmark, Database Browser</li> + <li>Integration with Display Tags, Spring MVC</li></ul> + </li> + </ul> + </subsection> + <subsection name='Data Migration Features'> + <ul> + <li>XML Import/Export Utility for all Jetspeed database data to support data migration over versions</li> + <li>All initial portal data seeded with XML</li> + <li>XML Schemas for all XML content</li> + </ul> + </subsection> + <subsection name="Portal Design Features"> + <ul> + <li>Deployment Jetspeed Portlet and Page Skins (Decorators) CSS Components</li> + <li>Configurable CSS Page Layouts</li> + <li>Easy to Use Velocity Macro Language for Skin and Layout Components</li> + </ul> + </subsection> + <subsection name="Development Tools"> + <ul> + <li>Ant-based Installer</li> + <li>Tutorial</li> + <li>Automated Maven-2 Build</li> + <li>Jetspeed-2 Maven Plugin for Custom Portal Development</li> + <li>Maven-2 Profiles and Archetypes</li> + <li>AutoDeployment of Portlet Applications, Portal Resources</li> + <li>Deployment Tools</li> + <li>Plugin Goals integrated with Auto Deployment Feature</li> + <li>XML Schemas for PSML, jetspeed-portlet.xml, and Jetspeed XML (seed data)</li> + <li>Fully compatible and tested with Wicket, JSF and Spring MVC</li> + </ul> + </subsection> + <subsection name='Extended JSR-168/286 Features'> + <ul> + <li>Custom Portlet Modes and Window States: <b>Edit Defaults, Configure, Print, About</b></li> + <li>Custom Window States: <b>Solo</b></li> + <li>Dynamically hide Portlets at request time</li> + <li>Maximize on Edit Defaults or Edit modes option</li> + <li>Preliminary Portlet API 2.0 ResourceURL support providing full response control for JSR-168 based portlets</li> + </ul> + </subsection> + <subsection name='Other Features'> + <ul> + <li>Installation choice of either Demo Portal or Minimal Starter Portal</li> + <li>In-depth Jetspeed 2 Tutorial</li> + <li>Documentation Guides: Users Guide, Admin Guide, Developers Guide, Build Guide, Deploy Guide</li> + </ul> + </subsection> + <subsection name="Application Servers Supported"> + <ul> + <li>Tomcat 6</li> + <li>Jetty</li> + <li>Websphere 6.0</li> + <li>Geronimo</li> + <li>JBoss</li> + <li>Weblogic</li> + </ul> + </subsection> + </section> + </body> +</document> Added: portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/getting-started-installer.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/getting-started-installer.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/getting-started-installer.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/getting-started-installer.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,194 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title> + Getting Started with Jetspeed 2 using the installer + </title> + <subtitle>Installing Jetspeed-2 with the installer</subtitle> + <authors> + <person name="David Le Strat" email="[email protected]" /> + <person name="David Taylor" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Jetspeed 2 Installer"> + <subsection name="Getting Started with the Installer"> + <p> + With version 2.2.1+, there is now only one installer (previous releases had two installers). + From the installation program, you can choose either the demo or minimal installation. + The demo option is best for seeing more features, capabilities, and demo portlet applications. + The minimal option could be useful for basing your own custom-portal distribution upon, or just seeing the basic feature set of Jetspeed. + <ol> + <li>Minimal Installer Option - only contains a Jetspeed Portal and the Jetspeed Administrative Portlets, with a minimal Site map and set of users</li> + <li>Full or Demo Option - contains a Jetspeed Portal, the Jetspeed Administrative Portlets, a full demo Site Map, 10 users. Additionally, + there several portlet applications including an RSS application, a Database Browser application, a Web Content application, and a set of demo portlets + including Google Maps, weather portlets, and lots of programming examples to get you started. + </li> + </ol> + <p>The installer contains both options, and can be downloaded here:</p> + <br/><br/> + <a href="http://www.apache.org/dyn/closer.cgi/portals/jetspeed-2/binaries/jetspeed-installer-2.3.0.jar";>Jetspeed Installer</a> + <br/><br/> + </p> + <p> + To run the installer: + </p> + <source> +java -jar jetspeed-installer-2.3.0.jar + </source> + <p> + The installer is capable of running on headless (i.e. no gui) machines, and will detect so automatically.<br/> + To force the installer in text mode manually, pass in the <b><i>text</i></b> parameter: + </p> + <source> +java -jar jetspeed-installer-2.3.0.jar text + </source> + <p> + After starting the installer and advancing through the splash and license pages, select the + <code>Install Jetspeed Portal</code> installer operation and continue. The installer will then + prompt for information required for the installation process. Documentation for the other + installer operations used primarily for ETL migration can be found here: <a href="guide-etl-migration.html">ETL Migration Guide</a>. + </p> + </subsection> + <subsection name="Database Selection"> + <p> + The installer will ask you to choose a database for storing the Jetspeed database. We provide a default Derby database for demo systems. + The Derby database runs in embedded mode inside the Jetspeed/Tomcat JVM. All other databases require additional configuration. + If you selected Derby, you can go with the default parameters provided. For all other databases you must first create an area to hold the Jetspeed tables. + For some databases this <i>area</i> is called a <i>catalog</i>, others call it a <i>schema</i>, while others call it a <i>database</i>. Consult your + database documentation for details on how to create a catalog or schema to hold the Jetspeed tables. Additionally, you may need to create a database user + to access the Jetspeed tables. Often it is required to grant access to the schemas (catalogs) for the given user. + </p> + <p>Jetspeed supported database list: + <ul> + <li>DB2</li> + <li>Derby (default)</li> + <li>MS SQL</li> + <li>My SQL</li> + <li>PostgreSQL</li> + <li>Oracle (9i or higher)</li> + <li>SapDB</li> + <li>Manual database setup </li> + </ul> + </p> + <p>If you choose the manual database setup, then the database scripts will not be run and you will need to configure the database manually after the installation. + All database scripts are provided in the installation under the <i>database</i> directory. For your specific database, look for the corresponding directory name. + During installation, you will be prompted for the following fields after chosing your database types (except for Derby): + <ul> + <li>A username</li> + <li>A password</li> + <li>A JDBC connection string</li> + <li>A JDBC driver name</li> + <li>The location of a valid JDBC driver. The installer will copy this driver to the installed location in Tomcat.</li> + </ul> + The connections strings are only partially completed in the well-known format of the particular databaes. + Please take care to complete the values in your connection string for your database. The driver name should be the right + driver class for your database at the time of the making of this installation. Please ensure that a newer driver is not required for your database. + Note also that the location of the JDBC driver must be selected. We have not provided the file system path to the jar file but only the likely file name. + You may want to check and see if newer versions of the driver are available. + </p> + <p> + Once you have entered all of your parameters, the installer will test the database connection before proceeding. + If the connection fails, please go back to the connection configuration setup and provide the correct parameters. + If you choose to continue, the database scripts will not be run and you will need to configure the database manually after the installation. + Once the installer verifies the database connection, you are ready to proceed with installation process. + </p> + <p> + Please take note of the location where you are installing on your file system.<br/> + Also, on a Windows platform make sure to use a location path without spaces, e.g. <i>NOT</i> under C:\Program Files. + </p> + </subsection> + <subsection name="Starting Jetspeed-2"> + <p> + Once you have completed a successful install, you are ready to start the Jetspeed Portal. + On linux, here is an example where you have installed to the default location:<br/> + Note that the setting of CATALINA_OPTS is optional in the following examples. (See <a href="#Note_on_Permanent_Generation_Size_of_Your_JVM">Note on Permanent Generation Size of Your JVM</a> for detail.) + </p> + <source> +$ cd ~/jetspeed-2.2.2/bin +$ export CATALINA_OPTS="-Xmx512m -XX:MaxPermSize=128m" +$ ./startup.sh + </source> + <p> + On windows, here is an example where you have installed to the default location: + </p> + <source> +> cd C:\Apache\Jetspeed-2.2.2\bin +> set CATALINA_OPTS="-Xmx512m -XX:MaxPermSize=128m" +> startup.bat + </source> + <p> + The very first invocation of the portal requires anywhere from 10 seconds to 30 seconds for initial + startup and final installation. After starting the server, start up a web browser + and navigate to <a href='http://localhost:8080/jetspeed/portal'>http://localhost:8080/jetspeed/portal</a> + </p> + </subsection> + <subsection name="Note on Permanent Generation Size of Your JVM"> + <p> + <em>Note:</em> You may need to increase the permanent generation size of your JVM when there are a lot of Servlets, JSP's + or when script portlets are used, in order to avoid <CODE>OutOfMemoryError</CODE> errors. + By default, it is 64MB. Increasing it to be <CODE>-XX:MaxPermSize=128m</CODE> might be a good start. + Please see <a href="http://wiki.apache.org/tomcat/FAQ/Memory";>http://wiki.apache.org/tomcat/FAQ/Memory</a> for detail. + </p> + </subsection> + <subsection name="Login to Jetspeed-2"> + <p> +All preconfigured users have the same password as username (for example the <i>admin</i> user has the password <i>admin</i>) +If you installed with the Minimal option on installation, one test account are available: + </p> + <source> +admin -- System administrator, super user + </source> + <p> +If you installed with the Demo option upon installation, several additional test accounts are available: + </p> + <source> +admin -- System administrator, super user +debbie -- example user with the developer role in the engineering group +manny -- example user with the devmgr role in the engineering group, also demonstrates a delegated security manager, can manage users with the "dev" (developer) role, see home page of this user +bill -- example user with the executive role in the finance and marketing groups +martha -- example user with the marketing role in the marketing group + </source> + </subsection> + <subsection name="Changing the Database"> + <p> + After running the installation, you can manually reinitialize the database or even switch to another database. + To do so, we provide an Ant script found under the <i>database</i> directory of your installed Jetspeed portal. + The database configuration is defined in the <i>database.properties</i> file. To reinitialize or change the database, + go to the database directory and edit the database.properties file, save it, and then run <b><i>ant</i></b>. + </p> + <p>Here is a sample database configuration file: + </p> + <source> +; Jetspeed Enterprise Portal 2.1 Database setup configuration +; db.type supported values: db2, derby, mssql, mysql, oracle, postgres, sapdb +db.type=mysql +: for db.type other than derby, the properties below need to be specified +db.username=j2 +db.password=abracadabra +jdbc.url=jdbc:mysql://localhost:3306/prod-2 +jdbc.driver.class=com.mysql.jdbc.Driver + </source> + <p>If you are configuring a database for the first time after choosing Manual database setup in the installer, or want to try out + a different type of database, make sure to copy the specific JDBC driver for the database to the Tomcat shared/lib folder <i>before</i> running ant.<br/> + Note: for Derby, the needed driver is already placed there or available from the database/lib directory of your installed Jetspeed portal.</p> + </subsection> + </section> + </body> +</document> Added: portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/getting-started.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/getting-started.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/getting-started.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/getting-started.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,204 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>Getting Started with Jetspeed 2</title> + <subtitle>Getting up and running quickly</subtitle> + <authors> + <person name="David Sean Taylor" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="Requirements"> + <p> + System Requirements to Run Jetspeed 2.2.2: + <ul> + <li>Java 1.5 or higher installed</li> + <li>at least 1 MB of memory</li> + <li>a database is optional, the Jetspeed installer comes with a built-in database (Derby). For production system recommend providing your own maintained database + Supported Databases: (MySQL, Oracle, Postgres, DB2, Sybase, SQL Server, Derby, HSQL)</li> + <li>100 MB free disk space</li> + </ul> + </p> + <p> + <a href='#cb1'>System Requirements to Build and Develop with Jetspeed 2.2.2</a> + </p> + </section> + <section name="Where do I start?"> + <p>Where you start depends on what you plan on doing with Jetspeed. Its always best to start by reading the documentation guides. There are several guides provided: + </p> + <ul> + <li> + <a href="usersguide/index.html"> + Users Guide + </a> + </li> + <li> + <a href="adminguide/index.html"> + Administrators Guide + </a> + </li> + <li> + <a href="deployguide/index.html"> + Deployment and Configuration Guide + </a> + </li> + <li> + <a href="devguide/index.html"> + Developers Guide + </a> + </li> + <li> + <a href="buildguide/index.html"> + Build Guide + </a> + </li> + </ul> + <p> + For those of you in more of a hurry to get started, + you have the choice of + installing Jetspeed from a binary release or doing more indepth open source development by working with the + source code.</p><p>If you want to modify the core functionality of + Jetspeed or contribute to the development of Jetspeed, + you need to work with the source code. If you are + interested in building your first custom enterprise + portal, try the custom build. We recommend trying an Evaluation (demo, download) to get started. Eventually you will want to move on to Building a Custom Portal. + Advanced users will want to learn how to build from source. + </p> + <ul> + <li><a href="#Evaluating">Evaluation</a></li> + <li><a href="#cb1">Building a Custom Portal</a></li> + <li><a href="#bfs1">Building Jetspeed from Source</a></li> + </ul> + </section> + <section name="Evaluating"> + <p> + If you are evaluating Jetspeed, best to download the latest distribution or try running Jetspeed from the demo site: + <ul> + <li><a href="download.html">Download Jetspeed</a></li> + <li><a href="demo.html">Jetspeed Online Demos</a></li> + </ul> + </p> + <p><b>Download Requirements</b> - The requirements for the downloadable distribution are: Java 1.5 or higher, enough memory to run Tomcat with several web apps (the demo comes with Tomcat embedded in the installer)</p> + <p><b>Online Demo Requirements</b> - The requirements for the online demos are minimal: just a web browser</p> + </section> + <div id='cb1'/> + <section name="Custom Build"> + <p> +When starting a new Jetspeed portal project, we strongly recommend that you create a custom portal project, and do not edit the Jetspeed-2 source and resources directly. +A custom build allows you to create and maintain a Jetspeed Portal's lifecycle. With a custom build, you have a reproducible procedure for maintaining your portal across future versions. +When we say custom, we mean customizing Jetspeed for your needs. Everyone has custom requirements. Custom build procedures formalize the steps required to create a custom portal. +Although Jetspeed can be customized online using the portal customization features. Still, having a reproducible build is valuable as it enables you to store artifacts in a source code repository and +maintain the life-cycle of this source. +</p> +<p> +Custom Jetspeed builds for version 2.2.2 are built with Maven-2 (and Maven-3 preferred) only. (The Maven-1 custom build is no longer supported.) +Building Jetspeed from source is not necessary for most projects. +</p> +<subsection name="Maven-2 Custom Build"> +<p>The Maven-2 Custom Build is based on a Maven-2 plugin. To get started with the Maven-2 plugin, see the documentation here: +<ul> +<li><a href="buildguide/maven-2-build.html">Maven-2 Jetspeed Build Getting Started</a></li> +<li><a href="buildguide/jetspeed-archetype.html">Maven-2 Jetspeed Archetype</a></li> +</ul> +</p> +</subsection> +<subsection name="Requirements for Custom Builds"> +<p> +General requirements for custom builds: +</p> + <ul> + <li>Java 1.5 or higher</li> + <li>200 MB free disk space</li> + <li>2 MB of memory</li> + <li>Maven-2 or Maven-3</li> + <li>Ant</li> + <li> + Servlet 2.4 (or higher) Engine: + <ul> + <li><a href="deployguide/guide-tomcat.html">Tomcat 6.0.33+</a></li> + <li>Jetty</li> + <li><a href="deployguide/deploying-jetspeed-to-websphere.html">Websphere 6.0</a></li> + <li>Geronimo</li> + <li>JBoss</li> + <li>Weblogic</li> + </ul> + Jetspeed 2 portals can be run under any + servlet container supporting the 2.4 specification or + greater. However we don't have documentation listed for all servers. Contributions welcome! + </li> + <li>A Database + Jetspeed's security model requires a database to + authorize users and to retain the user information. + Jetspeed security should work with any JDBC 2.0 + compliant driver. The following databases are tested: + <ul> + <li>Derby</li> + <li>HSQLDB - Hypersonic SQL</li> + <li>MySQL</li> + <li>Oracle</li> + <li>Postgres</li> + <li>DB2</li> + <li>Sybase</li> + <li>SQL Server</li> + </ul> + <p> + Jetspeed is distributed with the Derby database + configured as the default. + </p> + <p> + The database configuration will be setup during the + custom build process based on your property settings. See the appropriate build guide for details.. If you are not going to use the + default Derby database, you need to select another database + during your build configuration. + </p> + + </li> + </ul> +</subsection> +</section> +<div id='bfs1'/> +<section name='Building from Source'> + <p> + Building from Source is covered in the Developer guide. We build Jetspeed with Maven-2. + </p> + <subsection name="Building from Source with Maven-2"> + <p>The best place to start using Jetspeed, as a Developer, is to go to the developers guide documentation:</p> + <p><a href="devguide/index.html">Jetspeed Developers Guide</a></p> + <p>For general build information, also see the Jetspeed Build Guide:</p> + <ul> + <li> + <a href="buildguide/index.html"> + Building and developing Jetspeed-2 using Maven-2 + </a> + </li> + <li> + <a href="buildguide/maven-2-build.html"> + Building jetspeed from Source + </a> + </li> + <li> + <a href="buildguide/jetspeed-maven-plugins.html"> + Jetspeed Maven-2 Plugin Guide + </a> + </li> + </ul> + </subsection> + </section> + </body> +</document> Added: portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/guide-etl-migration.xml URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/guide-etl-migration.xml?rev=1691449&view=auto ============================================================================== --- portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/guide-etl-migration.xml (added) +++ portals/site/jetspeed/jetspeed-2.3/src/site/xdoc/guide-etl-migration.xml Thu Jul 16 21:01:09 2015 @@ -0,0 +1,274 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<document> + <properties> + <title>ETL Migration Guide</title> + <subtitle>ETL Migration Guide</subtitle> + <authors> + <person name="Randy Watler" email="[email protected]" /> + </authors> + </properties> + <body> + <section name="ETL Migration Using Jetspeed 2.1.3/2.1.4+ and 2.2.1+ Installers"> + <p> + To facilitate ETL based migration or data manipulation strategies, the Jetspeed installer + includes the ability to export, initialize, and import a Jetspeed database. In addition to + basic portal data, these operations also will include database PSML and user preferences + stored in the Jetspeed database. The installer does not require a Jetspeed portal build or + runtime environment to execute these operations. + </p> + <p> + The binary installer can be obtained from the download page, (<a href="download.html">Download</a>), + both the minimal and demo installers include the neccessary data operations. In addition to + the installer, the appropriate JDBC driver for the installation and access to the database + will be required. + </p> + </section> + <section name="Exporting a Jetspeed database"> + <p> + The first step in migrating a database is to export its contents into a file based + representation. It is best to perform this step on quiescent or shutdown portal instance. + Once the binary installer for the existing Jetspeed release and JDBC drivers have been gathered, + invoke the installer using the following shell command: + </p> + <source> + <![CDATA[java -jar <Jetspeed installer JAR file>]]> + </source> + <p> + To run the installer in the console without a GUI, append the <code>text</code> argument to the + shell command: + </p> + <source> + <![CDATA[java -jar <Jetspeed installer JAR file> text]]> + </source> + <p> + After starting the installer and advancing through the splash and license pages, select the + <code>Export Jetspeed Portal Database</code> installer operation and continue. The installer + will then prompt for the following information: + </p> + <table> + <tr> + <th nowrap="true">Installer Prompt</th> + <th>Description</th> + </tr> + <tr> + <td nowrap="true"><code>Export data files location</code></td> + <td> + Select a new directory where the export is to write the database XML files. Existing + files and directories in the selected directory will be removed when the export operation + is complete. + </td> + </tr> + <tr> + <td nowrap="true"><code>Temporary installation location</code></td> + <td> + If the default temporary location is not vaild, select a new temporary directory where the + installer Jetspeed instance can be unpacked, (it is removed after the installation is + complete). + </td> + </tr> + <tr> + <td nowrap="true"><code>JVM memory size</code></td> + <td> + Export operations can consume a large chunk of memory as the database is traversed. Enter + a larger JVM maximum memory size in megabytes as necessary for the installer Jetspeed + instance invocation. + </td> + </tr> + <tr> + <td nowrap="true"><code>Database selection</code></td> + <td> + Select the current portal database type. DB2, MSSQL, MySql, PostgreSQL, Oracle, and SapDB + are supported. Note that Derby is not currently supported. + </td> + </tr> + <tr> + <td nowrap="true"><code>Database connection parameters</code></td> + <td> + Enter or validate the current portal database user, password, connection string, driver + class, and driver JAR archive file. + </td> + </tr> + </table> + <p> + After configuring the export operation, the installer will test the database connection before + proceeding to the confirmation page. Continue the installation process as instructed. When it + has finished, be sure to review the <code>Show Details</code> tab to ensure the export has + completed as expected. The following files should appear in the export data files location + specified during the installation: + <ul> + <li><code>j2-data.xml</code> file</li> + <li><code>j2-prefs-data.xml</code> file, (2.1.X installers only)</li> + <li><code>pages</code> directory, (if database Page Manager enabled)</li> + </ul> + If the installation fails or errors occur in the detail output, the export has probably failed. + </p> + </section> + <section name="Editing the Jetspeed database Exported XML Files"> + <p> + Exported Jetspeed database XML files can be edited, provided the original format and all + dependencies are maintained. The formats and files that make up a release do change between + releases, so care must be taken to keep the syntax and files consistent with the export release + version. No editing should be required to migrate between dataabase vendors. + </p> + <p> + Multiple imports can be performed in an additive fashion to merge slices of data cut from + individual exports. However, individual objects in the data model are replaced with new versions + loaded during the latest import; merging does not take place at the object level. Bulk edits may + also be performed to modify data during migration to complement the portal upgrades if desired. + </p> + </section> + <section name="Initializing a Jetspeed database"> + <p> + Full exports are designed to be imported into an empty Jetspeed database. Creating databases is + left to the datbase administrator, but the loading of the Jetspeed database schema can also be + accompished using the Jetspeed installer. Databases that contain instances of older Jetspeed + portal schemas should be cleaned by dropping all Jetspeed tables prior to reinitialization by the + installer. <b>All information within the database will be removed when the Jetspeed database is + initialized.</b> + </p> + <p> + To initialize a new database, the installer should be obtained and started for the target Jetspeed + release version as documented above for the export operation, except the <code>Initialize Jetspeed Portal Database</code> + operation must be selected. The installer will then prompt for the following information: + </p> + <table> + <tr> + <th nowrap="true">Installer Prompt</th> + <th>Description</th> + </tr> + <tr> + <td nowrap="true"><code>Temporary installation location</code></td> + <td> + If the default temporary location is not vaild, select a new temporary directory where the + installer Jetspeed instance can be unpacked, (it is removed after the installation is + complete). + </td> + </tr> + <tr> + <td nowrap="true"><code>Database selection</code></td> + <td> + Select the current portal database type. DB2, MSSQL, MySql, PostgreSQL, Oracle, and SapDB + are supported. Note that Derby is not currently supported. + </td> + </tr> + <tr> + <td nowrap="true"><code>Database connection parameters</code></td> + <td> + Enter or validate the current portal database user, password, connection string, driver + class, and driver JAR archive file. + </td> + </tr> + </table> + <p> + After configuring the initialization operation, the installer will test the database connection + before proceeding to the confirmation page. Continue the installation process as instructed to + load or reload the Jetspeed database schema. When it has finished, be review the <code>Show Details</code> + tab to ensure the export has completed as expected. If the installation fails or errors occur in + the detail output, the initialization has probably failed. This normally indicates that the + database was not clean before the initialization was attempted or sufficient permissions were not + granted to the specified database user. + </p> + </section> + <section name="Importing a Jetspeed database"> + <p> + Previously exported Jetspeed database XML files can be reloaded using the installer import + operation. Full exports are normally loaded into empty databases, but multiple imports can be used + to load partial export data slices as necessary. Data in these slices can only be dependent on + information contained within the export or the export files themselves. Individual objects in the + XML data files are fully replaced upon load; object instance merging is not supported by import. + <b>All data objects imported to the database will replace any existing objects in the Jetspeed + database on import.</b> + </p> + <p> + The installer will expect the following files to appear in the import data files location + directory specified during the installation: + <ul> + <li><code>j2-data.xml</code> file</li> + <li><code>j2-prefs-data.xml</code> file, (2.1.X exports only)</li> + <li><code>pages</code> directory, (assumes Page Manager to be enabled)</li> + </ul> + All other files in the import data files location directory will be ignored. + </p> + <p> + Jetspeed database import operations should only be attempted on a shutdown portal instance; imports + on a running portal may lead to unexpected results and is not supported. If the import is to merge + with data already loaded in the database, performing a full backup before the import is highly + recommended. + </p> + <p> + To import an existing database export file set, the installer should be obtained and started for the + target Jetspeed release version as documented above. The <code>Import Jetspeed Portal Database</code> + operation must be selected. The installer will then prompt for the following information: + </p> + <table> + <tr> + <th nowrap="true">Installer Prompt</th> + <th>Description</th> + </tr> + <tr> + <td nowrap="true"><code>Import data files location</code></td> + <td> + Select an existing directory that contains the exported Jetspeed database XML files. + </td> + </tr> + <tr> + <td nowrap="true"><code>Temporary installation location</code></td> + <td> + If the default temporary location is not vaild, select a new temporary directory where the + installer Jetspeed instance can be unpacked, (it is removed after the installation is + complete). + </td> + </tr> + <tr> + <td nowrap="true"><code>JVM memory size</code></td> + <td> + Import operations can consume a large chunk of memory as the database is loaded. Enter + a larger JVM maximum memory size in megabytes as necessary for the installer Jetspeed + instance invocation. + </td> + </tr> + <tr> + <td nowrap="true"><code>Database selection</code></td> + <td> + Select the target portal database type. DB2, MSSQL, MySql, PostgreSQL, Oracle, and SapDB + are supported. Note that Derby is not currently supported. + </td> + </tr> + <tr> + <td nowrap="true"><code>Database connection parameters</code></td> + <td> + Enter or validate the target portal database user, password, connection string, driver + class, and driver JAR archive file. + </td> + </tr> + </table> + <p> + After configuring the import operation, the installer will test the database connection before + proceeding to the confirmation page. Continue the installation process as instructed. When it + has finished, review the <code>Show Details</code> tab to ensure the export has completed as + expected. If the installation fails or errors appear in the detail output, the import has probably + failed and the database has been corrupted. The import operation(s) will have to be attempted + again from a clean or known database backup state. Problems are normally caused by data + incompatabilities/overlap between multiple import data slices or insufficient database permissions + granted to the specified database user. + </p> + </section> + </body> +</document> +
