improve documentation webid
authorHenry Story <henry.story@bblfish.net>
Tue, 03 Apr 2012 11:27:56 +0200
branchwebid
changeset 183 dd93cae6a6f1
parent 182 f117f8f1ca5e
child 184 213512a4f137
improve documentation
README.markdown
src/main/scala/Lang.scala
--- a/README.markdown	Sun Mar 11 15:37:54 2012 +0100
+++ b/README.markdown	Tue Apr 03 11:27:56 2012 +0200
@@ -71,16 +71,32 @@
 
  *   --relax   All documents exist as empty RDF files (like a wiki).
  *   --strict  Documents must be created using PUT else they return 404
+
+To run with WebID see next section.
     
     
 HTTPS with WebID 
 ----------------
 
 ### to run on https with WebID
-    1. make a directory called tmp 
-    2. lauch
-    > java -Djetty.ssl.keyStoreType=JKS -Djetty.ssl.keyStore=/Users/hjs/tmp/cert/KEYSTORE.jks -Djetty.ssl.keyStorePassword=secret -jar target/read-write-web.jar --https 8443 tmp /2011/09
+    
+    Wether you run the binary from the command line as described below or run it directly inside sbt you need to set the following parameters to java
+ * -Djetty.ssl.keyStoreType=JKS                              - the keystore type (usually JKS)
+ * -Djetty.ssl.keyStore=src/test/resources/KEYSTORE.jks      - the path to the keystore  
+ * -Djetty.ssl.keyStorePassword=secret                       - the secret password for the keystore
+ * -Dsun.security.ssl.allowUnsafeRenegotiation=true          - to allow unsafe TLS renegotiation
+ * -Dsun.security.ssl.allowLegacyHelloMessages=true          - to allow legacy TLS hello Messages
 
+The sun.security options are described in more detail http://download.oracle.com/javase/7/docs/technotes/guides/security/jsse/JSSERefGuide.html#workarounds
+So to run the compiled jar you can use
+
+   > java -Djetty.ssl.keyStoreType=JKS -Djetty.ssl.keyStore=/Users/hjs/tmp/cert/KEYSTORE.jks -Djetty.ssl.keyStorePassword=secret -jar target/read-write-web.jar --https 8443 www_test /2011/09
+
+or to run sbt use the shorthand options in the bin/rwsbt.sh shell script eg
+
+  > bin/rwsbt.sh -n -sslUnsafe -sslLegacy
+
+(exercise: improve the script so that all options can be set with it)
 ### to enable debug add the following parameters after 'java'
 
      -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005
--- a/src/main/scala/Lang.scala	Sun Mar 11 15:37:54 2012 +0100
+++ b/src/main/scala/Lang.scala	Tue Apr 03 11:27:56 2012 +0200
@@ -1,30 +1,10 @@
 /*
- * Copyright (c) 2011 Henry Story (bblfish.net)
- * under the MIT licence defined
- *    http://www.opensource.org/licenses/mit-license.html
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in the
- * Software without restriction, including without limitation the rights to use, copy,
- * modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
- * and to permit persons to whom the Software is furnished to do so, subject to the
- * following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
- * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
- * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
- * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
- * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
- * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * Copyright (c) 2011 World Wide Web Consortium
+ * under the W3C licence defined at http://opensource.org/licenses/W3C
  */
 
 package org.w3.readwriteweb
 
-import unfiltered.request._
-
 sealed trait Lang {
   
   def contentType = this match {