geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jason Dillon <ja...@planet57.com>
Subject Is anything in README.txt relevant anymore?
Date Mon, 10 Jul 2006 04:44:43 GMT
I think we need to clean up the main README.txt.  Looks like most of  
the content is relatively dated and should be updated or removed.

Also, a bunch of this information is about to use the server... when  
I think that the README.txt at this level should be more focused on  
how to build the server and run tests.  This should not be the same  
README.txt that we provide with the assembly, so we can focus the  
content in each README.txt for its expected users.

Below is what we currently have.  What parts of it are still  
relevant, which parts do we want to keep and which should go?  Even  
further down is a little snip of how to build, which I think we need  
to add... with some other details eventually too, and probably a link  
back to a more compressive page on cwiki.

<snip>
======================================================
Apache Geronimo milestone build M4  (August 10, 2005)

http://geronimo.apache.org/
------------------------------------------------------


___________________
Documentation
===================
This README serves as five minute overview of Geronimo, but better
documentation can be found here:
    -  http://geronimo.apache.org/documentation.html


___________________
Release Notes
===================

Please read the RELEASE_NOTES for a complete list of things that are
not yet functional.  We wrote those up to save you time trying to get
things to work we know are not implemented.

___________________
Installation
===================

If you've downloaded and unpacked a binary distribution of Geronimo,
then you are finished with installation.  You can also use the
installer JAR to customize things like network ports and the
administrative login during installation.

___________________
Geronimo Home
===================
The GERONIMO_HOME directory, is the directory where the Geronimo
binary was unpacked or the it is the 'target' directory created by
Maven from a source distribution.
If you unpacked the binary into the directory C:\geronimo,
for example, than this directory is your GERONIMO_HOME directory.
The GERONIMO_HOME directory is referred to in various parts of the
documentation, so it's good to remember where it is.


___________________
Starting
===================

The main server class is also packed in an executable jar,
bin/server.jar, and can be ran in a way similar to the deploy tool.

    C:\geronimo> java -jar bin\server.jar

Once the server has started, you can access the welcome page by
pointing your browser to:

    http://localhost:8080/

You can also visit the web management console at:
    http://localhost:8080/console/

To access the console, use the administrative account, which is
username "system" and password "manager" by default.


___________________
Deploying
===================

The Geronimo deployment tool is packaged in the executable jar
bin/deployer.jar under the GERONIMO_HOME and can be executed like
this (assuming the server is already running):

    C:\geronimo> java -jar bin\deployer.jar deploy myDataSource.rar
    C:\geronimo> java -jar bin\deployer.jar deploy myEJB.jar
    C:\geronimo> java -jar bin\deployer.jar deploy myWebapp.war
    C:\geronimo> java -jar bin\deployer.jar deploy myApp.ear

Notice that the deployer.jar is capable of handling a number of
different archive types; rar, war, ejb jar, and EAR.

The deployer will prompt you for a username and password; the
default administrative account has username "system" and password
"manager".


___________________
Support
===================
Any problems with this release can be reported to the Geronimo
mailing list or Jira issue tracker.

Mailing list archive:
http://mail-archives.apache.org/mod_mbox/geronimo-user/

Mailing list subscription:
user-subscribe@geronimo.apache.org

Jira:
http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10220
</snip>

<snip>

+----------------------------+
| Bootstrapping and Building |
+----------------------------+

Geronimo currently must be bootstrapped, which will checkout and build
all required thirdparty projects and then build all modules that are
used by plugin extentions.

To perform a clean bootstrap simply run:

     ./bootstrap

Once bootstrapped once, repeated staged builds can be run with:

     ./build

Both will run a multi-stage build.  When making changes it is  
recommended to
run `bootstrap` to ensure that no locally installed artifacts are  
interfearing
with a clean build and that all thordparty projects are built from  
the latest
sources.
</snip>

--jason

Mime
View raw message