iEat/defs/docs/demo

=======================================================================
iEat - Internet recipe database
Live Demo @VERSION@ @BUILD_DATE@
=======================================================================

This is the Live Demo distribution of iEat. This is a complete
stand-alone iEat application pre-configured to run without any
modification so you can see how iEat works. The only thing you need
besides the Live Demo (which you have if you're reading this) is a
Java 5 Runtime Environment (i.e. version 1.5) or higher. You can get a
JRE from Sun at http://java.sun.com/. Other vendors make JREs, any one
of them should work as long as they are version 1.5 or higher.

Starting the Live Demo -----------------------------------------------

To start iEat simply run './start.sh' or '.\start.bat' script (as
appropriate for your operating system). This will start the iEat
application running with the included servlet container. After a brief
moment you should be able to go to the following URL in a browser:

http://localhost:8080/ieat

If you get an error that the JAVA_HOME environment variable is not
defined, you need to set this environment variable, which varies
depending on the operating system you're using. For Unix-like OSes
using sh-derived shells you can run

$ JAVA_HOME=/path/to/jdk ./start.sh

For Windows users you can run

> set JAVA_HOME=\path\to\jdk
> .\start.bat

From the iEat homepage you can browse recipes. The first time you
start the Live Demo, however, there will not be any recipes available.
To add recipes you must log in and add or import recipes.


Stopping the Live Demo -----------------------------------------------

To stop iEat simply run './stop.sh' or '.\stop.bat' script (as
appropriate for your operating system).


Logging into the Live Demo --------------------------------------------

The Live Demo comes configured with an admin-level user so you can log
into the application and add recipes, users, etc. Log in with the
following information:

Username: demo
Password: demo


Limitations of Live Demo ----------------------------------------------

The Live Demo has some limitations from a regular iEat configuration:

- Self registration is disabled. Because registration requires
configuring an SMTP mail server to send emails with this feature
has been disabled. If you want to enable it, you must edit the

/jakarta-tomcat/conf/Catalina/localhost/ieat.xml

file and change the value of the 'mail.smtp.host' property to a
valid SMTP server you can send emails from. Then run the setup
wizard (Admin > Setup Wizard) to enable the Registration Feature.


Troubleshooting the Live Demo -----------------------------------------

If you run into problems getting the Live Demo running, look at the
/jakarta-tomcat/logs directory for the application log
files. They may provide clues as to the cause of the problem.