Author: thomas.heute(a)jboss.com
Date: 2010-11-11 05:56:29 -0500 (Thu, 11 Nov 2010)
New Revision: 5038
Added:
portal/trunk/docs/reference-guide/en/modules/Configuration/HTTPSConfiguration.xml
Modified:
portal/trunk/docs/reference-guide/en/modules/Configuration.xml
Log:
GTNPORTAL-1535: Remote gadgets don't work under https mode
Added: portal/trunk/docs/reference-guide/en/modules/Configuration/HTTPSConfiguration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/Configuration/HTTPSConfiguration.xml
(rev 0)
+++
portal/trunk/docs/reference-guide/en/modules/Configuration/HTTPSConfiguration.xml 2010-11-11
10:56:29 UTC (rev 5038)
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="sect-Reference_Guide-HTTPS_Configuration">
+ <title>HTTPS Configuration</title>
+
+ <section id="sect-Reference_Guide-HTTPS_Configuration-Overview">
+ <title>Overview</title>
+
+ <para>&PRODUCT; default run on HTTP mode. However, for security purpose,
you can config GateIn to run on HTTPS mode. This section show you how to config GateIn
with HTTPS mode.</para>
+
+ </section>
+ <section id="sect-Reference_Guide-HTTPS_Configuration-Generate_Key">
+ <title>Generate your key</title>
+
+ <para>If you haven't your own X.509 certificate, you can make a simple
certificate using keytool command:
+ <programlisting>keytool -genkey -alias serverkeys -keyalg RSA -keystore
server.keystore -storepass 123456 -keypass 123456 -dname "CN=localhost, OU=MYOU,
O=MYORG, L=MYCITY, ST=MYSTATE, C=MY"</programlisting></para>
+
+ <para>Now, your key is stored in server.keystore</para>
+
+ <para>You need to import your key into the Sun JDK keystore (This is required
to help running gadget features)
+ <programlisting>keytool -importkeystore -srckeystore server.keystore
-destkeystore $JAVA_HOME/jre/lib/security/cacerts</programlisting></para>
+ </section>
+ <section id="sect-Reference_Guide-HTTPS_Configuration-Use_In_Jboss">
+ <title>Setup Jboss configuration to use your key</title>
+ <para>Edit server.xml from
jboss/server/<NAME>/deploy/jbossweb.sar folder.
+ Comment lines:
+ <programlisting><Connector protocol="HTTP/1.1"
port="8080" address="${jboss.bind.address}"
+ connectionTimeout="20000" redirectPort="8443"
/></programlisting>
+ Uncomment lines and change keystoreFile and keystorePass to values of your key:
+ <programlisting><Connector protocol="HTTP/1.1"
SSLEnabled="true"
+ port="8443" address="${jboss.bind.address}"
+ scheme="https" secure="true" clientAuth="false"
+ keystoreFile="$JAVA_HOME/jre/lib/security/cacerts"
+ keystorePass="123456" sslProtocol = "TLS"
/></programlisting>
+ </para>
+ </section>
+ <section id="sect-Reference_Guide-HTTPS_Configuration-Use_In_Tomcat">
+ <title>Setup Tomcat configuration to use your key</title>
+
+ <para>Edit server.xml from tomcat/conf folder. Comment lines:
+ <programlisting><Connector port="8080"
protocol="HTTP/1.1"
+ maxThreads="150" connectionTimeout="20000"
+ redirectPort="8443" URIEncoding="UTF-8"
+ emptySessionPath="true"/></programlisting>
+ Uncomment lines and add keystoreFile and keystorePass values:
+ <programlisting><Connector port="8443"
protocol="HTTP/1.1" SSLEnabled="true"
+ maxThreads="150" scheme="https" secure="true"
+ clientAuth="false" sslProtocol="TLS"
+ keystoreFile="$JAVA_HOME/jre/lib/security/cacerts"
+ keystorePass="123456" /></programlisting>
+ </para>
+
+ <para>Restart GateIn. If your configuration is correct, you can access to GateIn
via address:
<literal>https://<ServerAddress>:8443/portal</literal></para>
+ </section>
+</section>
Modified: portal/trunk/docs/reference-guide/en/modules/Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/Configuration.xml 2010-11-11 08:15:43 UTC
(rev 5037)
+++ portal/trunk/docs/reference-guide/en/modules/Configuration.xml 2010-11-11 10:56:29 UTC
(rev 5038)
@@ -7,4 +7,5 @@
<title>Configuration</title>
<xi:include href="Configuration/DatabaseConfiguration.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Configuration/EMailServiceConfiguration.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
\ No newline at end of file
+ <xi:include href="Configuration/HTTPSConfiguration.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>