File	Date	Author	Commit
doc	2011-10-20	Emmanuel Benazera	[bde45a] Merge branch 'experimental'
resources	2011-10-08	Stéphane Bonhomme	[cc9797] Merge branch 'experimental' of git://seeks.git....
src	2012-08-28	Emmanuel Benazera	[864016] plugins are now started in the order they are l...
.gitignore	2011-10-20	Emmanuel Benazera	[bde45a] Merge branch 'experimental'
AGPL-3.txt	2010-03-27	beniz	[196b35] Merge branch 'master' into dht
AUTHORS	2012-04-03	Emmanuel Benazera	[5647db] Merge branch 'experimental'
BSD-yui.txt	2010-03-27	beniz	[196b35] Merge branch 'master' into dht
COPYING	2010-03-27	beniz	[196b35] Merge branch 'master' into dht
ChangeLog	2012-04-03	Emmanuel Benazera	[792f43] Merge branch 'experimental'
GPL-2.0.txt	2010-03-27	beniz	[196b35] Merge branch 'master' into dht
INSTALL	2009-12-03	beniz	[bc9226] initial commit
LGPL-2.1.txt	2010-03-27	beniz	[196b35] Merge branch 'master' into dht
Licenses	2010-03-27	beniz	[196b35] Merge branch 'master' into dht
Makefile.am	2010-12-05	beniz	[def7a9] Merge branch 'experimental'
NEWS	2009-12-03	beniz	[bc9226] initial commit
README	2011-10-08	Stéphane Bonhomme	[cc9797] Merge branch 'experimental' of git://seeks.git....
acinclude.m4	2010-12-05	beniz	[def7a9] Merge branch 'experimental'
aminclude.am	2010-12-05	beniz	[def7a9] Merge branch 'experimental'
autogen.sh	2009-12-03	beniz	[bc9226] initial commit
configure.in	2012-04-03	Emmanuel Benazera	[792f43] Merge branch 'experimental'

Read Me

Seeks is a websearch proxy and collaborative distributed tool for websearch.
Visit http://www.seeks-project.info for more information on the project.

----------------------------------------------------------------------------
1. Content

Seeks code provides:
- a web proxy,
- a websearch meta search engine that aggregates results and ranks them
  based on consensus.
- a plugin system and a set of default plugins, including websearch and
  ad blocking plugins.
- a P2P collaborative filter that enables decentralized collaborative
  searching and sharing.

----------------------------------------------------------------------------
2. Installation

Dependencies:
- libcurl
- libxml2
- libpcre
- tokyo cabinet
- protocol buffers
- libevent (optional, 2.x preferred)
- opencv (optional)
- docbook2x-man (optionnal)

From the root directory, run
./autogen.sh
./configure
make

Compilation options can be listed with ./configure --help

----------------------------------------------------------------------------
3. Running Seeks

This is an early version of Seeks, it is recommended your run it from the
repository you compiled it from.

cd src
./seeks

see ./seeks --help for options.

For example, by default seeks does not run as a daemon. If you would like
to have it so, run ./seeks --daemon

Other important options can be modified in the configuration file, src/config

By default, seeks runs as proxy on the local machine (127.0.0.1) on port 8250.
If you would like to change it, do it in the configuration file, src/config

Once started, to use seeks, tell your web browser to connect to the Internet
through seeks' web proxy.

If you'd like to use your seeks node through the API, you'll find
details here:
http://seeks-project.info/wiki/index.php/API-0.4.0

----------------------------------------------------------------------------
4. Troubleshooting

Seeks is young, so it is likely there are bugs. However, before all, be
sure to read the faq and user manuals, respectively at:

http://www.seeks-project.info/wiki/index.php/FAQ
http://www.seeks-project.info/wiki/index.php/User_Manual

To report bugs, please use the interface here :
http://redmine.seeks-project.info/projects/seeks/issues/new

For discussion and getting more immediate help, join us on irc,
channel #seeks on irc.freenode.net