Back to files

###########################################################

##                                                       ##
## The Rimfaxe Web Server                                ##
## Rimfaxe ApS                                           ##
##                                                       ##
## author : Lars Andersen                                ##
## email : lars@rimfaxe.com                              ##
##                                                       ##

###########################################################

Important note!

RWS deploys web applications differently than standard jsp/servlet engines. Please read this README carefully!

The Rimfaxe Web Server (short form RWS), is a web server featuring :

JSP/servlet container
Extensive caching abilities
Nonblocking IO
Compilation of JSP pages to native dynamic libraries Compilation of web application to native dynamic libraries Super lean and fast
Now suports filters mapped on url-patterns as in the Servlet 2.3 specification.

RWS does not provide :

Support for WAR files
Several other features in the jsp/servlet specs. For completeness, go for Tomcat.

Get Started :

First make sure you have gcc3.3 installed.

'gcc -v'

2. Prepare the Makefile

Change to the 'source' directory.
Edit the first lines in 'Makefile' to match your environment.

3. Clear the classpath :

run 'unset $CLASSPATH'

4. Now build binaries :

run 'make'

5. Configure RWS

Exit the 'source' directory.

Change to the 'config' directory.

Edit the rimfaxe-webserver.xml file. Edit the value of <home> to match the directory where you installed RWS. Next edit the value of <gcj> to point to the gcj compiler.

6. First run and testing.

Exit the 'config' directory.

run './start.sh'

Open http://localhost:8081/ in your browser.

How to deploy your own web application :

WEB-APPS cannot be deployed in a WAR with Rimfaxe Web Server, it must be deployed as a directory.

Edit config/rimfaxe-webserver.xml to include the path to your web application.

Do not deploy classes in WEB-INF/classes. RWS will ignore them! In the WEB-INF directory, create a directory named 'rws'. In this directory, create the following subdirs : 'jsplib', 'jsp', 'jars', 'src', 'lib'

See 'webroot/default/WEB-INF/rws' or 'webroot/examples/WEB-INF/rws' for an example.

Deploy the SOURCE (.java files) of your WEB-APP in WEB-INF/rws/src

Once RWS has started up the first time you may remove the sources again. This may be desirable for security reasons.

Deploy JSP files the usual way.

Now start RWS. The app will be compiled into a library on startup. This may take a while. JSP pages are compiled on the first request. If one or more source files provokes an error, the whole app will probably fail. Errors in JSP's will produce a nice error page.

Read documentation on http://www.rimfaxe.com/rws/doc/

License :

This package is written by Lars Andersen <lars@rimfaxe.com> and licensed by Rimfaxe ApS.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
The end-user documentation included with the redistribution, if any, must include the following acknowlegement:
"This product includes software developed by Rimfaxe ApS (www.rimfaxe.com)" Alternately, this acknowlegement may appear in the software itself, if and wherever such third-party acknowlegements normally appear.
The names "Rimfaxe", "Rimfaxe Software", "Lars Andersen" and "Rimfaxe WebServer" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact info@rimfaxe.com
Products derived from this software may not be called "Rimfaxe" nor may "Rimfaxe" appear in their names without prior written permission of the Rimfaxe ApS.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Acknowledgements :

RWS uses SEDA Sandstorm and the Apache Jakarta project.

SEDA Sandstorm homepage : http://www.eecs.harvard.edu/~mdw/proj/seda/

Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without written agreement is hereby granted, provided that the above copyright notice and the following two paragraphs appear in all copies of this software.

IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Apache Jakarta homepage : http://jakarta.apache.org

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
The end-user documentation included with the redistribution, if any, must include the following acknowlegement:
"This product includes software developed by the Apache Software Foundation (http://www.apache.org/)." Alternately, this acknowlegement may appear in the software itself, if and wherever such third-party acknowlegements normally appear.
The names "The Jakarta Project", "Tomcat", and "Apache Software Foundation" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact apache@apache.org.
Products derived from this software may not be called "Apache" nor may "Apache" appear in their names without prior written permission of the Apache Group.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals on behalf of the Apache Software Foundation. For more information on the Apache Software Foundation, please see <http://www.apache.org/>.