From e969380aab23b46ffeac543a8fb4fa37db0222d5 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Felix=20D=C3=B6rre?= <felix@dogcraft.de>
Date: Sat, 21 Jun 2014 22:12:47 +0200
Subject: [PATCH] Cleanup doc, add instructions for setting up a local run.

---
 doc/beforeYouStart.txt            |  9 +++++++++
 doc/generateTruststore.sh         | 10 ----------
 doc/{ => scripts}/.gitignore      |  0
 doc/{ => scripts}/generateKeys.sh |  2 +-
 doc/scripts/generateTruststore.sh | 10 ++++++++++
 doc/{ => scripts}/getJetty.sh     |  2 +-
 doc/{ => scripts}/selfsign.config |  0
 7 files changed, 21 insertions(+), 12 deletions(-)
 create mode 100644 doc/beforeYouStart.txt
 delete mode 100644 doc/generateTruststore.sh
 rename doc/{ => scripts}/.gitignore (100%)
 rename doc/{ => scripts}/generateKeys.sh (89%)
 create mode 100644 doc/scripts/generateTruststore.sh
 rename doc/{ => scripts}/getJetty.sh (93%)
 rename doc/{ => scripts}/selfsign.config (100%)

diff --git a/doc/beforeYouStart.txt b/doc/beforeYouStart.txt
new file mode 100644
index 00000000..62f4d6fa
--- /dev/null
+++ b/doc/beforeYouStart.txt
@@ -0,0 +1,9 @@
+Before you start using you might want to:
+
+- create a keypair for the server (scripts/generateKeys.sh)
+- create a truststore for the server (scripts/generateTruststore.sh)
+
+- download locales (util/ org.cacert.gigi.util.FetchLocales)
+- write your sql connection properties: config/sql.properties.template -> config/sql.properties
+- add the corresponding jdbc connector to your path.
+
diff --git a/doc/generateTruststore.sh b/doc/generateTruststore.sh
deleted file mode 100644
index aa8532d5..00000000
--- a/doc/generateTruststore.sh
+++ /dev/null
@@ -1,10 +0,0 @@
-# this script generates a simple self-signed keypair
-
-wget -N http://www.cacert.org/certs/root.crt
-wget -N http://www.cacert.org/certs/class3.crt
-
-keytool -importcert -keystore ../config/cacerts.jks -file root.crt -alias root -storepass "changeit"
-keytool -importcert -keystore ../config/cacerts.jks -file class3.crt -alias class3 -storepass "changeit"
-keytool -importcert -keystore ../config/cacerts.jks -file jetty.crt -alias own -storepass "changeit"
-
-keytool -list -keystore ../config/cacerts.jks -storepass "changeit"
diff --git a/doc/.gitignore b/doc/scripts/.gitignore
similarity index 100%
rename from doc/.gitignore
rename to doc/scripts/.gitignore
diff --git a/doc/generateKeys.sh b/doc/scripts/generateKeys.sh
similarity index 89%
rename from doc/generateKeys.sh
rename to doc/scripts/generateKeys.sh
index e0cdff9f..b5b94fc4 100755
--- a/doc/generateKeys.sh
+++ b/doc/scripts/generateKeys.sh
@@ -3,4 +3,4 @@
 openssl genrsa -out jetty.key 4096
 openssl req -new -key jetty.key -out jetty.csr -subj "/CN=localhost" -config selfsign.config
 openssl x509 -req -days 365 -in jetty.csr -signkey jetty.key -out jetty.crt
-openssl pkcs12 -inkey jetty.key -in jetty.crt -export -passout pass: -out ../config/keystore.pkcs12
+openssl pkcs12 -inkey jetty.key -in jetty.crt -export -passout pass: -out ../../config/keystore.pkcs12
diff --git a/doc/scripts/generateTruststore.sh b/doc/scripts/generateTruststore.sh
new file mode 100644
index 00000000..6a9e03bf
--- /dev/null
+++ b/doc/scripts/generateTruststore.sh
@@ -0,0 +1,10 @@
+# this script generates a simple self-signed keypair
+
+wget -N http://www.cacert.org/certs/root.crt
+wget -N http://www.cacert.org/certs/class3.crt
+
+keytool -importcert -keystore ../../config/cacerts.jks -file root.crt -alias root -storepass "changeit"
+keytool -importcert -keystore ../../config/cacerts.jks -file class3.crt -alias class3 -storepass "changeit"
+keytool -importcert -keystore ../../config/cacerts.jks -file jetty.crt -alias own -storepass "changeit"
+
+keytool -list -keystore ../../config/cacerts.jks -storepass "changeit"
diff --git a/doc/getJetty.sh b/doc/scripts/getJetty.sh
similarity index 93%
rename from doc/getJetty.sh
rename to doc/scripts/getJetty.sh
index 9c9dddad..cbec3669 100644
--- a/doc/getJetty.sh
+++ b/doc/scripts/getJetty.sh
@@ -1,7 +1,7 @@
 #!/bin/sh
 JETTY=C:/jars/jetty-distribution-9.1.0.RC0/org.eclipse.jetty.project
 
-pushd ../lib/jetty/org/eclipse/jetty
+pushd ../../lib/jetty/org/eclipse/jetty
 rm -fR *
 
 pushd $JETTY
diff --git a/doc/selfsign.config b/doc/scripts/selfsign.config
similarity index 100%
rename from doc/selfsign.config
rename to doc/scripts/selfsign.config
-- 
2.39.2