[gatein-commits] gatein SVN: r5331 - epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US.

Author: smumford Date: 2010-11-29 01:30:05 -0500 (Mon, 29 Nov 2010) New Revision: 5331 Added: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/GadgetProxyConfig.xml Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Configuration.xml epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Revision_History.xml Log: JBEPP-673: Added Gadget Proxy Configuration section Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Configuration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Configuration.xml 2010-11-29 05:56:27 UTC (rev 5330) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Configuration.xml 2010-11-29 06:30:05 UTC (rev 5331) @@ -10,6 +10,6 @@ <xi:include href="EMailServiceConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="ClusteringConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="HTTPSConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - + <xi:include href="GadgetProxyConfig.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </chapter> Added: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/GadgetProxyConfig.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/GadgetProxyConfig.xml (rev 0) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/GadgetProxyConfig.xml 2010-11-29 06:30:05 UTC (rev 5331) @@ -0,0 +1,82 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> + +<section> + <title>Gadget Proxy Configuration</title> + <section> + <title>Overview</title> + <para> + Gadget consumption requires a local anonymous proxy to route access to elements used by the gadgets. + </para> + <para> + This must be done to work around web-browser security mechanisms. + </para> + </section> + + <section> + <title>Setup the Filter</title> + <para> + The anonymous proxy can be setup to accept or refuse certain hosts. + </para> + <para> + By default, the proxy is closed to any host except the domain on which the gadget server is installed. + </para> + <para> + To modify the filtering of domain names, modify: <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/common-configuration.xml</filename> + </para> +<example> +<title>common-configuration.xml</title> +<programlisting language="XML" role="XML"><![CDATA[<component> + <key>org.exoplatform.web.security.proxy.ProxyFilterService</key> + <type>org.exoplatform.web.security.proxy.ProxyFilterService</type> + <init-params> + <values-param> + <!-- The white list --> + <name>white-list</name> + <value></value> + </values-param> + <values-param> + <name>black-list</name> + <value></value> + </values-param> + </init-params> + </component> ]]> +</programlisting> +</example> + <para> + The proxy will deny access to a resource that is on the blacklist. If the domain name does not match any of the blacklist, the proxy filter will verify if the domain name is on the white list. + </para> + <para> + If the domain name is not defined in either the white list or black list, access will be denied. + </para> + <para> + Multiple values can be added for each list and wildcards can also be used. + </para> + <para> + Below is an example of a valid configuration: + </para> +<example> +<title>Valid Proxy Configuration</title> +<programlisting language="XML" role="XML"><![CDATA[<component> + <key>org.exoplatform.web.security.proxy.ProxyFilterService</key> + <type>org.exoplatform.web.security.proxy.ProxyFilterService</type> + <init-params> + <values-param> + <!-- The white list --> + <name>white-list</name> + <value>*.example.com</value> + <value>www.example.net&lt;/value> + </values-param> + <values-param> + <name>black-list</name> + <value>evil.example.com</value> + </values-param> + </init-params> + </component> ]]> +</programlisting> +</example> + </section> +</section> \ No newline at end of file Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Revision_History.xml 2010-11-29 05:56:27 UTC (rev 5330) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Revision_History.xml 2010-11-29 06:30:05 UTC (rev 5331) @@ -8,6 +8,20 @@ <title>Revision History</title> <simpara> <revhistory> + <revision> + <revnumber>1-2.2</revnumber> + <date></date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email&gt;smumford(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Added "Gadget Proxy Configuration" section</member> + </simplelist> + </revdescription> + </revision> <revision> <revnumber>1-2.1</revnumber> <date>Mon Nov 22 2010</date>