geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jb...@apache.org
Subject svn commit: r679163 - in /geronimo/server/trunk: README.txt RELEASE_NOTES-2.2.txt assemblies/geronimo-boilerplate/pom.xml
Date Wed, 23 Jul 2008 19:33:23 GMT
Author: jbohn
Date: Wed Jul 23 12:33:22 2008
New Revision: 679163

URL: http://svn.apache.org/viewvc?rev=679163&view=rev
Log:
add RELEASE_NOTES, update README (sync both with branches/2.1) and add hack to include them
in assemblies

Added:
    geronimo/server/trunk/RELEASE_NOTES-2.2.txt   (with props)
Modified:
    geronimo/server/trunk/README.txt
    geronimo/server/trunk/assemblies/geronimo-boilerplate/pom.xml

Modified: geronimo/server/trunk/README.txt
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/README.txt?rev=679163&r1=679162&r2=679163&view=diff
==============================================================================
--- geronimo/server/trunk/README.txt (original)
+++ geronimo/server/trunk/README.txt Wed Jul 23 12:33:22 2008
@@ -1,139 +1,200 @@
 ======================================================
-Apache Geronimo v2.2-SNAPSHOT  (February 2, 2008)
+Apache Geronimo v2.2  (date TBD)
 
 http://geronimo.apache.org/
 ------------------------------------------------------
 
 
 ______________________
+Release Notes
+======================
+
+ Please read the RELEASE_NOTES-2.2.txt for a complete list of new features 
+ available in this release. 
+ 
+  
+______________________
 Documentation
 ======================
  
- This README serves as five minute overview of Geronimo, but better
- documentation can be found here:
+ This README serves as quick introduction to Geronimo. More complete documentation 
+ can be found here:
  
-   -  http://geronimo.apache.org/documentation.html
+   -  http://cwiki.apache.org/GMOxDOC22/documentation.html
+   OR
+   -  http://cwiki.apache.org/GMOxDOC21/documentation.html
+   (Geronimo 2.1 documentation until Geronimo 2.2 documentation is created)
 
 
 ______________________
-Release Notes
+Installing Geronimo
 ======================
 
- Please read the RELEASE NOTES for a complete list of features that are
- available in this release, as well as improvements and bug fixes. 
- 
-  
+ To install Geronimo, simply unpack the .zip (Windows) or tar.gz (Unix) file containing
+ Geronimo.
+
+ Note for Windows platforms:
+ The maximum path length for a directory path is 255 characters. Installing
+ Geronimo into a long directory path may cause the installation or server start up to fail.

+ It is recommended that you use a short directory name, such as "c:\g\".
+
+
 ______________________
-Installation
+Starting Geronimo 
 ======================
 
- If you've downloaded and unpacked a binary distribution of Geronimo,
- then you are finished with installation.
+ There are three general techniques for starting Geronimo (assuming the current directory
+ is <geronimo_home>):
 
- If you wish to modify the default ports that Geronimo will use, edit the file
- <geronimo_home>/var/config/config-substitutions.properties
+ 1. GShell -- "./bin/gsh geronimo/start-server"
+ 2. Script -- "./bin/geronimo.sh run" (Must first set the JRE_HOME or JAVA_HOME environment
variable)
+ 3. Java   -- "java -Djava.endorsed.dirs=%JRE_HOME%/lib/endorsed:lib/endorsed -Djava.ext.dirs=%JRE_HOME%/lib/ext:lib/ext
-javaagent:bin/jpa.jar -jar bin/server.jar"
 
- Note for Windows platform:
- ==========================
- Windows users keep in mind the directory path length limitation of 255 characters.
- Defaulting installation to predefined directories such as "My Documents" or 
- "Program Files" may cause the installation or the server start up to fail. Try a 
- <geronimo_home> at a root level instead.
+
+Additional information on command environments can be found below.
 
 
 ______________________
-Starting and Stopping
+Application Deployment
 ======================
 
- Geronimo comes with batch and script files to control server start and stop
- functions.  To see usage examples simply type geronimo.bat or geronimo.sh
- command as appropriate for your platform.  It is necessary to set JAVA_HOME 
- to the copy of your Sun 5 JDK/JRE prior to executing the command.
-
- To see the available command options type:
+ Applications can be deployed to a Geronimo server in several ways:
 
- <geronimo_home>/bin/geronimo.sh
- or
- <geronimo_home>\bin\geronimo.bat
+ 1. Administrative command scripts -- "./bin/gsh deploy/deploy MyApp.war MyDeploymentPlan.xml"
+ 2. Administrative console -- login to the admin console and click "Deploy New" under Applications
+ 3. Hot deploy -- copy your archive(s) into the "<geronimo-home>/deploy" directory.
The
+    hot deploy service will automatically deploy these artifacts.
+ 4. maven -- applications can be installed as part of a maven build
 
- The command will display help text instructing you as to how to start and stop
- the Geronimo server.
+ When you deploy an application using an administrative command, you will need
+ to supply an administrator's username/password. If you do not specify the username
+ and password, you will be prompted for them.
 
- If you prefer to start the server without a script file you can simply type
- the following command from <geronimo_home> directory:
 
- java -Djava.endorsed.dirs=lib/endorsed -javaagent:bin/jpa.jar -jar bin/server.jar
+______________________
+Configuration
+======================
 
- Once the server has started, you can access the welcome application by
- pointing your browser to:
+ Commonly modified configuration parameters, such as port numbers, can be set by 
+ editing the file:
 
-   http://localhost:8080/
- 
+ <geronimo_home>/var/config/config-substitutions.properties
  
- To access the Geronimo Administration Console point your browser to:
+ Additional configuration attributes can be updated in the file:
+
+ <geronimo_home>/var/config/config.xml
+
+ Note: The server must not be running when these files are modified.
+
+ Once the server has started, you can access the Geronimo Administration Console
+ at http://localhost:8080/console/ . The default user name is "system" and the
+ default password is "manager".
 
-   http://localhost:8080/console/ 
- 
- The default user name is "system" and the default password is "manager".
  
-   
 ______________________
-Deploying
+Security Configuration
 ======================
 
- Geronimo comes with deploy scripts and batch files to deploy JEE modules or
- applications. You can either use the scripts or simply invoke the executable
- jar by running the following command:
- 
- <geronimo_home>/bin/java -jar deployer.jar deploy my-web-app.war [deploy plan]
+ The default administration user/password for the Geronimo Administration Console
+ and command line deployment tool is system/manager.  You can change these defaults
+ directly from the Geronimo Administration Console by accessing Security -> Console
+ Realm and change the user name and password from the Console Realm Users portlet.
 
- If you use the scripts provided then the command would be as follows:
+ As an alternative, you can make the same changes by editing the
+ <geronimo_home>/var/security/users.properties and
+ <geronimo_home>/var/security/groups.properties files.
 
- <geronimo_home>/bin/deploy deploy my-web-app.war [deploy plan]
+ Access to the var/security directory should be appropriately secured on systems where
+ you install Geronimo.
 
- You will need to use the username "system" and password "manager" unless you
- changed the defaults.  
+ Passwords in users.properties are encrypted by the server. Passwords can be changed 
+ using the Geronimo Administration Console. They can also be changed using a text
+ editor. While the server is stopped, simply edit the users.properties file. The 
+ password(s) will be encrypted the next time the server is started. 
 
- The deployment plan argument is optional -- you can pack a deployment plan 
- into the application module, provide it on the command line, or in some cases
- omit it entirely.
+ To prevent potential security exposures, we strongly recommend you update the 
+ default user names and passwords on your system.
 
- For more information on the commands and options supported by the deploy tool,
- run from within the Geronimo directory <geronimo_home>/bin:
 
- java -jar deployer.jar help [command]
+______________________
+GShell
+======================
 
- As an alternative to the command-line deployer, you can copy application  
- modules into the <geronimo_home>/deploy/ directory and the hot deployer 
- service will deploy them automatically.
- 
- The command-line deployer has some advantages, as it will output any
- deployment errors to its own console rather than just the server log.
+ Geronimo provides a command shell environment for executing commands, called GShell. 
 
- Additionally you can also graphically deploy applications and resources via 
- the Geronimo Administration Console available at:
- 
-   http://localhost:8080/console/
+ To start a GShell environment, from the <geronimo_home> directory, execute "./bin/gsh"
(unix)
+ or "bin\gsh" (windows). This will start a GShell command environment. From here,
+ you can execute Geronimo administrative commands as well as general GShell commands.
+ Alternatively, you can invoke a GShell command at the same time that you invoke gsh, for
+ example:
+  
+   ./bin/gsh geronimo/stop-server
+
+ A list of common gsh commands are:
+
+   help
+   geronimo/start-server
+   geronimo/stop-server
+   deploy/deploy 
+   deploy/undeploy 
+   deploy/list-modules
+   deploy/install-plugin
+   deploy/assemble
+
+ Usage information for any command can be obtained by using the --help option. For example:
+
+   geronimo/start-server --help 
+
+ For more information on GShell and GShell commands, see the Geronimo 2.2 documentation.
+
+______________________
+Script
+======================
+
+ Geronimo provides a number of .sh or .bat scripts that can be used to administer Geronimo
+ servers. To use most of these scripts, you must first set either the JAVA_HOME 
+ or JRE_HOME environment variable:
+
+   export JAVA_HOME=<path-to-JDK>
+  or
+   export JRE_HOME=<path-to-JRE>
+
+ Unix scripts provided by Geronimo (there are .bat equivalents):
+
+   geronimo.sh -- used to start and stop servers; either as a foreground or background process.
+   startup.sh -- start a Geronimo server running as a background process
+   shutdown.sh -- stop a running Geronimo server
+   deploy.sh -- deploy, list, and undeploy plugins and applications
+   jaxws-tools.sh -- used to generate wsdl from java code or java code from wsdl
+
+ For example, "./bin/deploy.sh list-modules"
+
+ The geronimo.sh and shutdown.sh scripts have multiple sub-commands. Executing the scripts
without
+ any arguments will generate usage information. Executing "help <sub-command>" will
generate
+ usage information for that particular command.
 
 
 ______________________
 Support
 ======================
  
- Any problems with this release can be reported to the Geronimo
- mailing list or Jira issue tracker.
+ Any problems with this release can be reported to the Geronimo user mailing list 
+ or Jira issue tracker.
 
  Mailing list archive:
  http://mail-archives.apache.org/mod_mbox/geronimo-user/
 
- Mailing list subscription:
+ User mailing list:
+ user@geronimo.apache.org
+
+ User mailing list subscription:
  user-subscribe@geronimo.apache.org
 
  Jira:
- http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10220 
- 
- 
- ---------------------------------------
+ https://issues.apache.org/jira/browse/GERONIMO
+
+
+ _______________________________________
  Notice Regarding Cryptographic Software
  =======================================
  This distribution includes cryptographic software.  The country in 

Added: geronimo/server/trunk/RELEASE_NOTES-2.2.txt
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/RELEASE_NOTES-2.2.txt?rev=679163&view=auto
==============================================================================
--- geronimo/server/trunk/RELEASE_NOTES-2.2.txt (added)
+++ geronimo/server/trunk/RELEASE_NOTES-2.2.txt Wed Jul 23 12:33:22 2008
@@ -0,0 +1,117 @@
+Release Notes -- Apache Geronimo -- Version 2.2
+
+
+Geronimo URLs
+-------------
+Home Page:     http://geronimo.apache.org/
+Downloads:     http://geronimo.apache.org/downloads.html
+Documentation: http://geronimo.apache.org/documentation.html
+Mailing Lists: http://geronimo.apache.org/mailing.html
+Source Code:   http://geronimo.apache.org/svn.html
+Bug Tracking:  http://issues.apache.org/jira/browse/GERONIMO
+Wiki:          http://cwiki.apache.org/geronimo
+
+
+Documentation
+-------------
+Please see http://cwiki.apache.org/GMOxDOC22/documentation.html for the
+latest documentation on this release.
+OR
+Please see http://cwiki.apache.org/GMOxDOC21/documentation.html for Geronimo 
+2.1 documentation until Geronimo 2.2 documentation is created
+
+
+System Requirements
+-------------------
+You need a platform that supports the Sun JDK 5.0+ (J2SE 1.5.0+) or greater.
+
+Most testing has been done on Linux, Mac OS X, and Windows.
+
+
+Geronimo 2.2 Enhancements
+-------------------------
+
+Custom server assemblies
+- Lightweight server assemblies may be created that contain only the functional 
+  components required by your application(s).
+
+Flexible admin console
+- The admin console is now component-based to mirror the server capabilities. 
+  This allows the admin console to provide flexible administrative capabilities 
+  that will mirrors the capabilities of a custom server assembly.
+
+GShell
+- GShell is a command-line processing environment that can be used for the execution
+  of Geronimo commands. GShell is an extensible environment and includes support
+  for editing, command history, and tab completion. 
+
+Clustering Support
+- WADI can now be used to support clustering of web applications for Geronimo configurations
which
+  use the Tomcat Web Container (WADI support for Jetty was in previous releases). 
+- Applications can be deployed to administratively-defined groups of Geronimo servers
+
+Monitoring Console Plugin
+- The monitoring console plugin provides monitoring support in the Geronimo admin console.

+  The monitoring console can gather statistics and performance data from multiple Geronimo

+  servers and graphically display this data to users.
+
+
+Geronimo 2.2 Issues Resolved
+------------------------------
+** Bug
+TBD
+
+** Improvement
+TBD
+
+
+** New Feature
+TBD
+
+
+Certification Status
+--------------------
+Apache Geronimo v2.2 has passed 100% of SUN's Java Enterprise Edition 5.0 
+Certification Test Suite. See "Distributions" for further details.
+
+
+Distributions
+-------------
+Apache Geronimo v2.2 is available in five distributions so you can pick the 
+one that best fits your environment.
+
+The available distributions are as follows:
+
+Certified distributions:
+- Apache Geronimo with Tomcat web container, AXIS2 for Web Services and OpenJPA
+  for persistence.
+- Apache Geronimo with Jetty web container, CXF for Web Services and OpenJPA 
+  for persistence.
+
+Non-Certified distributions:
+- Little-G with Tomcat web container, minimal configuration.
+- Little-G with Jetty web container, minimal configuration.
+- Geronimo framework, stripped down Geronimo pluggable framework.
+
+Note: Non-Certified distributions do not contain a complete JavaEE5 stack and so 
+cannot be certified.  Certified distributions can be reconfigured by the user 
+(such as Tomcat web container with CXF for Web Services). 
+
+
+Supported features
+------------------
+All programming elements of the Java EE 5.0 Specification are available.  
+
+
+Known Issues and Limitations
+----------------------------
+** Bug
+TBD
+
+** Improvement
+TBD
+
+
+** New Feature
+TBD
+

Propchange: geronimo/server/trunk/RELEASE_NOTES-2.2.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: geronimo/server/trunk/RELEASE_NOTES-2.2.txt
------------------------------------------------------------------------------
    svn:keywords = Date Revision

Propchange: geronimo/server/trunk/RELEASE_NOTES-2.2.txt
------------------------------------------------------------------------------
    svn:mime-type = text/plain

Modified: geronimo/server/trunk/assemblies/geronimo-boilerplate/pom.xml
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/assemblies/geronimo-boilerplate/pom.xml?rev=679163&r1=679162&r2=679163&view=diff
==============================================================================
--- geronimo/server/trunk/assemblies/geronimo-boilerplate/pom.xml (original)
+++ geronimo/server/trunk/assemblies/geronimo-boilerplate/pom.xml Wed Jul 23 12:33:22 2008
@@ -290,6 +290,21 @@
                     </execution>
 
                     <execution>
+                        <phase>process-resources</phase>
+                        <id>copy-txt-files</id>
+                        <goals>
+                            <goal>run</goal>
+                        </goals>
+                        <configuration>
+                            <tasks>
+                                <echo>Copying README, and RELEASE_NOTES txt files ${project.basedir}/../..
to underlay - ${project.build.outputDirectory}/contents</echo>
+                                <copy file ="${project.basedir}/../../README.txt" todir="${project.build.outputDirectory}/contents"
failonerror="true" overwrite="true" />
+                                <copy file ="${project.basedir}/../../RELEASE_NOTES-2.2.txt"
todir="${project.build.outputDirectory}/contents" failonerror="true" overwrite="true" />
+                            </tasks>
+                        </configuration>
+                    </execution>
+
+                    <execution>
                         <id>install-underlay</id>
                         <phase>process-classes</phase>
                         <goals>



Mime
View raw message