From 9d295af293fb75d28989719b0f7d97b8acf39ce8 Mon Sep 17 00:00:00 2001
From: yvesf <yvesf-git@xapek.org>
Date: Tue, 5 Apr 2011 18:13:41 +0200
Subject: Doku deve/install im APT-Format statt xdoc

---
 src/site/apt/devel-install.apt  | 174 ++++++++++++++++++++++++++++++++
 src/site/xdoc/devel-install.xml | 213 ----------------------------------------
 2 files changed, 174 insertions(+), 213 deletions(-)
 create mode 100644 src/site/apt/devel-install.apt
 delete mode 100644 src/site/xdoc/devel-install.xml

(limited to 'src/site')

diff --git a/src/site/apt/devel-install.apt b/src/site/apt/devel-install.apt
new file mode 100644
index 0000000..01c4ae1
--- /dev/null
+++ b/src/site/apt/devel-install.apt
@@ -0,0 +1,174 @@
+            ------
+        Installation Guide
+            ------
+          Yves Fischer
+            ------
+          05.04.2011
+
+Installation
+
+* Mit Embedded Servlet Container
+  
+  <<<mvn jetty:run>>>
+
+  Standardmäßig lauscht jetty nun auf Port 8080
+
+* Mit Web-Archive (.war)
+
+  Ein Web-Archive kann mit dem Maven Kommando <<<mvn package>>> gebaut werden.
+
+
+Installation unter SLES 11.1
+
+* Vorbereitung
+
+  Es muss ein halbwegs aktuelles Java-JDK installiert sein, dieses
+kann z.B. von {{{http://java.sun.com}}Oracle}} für Linux/i386 bezogen
+werden.
+
+  Für die Ausführung von dhbw-calendar wird ein neuer Benutzer,
+z.B. mit namen <<<dhbwcalendar>>> angelegt.
+
+  {{{http://maven.apache.org}Maven2}} in
+<<<$HOME/share/apache-maven-2.2.1>>> installiert.
+
+  Für den angelegten Benutzer wird in seiner
+<<<$HOME/.profile>>>-Datei die Umgebungsvariablen <<<JAVA_HOME>>> und
+<<<M2_HOME>>> auf die jeweiligen Installationspfade gesetzt.
+
+  Git kann mit dem SuSe-Tool <<<zypper>>> installiert werden:
+
+---------------------------
+# zypper ar \
+  "http://download.opensuse.org/repositories/devel:/tools:/scm/SLE_11/devel:tools:scm.repo"
+# zypper install git
+---------------------------
+
+
+* Einrichtung
+
+  Das Projektverzeichnis wird mit git geklont:
+
+---------------------------------
+# su -l dhbwcalendar
+$ git clone ....dhbw-calendar URL...
+---------------------------------
+
+  Falls jetty verwendet wird und er im produktiven Setup nur auf dem Loopback
+Interface lauschen soll wird das in der <<<pom.xml>>> konfiguriert:
+
+--------------------------------------
+<connectors>
+  <connector
+      implementation="org.mortbay.jetty.nio.SelectChannelConnector">
+    <port>8080</port>
+    <host>127.0.0.1</host>
+  </connector>
+</connectors>
+--------------------------------------
+
+  Bei vaadin wird der <productionmode> im Deskriptor der Web-Applikation
+aktiviert:
+
+---------------------------
+<context-param>
+  <param-name>productionMode</param-name>
+  <param-value>true</param-value>
+  <description>Vaadin production mode</description>
+</context-param>
+---------------------------
+
+* SSL
+
+** Zertifikat erstellen
+
+  <Achtung:> Vor- Nachname ist der Common-Name = Hostname.
+
+---------------------------------------
+% keytool -keystore keystore -alias jetty -genkey -keyalg RSA
+Geben Sie das Keystore-Passwort ein:
+Geben Sie das Passwort erneut ein:
+
+Wie lautet Ihr Vor- und Nachname?
+[Unknown]: dualical.ba-horb.de
+Wie lautet der Name Ihrer organisatorischen Einheit?
+[Unknown]: DHBW Stuttgart Campus Horb
+Wie lautet der Name Ihrer Organisation?
+[Unknown]: Duale Hochschule Baden-Württemberg
+Wie lautet der Name Ihrer Stadt oder Gemeinde?
+[Unknown]: Horb
+Wie lautet der Name Ihres Bundeslandes oder Ihrer Provinz?
+[Unknown]: Baden-Württemberg
+Wie lautet der Landescode (zwei	Buchstaben) für	diese Einheit?
+[Unknown]: DE
+Ist CN=DHBW Calendar,OU=DHBW Stuttgart Campus Horb, O=Duale Hochschule Baden-Württemberg, L=Horb, ST=Baden-Württemberg,	C=DE richtig?
+[Nein]: Ja
+Geben Sie das Passwort für "jetty" ein.
+(EINGABETASTE, wenn Passwort dasselbe wie für Keystore):
+---------------------------------------
+
+** SSL in Jetty konfigurieren
+
+----------------------------------------------
+<configuration>
+  <connectors>
+    <connector
+        implementation="org.mortbay.jetty.nio.SelectChannelConnector">
+      <port>8080</port>
+    </connector>
+
+    <connector
+        implementation="org.mortbay.jetty.ssl.SslSelectChannelConnector">
+      <port>8443</port>
+      <keystore>${basedir}/server.keystore</keystore>
+      <keyPassword>bla</keyPassword>
+      <password>bla</password>
+    </connector>
+  </connectors>
+</configuration>
+<dependencies>
+  <dependency>
+    <groupId>org.mortbay.jetty</groupId>
+    <artifactId>jetty-ssl</artifactId>
+    <version>7.0.0.pre5</version>
+  </dependency>
+</dependencies> 
+-----------------------------------------------
+
+** Zertifikationsinfos
+
+  SSL-Fingerprint:
+
+--------------------------------
+
+% keytool -list -keystore server.keystore -rfc
+Geben Sie das Keystore-Passwort ein:
+Keystore-Typ: JKS
+Keystore-Provider: SUN
+
+Ihr Keystore enthält 1 Eintrag/-äge.
+
+jetty, 29.03.2011, PrivateKeyEntry, Zertifikatsfingerabdruck (MD5):
+B6:CA:AF:1C:8C:B7:38:38:36:2A:30:3C:A5:C2:54:20
+
+  -----BEGIN CERTIFICATE-----
+.... /Zertifikat im PEM Format/
+  -----END CERTIFICATE-----				
+--------------------------------
+
+  Die Verbindung kann jetzt mit wget überprüft werden
+
+--------------------------------
+# wget --ca-certificate=certificate.pem \
+      https://dualical.ba-horb.de:8443/dhbwcalendar/
+--------------------------------
+				
+  Weitere Informationen zum Zertifikat zeigt OpenSSL in Klartext an:
+
+--------------------------------
+# openssl x509 -noout -text -in certificate.pem
+--------------------------------
+				
+* Zugriff von 'aussen'
+
+  Mit php und curl lässt sich eine reverse-Proxy nachahmen. Ein Beispiel findet sich unter: {{{./ics.php.txt}ics.php.txt}}.
\ No newline at end of file
diff --git a/src/site/xdoc/devel-install.xml b/src/site/xdoc/devel-install.xml
deleted file mode 100644
index b8795b1..0000000
--- a/src/site/xdoc/devel-install.xml
+++ /dev/null
@@ -1,213 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
-	<properties>
-		<title>Installation Guide</title>
-		<author>Yves Fischer</author>
-		<date>24.02.2011</date>
-	</properties>
-
-	<body>
-		<section name="Installation Guide">
-			<subsection name="Mit Embedded Servlet Container">
-				<source>mvn jetty:run</source>
-				<p>Standardmäßig lauscht jetty nun auf Port 8080</p>
-			</subsection>
-			<subsection name="Mit .war File">
-				<p>
-					Ein Web-Archive (.war) kann mit dem Maven Kommando
-					<tt>mvn package</tt>
-					erzeugt werden.
-				</p>
-			</subsection>
-		</section>
-		<section name="Installation unter SLES 11.1">
-			<p>
-				Es muss ein halbwegs aktuelles Java-JDK installiert sein, dieses
-				kann von
-				<a href="http://java.sun.com">java.sun.com</a>
-				für Linux/i386 heruntergeladen werden.
-			</p>
-			<p>
-				Für die Ausführung von dhbwcalender wird ein neuer Benutzer
-				mit Namen
-				<tt>dhbwcalendar</tt>
-				angelegt.
-			</p>
-			<p>
-				maven2 wird von
-				<a href="http://maven.apache.org">maven.apache.org</a>
-				installiert in
-				<tt>/home/dhbwcalendar/share/apache-maven-2.2.1/</tt>
-			</p>
-			<p>
-				Für den Benutzer dhbwcalendar wird in seiner
-				<tt>.profile</tt>
-				Datei die Umgebungsvariablen
-				<tt>JAVA_HOME</tt>
-				,
-				<tt>M2_HOME</tt>
-				(maven) entsprechend gesetzt
-			</p>
-			<p>
-				git wird mit zypper installiert:
-				<source># zypper ar \
-					"http://download.opensuse.org/repositories/devel:/tools:/scm/SLE_11/devel:tools:scm.repo"
-					# zypper install git
-					# su -l dhbwcalendar
-					$ git clone ....</source>
-			</p>
-			<p>
-				Da im produktiven Setup jetty nicht von "aussen" erreichbar sein
-				soll wird jetty konfiguriert nur auf
-				<i>localhost</i>
-				zu horchen.
-				<source>
-					&lt;connectors&gt;
-					&lt;connector
-					implementation=&quot;org.mortbay.jetty.nio.SelectChannelConnector&quot;&gt;
-					&lt;port&gt;8080&lt;/port&gt;
-					&lt;host&gt;127.0.0.1&lt;/host&gt;
-					&lt;/connector&gt;
-					&lt;/connectors&gt;</source>
-			</p>
-			<p>
-				Bei vaadin wird der
-				<i>productionMode</i>
-				aktiviert
-				<tt>src/main/webapp/WEB-INF/web.xml:</tt>
-				<source>
-					&lt;context-param&gt;
-					&lt;param-name&gt;productionMode&lt;/param-name&gt;
-					&lt;param-value&gt;true&lt;/param-value&gt;
-					&lt;description&gt;Vaadin production mode&lt;/description&gt;
-					&lt;/context-param&gt;</source>
-			</p>
-			<p>
-				<tt>mvn jetty:run</tt>
-				startet Jetty über Maven als embedded Servlet Container.
-			</p>
-			<subsection name="SSL">
-				<p>Zertifikat erstellen:</p>
-				<source>
-					% keytool -keystore keystore -alias jetty -genkey -keyalg
-					RSA
-					Geben
-					Sie das
-					Keystore-Passwort ein:
-					Geben Sie das Passwort erneut
-					ein:
-					Wie
-					lautet
-					Ihr Vor- und Nachname?
-					[Unknown]: dualical.ba-horb.de
-					(ACHTUNG
-					Common-Name = Hostname!)
-					Wie lautet der Name
-					Ihrer
-					organisatorischen
-					Einheit?
-					[Unknown]: DHBW Stuttgart Campus
-					Horb
-					Wie
-					lautet der Name
-					Ihrer Organisation?
-					[Unknown]: Duale
-					Hochschule
-					Baden-Württemberg
-					Wie lautet der Name Ihrer Stadt oder Gemeinde?
-					[Unknown]: Horb
-					Wie
-					lautet der Name Ihres Bundeslandes oder Ihrer
-					Provinz?
-					[Unknown]:
-					Baden-Württemberg
-					Wie lautet der Landescode (zwei
-					Buchstaben) für
-					diese Einheit?
-					[Unknown]: DE
-					Ist CN=DHBW Calendar,
-					OU=DHBW Stuttgart
-					Campus Horb, O=Duale
-					Hochschule Baden-Württemberg,
-					L=Horb, ST=Baden-Württemberg,
-					C=DE
-					richtig?
-					[Nein]: Ja
-
-					Geben Sie das
-					Passwort für
-					&lt;jetty&gt; ein.
-					(EINGABETASTE, wenn Passwort dasselbe
-					wie für
-					Keystore):
-				</source>
-				<p>SSL für Jetty konfigurieren:</p>
-				<source>
-					&lt;configuration&gt;
-					&lt;connectors&gt;
-					&lt;connector
-					implementation=&quot;org.mortbay.jetty.nio.SelectChannelConnector&quot;&gt;
-					&lt;port&gt;8080&lt;/port&gt;
-					&lt;/connector&gt;
-					&lt;connector
-					implementation=&quot;org.mortbay.jetty.ssl.SslSelectChannelConnector&quot;&gt;
-					&lt;port&gt;8443&lt;/port&gt;
-					&lt;keystore&gt;${basedir}/server.keystore&lt;/keystore&gt;
-					&lt;keyPassword&gt;bla&lt;/keyPassword&gt;
-					&lt;password&gt;bla&lt;/password&gt;
-					&lt;/connector&gt;
-					&lt;/connectors&gt;
-					&lt;/configuration&gt;
-					&lt;dependencies&gt;
-					&lt;dependency&gt;
-					&lt;groupId&gt;org.mortbay.jetty&lt;/groupId&gt;
-					&lt;artifactId&gt;jetty-ssl&lt;/artifactId&gt;
-					&lt;version&gt;7.0.0.pre5&lt;/version&gt;
-					&lt;/dependency&gt;
-					&lt;/dependencies&gt; </source>
-				<p>Fingerprint von Zertifikat:</p>
-				<source>
-					% keytool -list -keystore server.keystore -rfc
-					Geben Sie das
-					Keystore-Passwort ein:
-
-					Keystore-Typ: JKS
-					Keystore-Provider: SUN
-
-					Ihr
-					Keystore enthält
-					1 Eintrag/-äge.
-
-					jetty, 29.03.2011, PrivateKeyEntry,
-					Zertifikatsfingerabdruck (MD5):
-					B6:CA:AF:1C:8C:B7:38:38:36:2A:30:3C:A5:C2:54:20
-
-					-----BEGIN
-					CERTIFICATE-----
-					....
-					-----END CERTIFICATE-----
-				</source>
-				<p>Die Verbindung kann jetzt mit wget überprüft werden</p>
-				<source>
-					wget --ca-certificate=certificate.pem
-					https://dualical.ba-horb.de:8443/dhbwcalendar/
-				</source>
-				<p>Weitere Informationen zum Zertifikat zeigt OpenSSL in Klartext
-					an:</p>
-				<source>
-					openssl x509 -noout -text -in certificate.pem
-				</source>
-			</subsection>
-			<subsection name="Zugriff von 'aussen'">
-				<p>
-					Mittels php und curl lässt sich eine reverse-Proxy nachahmen. Ein
-					Beispiel findet sich unter:
-					<a href="ics.php.txt">ics.php.txt</a>
-					.
-				</p>
-			</subsection>
-		</section>
-	</body>
-</document>
-
-- 
cgit v1.2.1