- add sources.
[platform/framework/web/crosswalk.git] / src / chrome / common / extensions / docs / examples / extensions / irc / README.txt
1 This directory contains a simple irc app which is a work in progress.
2
3 /app - contains the manifest and any additional resources which are to be
4     packaged in a crx.
5
6 /servlet - contains the java servlet which will serve the live resources and
7     also proxy the irc traffic between the client and irc servers
8
9 /conf - contains configuration files for running the servlet.
10
11 This example depends on WebSockets, so it must be run inside a servlet container
12 which supports WebSockets.
13
14 The following are instructions for setting up a development jetty server to
15 host the servlet.
16
17 1) Get the jetty 7.x distribution from eclipse.org. Unpack it anywhere. We'll
18    call that directory JETTY_HOME
19 2) Delete the contents of JETTY_HOME/webapps.
20 3) Copy /conf/irc.xml to JETTY_HOME/contexts, edit the value of resourceBase in
21    irc.xml to point to the contents of /servlet.
22 4) Copy jetty.xml and webdefault.xml to JETTY_HOME/etc
23 5) Copy the following jars from JETTY_HOME/lib to /servlet/WEB-INF/lib:
24
25   jetty-client, jetty-continuation, jetty-http, jetty-io, jetty-servlets,
26   jetty-util
27   
28 6) Compile /servlet/src/org/chromium/IRCProxyWebSocket.java and put the
29    resulting class file in /servlet/WEB-INF/classes