Author: psharples
Date: Mon Jan 30 15:53:59 2012
New Revision: 1237736
URL: http://svn.apache.org/viewvc?rev=1237736&view=rev
Log:
Instructions for setting up wookie on a usb drive. See WOOKIE-189.
Added:
incubator/wookie/site/trunk/content/wookie/docs/portable.mdtext
Modified:
incubator/wookie/site/trunk/content/wookie/docs/faq.mdtext
Modified: incubator/wookie/site/trunk/content/wookie/docs/faq.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/faq.mdtext?rev=1237736&r1=1237735&r2=1237736&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/faq.mdtext (original)
+++ incubator/wookie/site/trunk/content/wookie/docs/faq.mdtext Mon Jan 30
15:53:59 2012
@@ -91,10 +91,14 @@ Note that XSS prevention will still be i
This is an issue for DWR 2.* with Tomcat 7.* (or earlier versions of Tomcat
where useHttpOnly="true" is set.)
+# Can I run Wookie from a USB drive?
+
+Yes, more information can be found [here][7].
[1]: http://www.w3.org/TR/widgets/#internationalization-and-localization
[2]: http://site.icu-project.org/
[3]: developer/running.html#running_wookie_with_a_security_manager
[4]: https://issues.apache.org/jira/browse/WOOKIE-105
[5]: https://issues.apache.org/jira/browse/WOOKIE-44
- [6]: https://issues.apache.org/jira/browse/WOOKIE-222
\ No newline at end of file
+ [6]: https://issues.apache.org/jira/browse/WOOKIE-222
+ [7]: portable.html
\ No newline at end of file
Added: incubator/wookie/site/trunk/content/wookie/docs/portable.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/portable.mdtext?rev=1237736&view=auto
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/portable.mdtext (added)
+++ incubator/wookie/site/trunk/content/wookie/docs/portable.mdtext Mon Jan 30
15:53:59 2012
@@ -0,0 +1,94 @@
+Title: Portable Wookie
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+#Running Wookie from a USB Stick
+
+While having Wookie installed on your machine is a relatively trivial task to
setup, there may be some
+situations where also having a Wookie environment on a removable USB pen/flash
drive could be handy.
+Having such a Wookie setup allows you to plug and play Wookie on more than one
machine.
+
+The most simple method to create such an environment would be to use one of
the current Wookie standalone
+builds and configure that to run from your USB drive. Another more slightly
complicated method might be to
+install the Wookie source code onto your USB drive, along with any developer
tools needed to compile and run
+that code. What follows are some instructions on how you might go about doing
these tasks.
+
+In order to run Wookie from a USB drive, we assume that you would also want to
install a JDK onto your drive
+(in case another machine does not have Java already installed). However, bear
in mind that because of the
+differences in Java implementations on various platforms (Windows, Mac OS,
Linux etc), you may be limited to a
+windows/Mac OS/Linux portable version. It may be possible to install more
than one JDK onto your USB drive to
+achieve a cross platform version, but this guide does not try to describe such
an environment.
+
+## Making a USB drive environment from a Wookie standalone build (Windows only)
+
+<ul>
+ <li>If you haven't already, install a JDK to your local machine.</li>
+ Use a [Java JDK][1] (note the JRE is not sufficient)
+ <br/><br/>
+ <li>Find the folder where your JDK is installed locally.</li>
+ For example it may be found at C:\Program Files\Java\jdk1.6.0_24
+ <br/><br/>
+ <li>Create a new "Java" folder at the ROOT of your USB drive. (e.g
F:\Java)</li>
+ Copy the contents of C:\Program Files\Java\jdk1.6.0_24 to F:\Java.
+ <br/><br/>
+ <li>If you haven't already, download the latest Wookie Standalone
build</li>
+ Download [apache-wookie-0.9.1-incubating-standalone.zip][2]
+ <br/><br/>
+ <li>Unzip the download to the ROOT of your USB drive.</li>
+ This should create a new folder. (e.g
F:\apache-wookie-0.9.1-incubating-standalone)
+ <br/><br/>
+ <li>Next you will need to modify Wookies startup.bat and shutdown.bat
scripts</li>
+ First find the file
F:\apache-wookie-0.9.1-incubating-standalone\startup.bat and open it to edit.
+ Under the line...
+
+ Set PROGARGS=
+
+ ...add the following two lines underneath...
+
+ set pathDrive=%cd:~0,2%
+ set PATH=%PATH%;%pathDrive%\Java\bin
+ Now find the file
F:\apache-wookie-0.9.1-incubating-standalone\shutdown.bat and open it to edit.
+ Under the line...
+
+ REM under the License.
+
+ ...also add the same two lines underneath...
+
+ set pathDrive=%cd:~0,2%
+ set PATH=%PATH%;%pathDrive%\Java\bin
+
+ Save both files.
+ <br/><br/>
+ <li>You should now be able to use the USB installed version of the JDK
to run Wookie on another Windows machine.</li>
+ Just double click the startup.bat/shutdown.bat scripts to start/stop
Wookie.
+</ul>
+
+## Making a USB drive Developer environment for Wookie sources
+
+The previous instructions described how to use an existing build of Wookie to
create a USB Wookie environment. Additionally, it is
+also possible to create a developer environment on a USB stick. This means
you would be able to change the source code and update
+it, as well as receiving new updates to the code from other developers. To do
this you would have to download and install some
+additional software to your USB stick, namely an SVN client and also [Apache
Ant][3].
+
+Martin Hawksey has written an excellent guide on his blog detailing the
process of creating such an
+environment for windows. See his blog [here][4].
+
+
+ [1]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
+ [2]:
http://www.apache.org/dyn/closer.cgi/incubator/wookie/0.9.1-incubating/binary/standalone/apache-wookie-0.9.1-incubating-standalone.zip
+ [3]: http://ant.apache.org/
+ [4]:
http://mashe.hawksey.info/2011/03/your-own-wookie-widget-server-on-a-usb-stick-pc/
\ No newline at end of file
