README for yacy (C) by Michael Peter Christen; mc@anomic.de
-------------------------------------------------------------------------------
Please visit www.anomic.de for latest changes or new documentation.
YACY comes with ABSOLUTELY NO WARRANTY!
This is free software, and you are welcome to redistribute it
under certain conditions; see file gpl.txt for details.
-------------------------------------------------------------------------------

This is a caching http proxy with integrated search engine.
The complete documentation can be found inside the 'doc' subdirectory
in this release.
Start browsing the manual by opening the index.html file with our web browser.

YOU NEED JAVA 1.4.2 TO RUN THIS APPLICATION! PLEASE DOWNLOAD FROM java.sun.com

Startup of YACY:

- on Linux        : start startYACY.sh ("nohup ./startYACY.sh > yacy.log &")
- on Windows      : double-click startYACY.bat
- on Mac OS X     : double-click startYACY.command (alias possible!)
- on any other OS : set your classpath to the 'Classes' folder
                    and execute yacy.class, while your current system
		    path must target the release directory to access the
                    configuration files.

Then start to administrate yacy by using the applications on-line
interface: browse to http://localhost:8080, you see you personal
proxy configuration and administration interface.

Configure you internet connection to use yacy at port 8080.
You can also change the default proxy port.

If you like to use yacy not as proxy but only as distributed crawling/search
engine, you can do so. Start crawling at the 'Index Creation' menu point.

If you have any questions, please do not hesitate to contact the author:
Send a mail to Michael Christen (mc@anomic.de) with a meaningful subject
including the word 'yacy' to prevent that your email gets stuck
in my anti-spam filter.

If you like to have a customized version for special needs, feel free to ask
the author for a business proposal to customize yacy according to
your needs. We provide also integration solutions if the software is about
to be integrated into your enterprise application.

Germany, Frankfurt a.M., 05.01.2005
Michael Peter Christen