README.md

   1 # Jellyfish #
   2
   3 This is a web cache based on java and netty.
   4
   5 ## Description ##
   6
   7 This project aims to implement an HTTP based web cache, with the following features:
   8
   9 * Support for multiple protocols working together using something like apache tomcat connectors;
  10
  11 * Support for HTTP, HTTP/S and SPDY;
  12
  13 * Support for multiple cache replacement policies (with easy switching);
  14
  15 * Support for custom handlers, allowing a user to change the logic of a proxy, in order to implement something like a web crawler;
  16
  17 * Support for disconnected/connected mode, allowing the usage of a browser even when there is no network connection, and the enforcing of consistency rules when a connection is available;
  18
  19 * Code that is easy to understand and modify if one needs to.
  20
  21 ## Todo ##
  22
  23 There are several things on the todo list, and among them:
  24
  25 * Improve the documentation, mainly create a user guide, some of the regular files on a tarball (like a install, news, authors, etc.) and create some developer or design documentation, something like an guide that explains the main building blocks of the project together with references to the classes that implement those blocks;
  26
  27 * Work with the gradle build system, in order to create a better release model (one that is capable of producing tarballs and zip files containing the binaries, sources and documentation of a release) and integrate other tools like checkstyle, findbugs, etc.
  28
  29 * Complete the code in order to create a cache, mainly test the existing cache system based on ehcache, create the modules implementing the consistency policies and some of the modules implementing the replacement strategies;
  30
  31 So that is the roadmap for now, but once that is done, some other things are on the list, like:
  32
  33 * HTTP/S and SPDY support;
  34
  35 * Support for filtering on the pages;
  36
  37 * Support for image transformation;
  38
  39 * Support for youtube and some other fancy sites (like facebook games);
  40
  41 * ...
  42
  43 ## License ##
  44
  45 This project is licensed under the Apache License 2.0.
  46
  47 ## Install ##
  48
  49 To install this software you must have gradle installed, and issue gradle distZip in order to create an release zip file.
  50
  51 Then go to ${path_to_source_dir}/build/distributions and extract the zip file in the folder to the location where you want to install jellyfish.
  52
  53 Then open an console shell, go to the directory where you extracted the files and type bin/jellyfish -c configuration.xml.
  54
  55 If you want to customize the server, please edit the configuration.xml, logback.xml and ehcache.xml in order to configure the server, the logging system or the cache respectively.