Changeset 37609 for main/trunk/greenstone3/web/WEB-INF

Timestamp:

2023-04-05T21:30:30+12:00 (14 months ago)

Author:

davidb

Message:

Some extra comments woven in

File:

• main/trunk/greenstone3/web/WEB-INF/servlets.xml (modified) (2 diffs)

main/trunk/greenstone3/web/WEB-INF/servlets.xml

@@ -8 +8 @@
         <param-value>library</param-value>
     </init-param>
-        
-        <!-- If you are using a non-custom url, eg www.greenstone.org/greenstone3/library, add it here 
-             It should start with // (not http) and end with / 
-             It's everything not including the servlet name specified above -->
-        <!--
+
+    <!-- 
+         Production versions of Greenstone will typically need to set 'init-param' valus below if
+         the DL operates through a Reverse Proxy server, such as Apache2, which publically presents 
+         externally over 'https' but internally routes things through to an http running instance
+         of tomcat providing Greenstone3.
+
+         For example, to have a Greenstone3 appear as:
+             https://mydomain.org/my-greenstone3/library
+
+         In your Apache2 configuration file include:
+
+                 ProxyPass        /my-greenstone3 http://localhost:8383/greenstone3
+         ProxyPassReverse /my-greenstone3 http://localhost:8383/greenstone3
+         <Location /my-greenstone3>
+             ProxyPassReverseCookiePath /greenstone3 /my-greenstone3
+         </Location>
+
+             The <Location> tags future proof things for the case where you run more than one 
+         Greenstone3 on the same server.  This can just be the ProxyPassReverseCookiePath
+         entry, if there is only one GS3 server running.
+
+         In the params below we break things down into constituent parts to make some of the 
+         XSL template rules easier to write.
+    -->
+
+    <!-- 
+         Leave the following commented out if you are using http://localhost:8383/greenstone3/ 
+         as this is construted automatically from build.properties for use as the HTML <base> tag
+    -->
+    <!-- **** TODO: consider changing this to be built up from servlet_domain, servlet_opt_port, servlet_context / -->
         <init-param>
           <param-name>servlet_url_prefix</param-name>
-          <param-value>//www.greenstone.org/greenstone3/</param-value>
-    </init-param>
-        -->
+          <param-value>//mydomain.org//my-greenstone3/</param-value>
+    </init-param>
+    
     <init-param>
         <param-name>site_name</param-name>
@@ -75 +101 @@
     -->
     
-    <!-- For Google Authenticated Signin, need to specify the client-id (*not* the secret one)
+    <!-- For Google Authenticated Signin, need to specify the client-id (*not* the secret one) -->
+    <!-- More details at: https://developers.google.com/identity/sign-in/web/sign-in -->
     <init-param>
           <param-name>googlesignin_client_id</param-name>