| 1 |
This is the README file for version 1.7.0 of the Helma Javascript |
|---|
| 2 |
Web Application Framework. |
|---|
| 3 |
|
|---|
| 4 |
============== |
|---|
| 5 |
STARTING HELMA |
|---|
| 6 |
============== |
|---|
| 7 |
|
|---|
| 8 |
With the default package installed, all you need to do to get |
|---|
| 9 |
started is: |
|---|
| 10 |
-> make sure that you have Java 1.4 or higher installed |
|---|
| 11 |
-> call start.sh, resp. start.bat depending on your platform |
|---|
| 12 |
-> direct your web browser to http://localhost:8080/ |
|---|
| 13 |
See below for more detailed information. |
|---|
| 14 |
|
|---|
| 15 |
=========== |
|---|
| 16 |
ABOUT HELMA |
|---|
| 17 |
=========== |
|---|
| 18 |
|
|---|
| 19 |
Helma is an open source web application framework for fast |
|---|
| 20 |
and efficient scripting and serving of your websites and |
|---|
| 21 |
Internet applications. |
|---|
| 22 |
|
|---|
| 23 |
Helma is written in Java and employs Javascript for its server-side |
|---|
| 24 |
scripting environment, removing the need for compilation cycles and |
|---|
| 25 |
reducing development costs while giving you instant access to leverage |
|---|
| 26 |
the whole wealth of Java libraries out there. |
|---|
| 27 |
|
|---|
| 28 |
Helma pioneered the simple and codeless mapping of application objects |
|---|
| 29 |
to database tables, which has only recently come into vogue with other |
|---|
| 30 |
web frameworks. In addition, an embedded object-oriented database |
|---|
| 31 |
performs automatic data persistence of unmapped objects. |
|---|
| 32 |
|
|---|
| 33 |
Helma has proven itself to be stable and fast, capable of serving high |
|---|
| 34 |
traffic sites with hundreds of thousands of dynamic pages per day. The |
|---|
| 35 |
Austrian Broadcasting Corporation, popular weblog hosting sites such |
|---|
| 36 |
as antville.org, twoday.net, and blogger.de, among many others, have |
|---|
| 37 |
successfully been deploying Helma for several years now. |
|---|
| 38 |
|
|---|
| 39 |
=================== |
|---|
| 40 |
SYSTEM REQUIREMENTS |
|---|
| 41 |
=================== |
|---|
| 42 |
|
|---|
| 43 |
You need a Java virtual machine 1.4 or higher to run Helma. |
|---|
| 44 |
|
|---|
| 45 |
For Windows, Linux and Solaris you can get a Java runtime or development |
|---|
| 46 |
kit from http://java.sun.com/j2se/downloads.html. If you are on Mac OS X, |
|---|
| 47 |
you already have a Java runtime that will work well with Helma. |
|---|
| 48 |
|
|---|
| 49 |
For other operating systems, please consult the documentation about the |
|---|
| 50 |
availabilty of a Java 1.4 (or higher) runtime. |
|---|
| 51 |
|
|---|
| 52 |
============================ |
|---|
| 53 |
INSTALLING AND RUNNING HELMA |
|---|
| 54 |
============================ |
|---|
| 55 |
|
|---|
| 56 |
Simply unzip or untar the contents of the archive file into any place |
|---|
| 57 |
on your hard disk. Start Helma by invoking start.bat or start.sh from |
|---|
| 58 |
the command line, depending on whether you are on Windows or |
|---|
| 59 |
Linux/Unix/MacOSX. If the java command is not found, try setting the |
|---|
| 60 |
JAVA_HOME variable in the start script to the location of your Java |
|---|
| 61 |
installation. |
|---|
| 62 |
|
|---|
| 63 |
You may also want to have a look at the start script for other settings. |
|---|
| 64 |
You can adjust server wide settings in the server.properties file. For |
|---|
| 65 |
example, you should set the smtp property to the name of the SMTP server |
|---|
| 66 |
that Helma should use to send Email. Applications can be started or |
|---|
| 67 |
stopped by editing the apps.properties file through the web interface |
|---|
| 68 |
using the Management application that is part of Helma. |
|---|
| 69 |
|
|---|
| 70 |
If you manage to get it running you should be able to connect your |
|---|
| 71 |
browser to http://localhost:8080/ or http://127.0.0.1:8080/ |
|---|
| 72 |
(port 8080 on the local machine, that is). |
|---|
| 73 |
|
|---|
| 74 |
Helma comes with a version of Jetty, a lightweight yet industrial strenth |
|---|
| 75 |
web server developed by Mortbay Consulting. See http://jetty.mortbay.com/ |
|---|
| 76 |
for more information. While Jetty works well for deploying real web sites, |
|---|
| 77 |
you may want to run Helma behind an existing web server. This is most |
|---|
| 78 |
easily done by running Helma with the AJPv13 listener which allows you to |
|---|
| 79 |
plug Helma into any web server using the Apache mod_jk module. See |
|---|
| 80 |
http://tomcat.apache.org/connectors-doc/index.html for more |
|---|
| 81 |
information on mod_jk and AJPv13. |
|---|
| 82 |
|
|---|
| 83 |
Finally, Helma can be plugged into Servlet containers using Servlet |
|---|
| 84 |
classes that communicate with Helma either directly or via Java RMI. |
|---|
| 85 |
(Be warned that these options may be harder to set up and maintain though, |
|---|
| 86 |
since most of the recent development efforts have been geared towards the |
|---|
| 87 |
mod_jk/AJPv13 setup.) |
|---|
| 88 |
|
|---|
| 89 |
===================================== |
|---|
| 90 |
DOCUMENTATION AND FURTHER INFORMATION |
|---|
| 91 |
===================================== |
|---|
| 92 |
|
|---|
| 93 |
After installing and running Helma, you will be able to access |
|---|
| 94 |
introductions to the features of Helma and the various included |
|---|
| 95 |
development tools. Further information you will find on the helma.org |
|---|
| 96 |
website: |
|---|
| 97 |
|
|---|
| 98 |
http://helma.org/docs/guide/ |
|---|
| 99 |
http://helma.org/docs/reference/ |
|---|
| 100 |
http://helma.org/docs/tutorial/ |
|---|
| 101 |
http://helma.org/docs/docbook/ |
|---|
| 102 |
|
|---|
| 103 |
======================== |
|---|
| 104 |
MAILING LIST AND SUPPORT |
|---|
| 105 |
======================== |
|---|
| 106 |
|
|---|
| 107 |
Please join us on the Helma mailing lists where we will be happy to |
|---|
| 108 |
answer any further questions you may have! |
|---|
| 109 |
|
|---|
| 110 |
http://helma.org/development/mailinglists/ |
|---|
| 111 |
|
|---|
| 112 |
|
|---|
| 113 |
|
|---|
