source: main/trunk/greenstone3/resources/web/servlets.xml.svn

Last change on this file was 38896, checked in by kjdon, 4 weeks ago

added a comment about cookie_path
File size: 11.4 KB
Line 
1<servlet>
2 <!-- !!!! -->
3 <!-- This file was automatically generated from $GSDL3SRCHOME/resources/web/servlet.xml.in -->
4 <!-- !!!! -->
5
6 <servlet-name>library</servlet-name>
7 <description>The standard gsdl3 library program</description>
8 <servlet-class>org.greenstone.gsdl3.LibraryServlet</servlet-class>
9 <!-- this is the servlet url path - needs to match what you have specified in servlet-mapping below -->
10 <init-param>
11 <param-name>library_name</param-name>
12 <param-value>library</param-value>
13 </init-param>
14
15 <!--
16 Production versions of Greenstone will typically need to set 'init-param' valus below if
17 the DL operates through a Reverse Proxy server, such as Apache2, which publically presents
18 externally over 'https' but internally routes things through to an http running instance
19 of tomcat providing Greenstone3.
20
21 For example, to have a Greenstone3 appear as:
22 https://mydomain.org/my-greenstone3/library
23
24 In your Apache2 configuration file include:
25
26 ProxyPass /my-greenstone3 http://localhost:8383/greenstone3
27 ProxyPassReverse /my-greenstone3 http://localhost:8383/greenstone3
28 <Location /my-greenstone3>
29 ProxyPassReverseCookiePath /greenstone3 /my-greenstone3
30 </Location>
31
32 The <Location> tags future proof things for the case where you run more than one
33 Greenstone3 on the same server. This can just be the ProxyPassReverseCookiePath
34 entry, if there is only one GS3 server running.
35
36 In the params below we break things down into constituent parts to make some of the
37 XSL template rules easier to write.
38 -->
39
40 <!--
41 Leave the following commented out if you are using http://localhost:8383/greenstone3/
42 as this is construted automatically from build.properties for use as the HTML <base> tag
43 -->
44 <!-- **** TODO: consider changing this to be built up from servlet_domain, servlet_opt_port, servlet_context / -->
45 <!--
46 <init-param>
47 <param-name>servlet_url_prefix</param-name>
48 <param-value>//mydomain.org//my-greenstone3/</param-value>
49 </init-param>
50 -->
51
52 <init-param>
53 <param-name>site_name</param-name>
54 <param-value>localsite</param-value>
55 </init-param>
56 <init-param>
57 <param-name>interface_name</param-name>
58 <param-value>default</param-value>
59 </init-param>
60 <init-param>
61 <param-name>receptionist_class</param-name>
62 <param-value>DefaultReceptionist</param-value>
63 </init-param>
64 <init-param>
65 <param-name>default_lang</param-name>
66 <param-value>en</param-value>
67 </init-param>
68 <init-param>
69 <!-- Does this servlet provide a favourites option? true/false-->
70 <param-name>favouritebasket</param-name>
71 <param-value>true</param-value>
72 </init-param>
73 <init-param>
74 <!-- Does this servlet provide a documentbasket option? true/false.
75Note, this currently doesn't work properly -->
76 <param-name>documentbasket</param-name>
77 <param-value>false</param-value>
78 </init-param>
79
80 <!--
81 The cookie consent manager is a component of the default interface that alerts the end user
82 to Greenstone's cookie usage. It also allows them to consent to non-essential cookies.
83 It can be customised by editing the 'cookieconsent-init.js' file in the default interface's 'js' folder.
84 To disable the manager for all interfaces that support it, remove or comment out this entire parameter.
85 -->
86 <init-param>
87 <param-name>cookie_consent</param-name>
88 <param-value>comment_this_entire_param_to_disable</param-value>
89 </init-param>
90 <!-- if you want to use a non standard greenstone cookie path (by default it will use greenstone.context in build.properties), then set the value of it here. If you are mapping to an address without this part (eg my-site.org/library) then cookie path will be / -->
91 <!-- Note, cookie_path must start with / -->
92 <!--
93 <init-param>
94 <param-name>cookie_path</param-name>
95 <param-value>/greenstone3</param-value>
96 </init-param>
97 -->
98
99 <!-- ***** -->
100 <!-- Google related keys and id credentials -->
101 <!-- ***** -->
102
103 <!--
104 <init-param>
105 <param-name>google_tracking_id</param-name>
106 <param-value>UA-?????.....?????</param-value>
107 </init-param>
108 -->
109
110 <!-- For Google Authenticated Signin, need to specify the client-id (*not* the secret one) -->
111 <!-- More details at: https://developers.google.com/identity/sign-in/web/sign-in -->
112 <!--
113 <init-param>
114 <param-name>googlesignin_client_id</param-name>
115 <param-value>@googlesigninclientid@</param-value>
116 </init-param>
117 -->
118
119 <!-- For details on how to set up a Google API key to use with Google Maps, see:
120 https://developers.google.com/maps/documentation/javascript/get-api-key
121 -->
122 <!-- TLDR:
123 1. On the Credentials page, create an API key (copy the displayed value)
124 2. Then restrict it to your website
125 3. Further restrict calls to just Google Maps API
126 4. Give the key a name you will remember
127 5. Press Save
128 6. Paste the key into the <param-value> below
129 -->
130 <!--
131 <init-param>
132 <param-name>googlemaps_api_key</param-name>
133 <param-value>?????.....?????</param-value>
134 </init-param>
135 -->
136</servlet>
137
138<!-- the /* in the url-pattern below is necessary for the restful URLs to work.
139 e.g. greenstone3/library/collection/lucene-jdbm-demo/page/about
140-->
141<servlet-mapping>
142 <servlet-name>library</servlet-name>
143 <url-pattern>/library/*</url-pattern>
144</servlet-mapping>
145
146<!-- the oai servlet. You can add multiple oai servlets by copying
147 the description and changing site_name and servlet_url params.
148 Remember to add the mapping here and the corresponding servlet_url
149 into build.properties -->
150<servlet>
151 <servlet-name>oaiserver</servlet-name>
152 <description>the default oai servlet</description>
153 <servlet-class>org.greenstone.gsdl3.OAIServer</servlet-class>
154 <init-param>
155 <param-name>default_lang</param-name>
156 <param-value>en</param-value>
157 </init-param>
158 <init-param>
159 <param-name>site_name</param-name>
160 <param-value>localsite</param-value>
161 </init-param>
162 <!-- this needs to correspond to the value in the url-pattern
163 part of the mapping, below.-->
164 <init-param>
165 <param-name>servlet_url</param-name>
166 <param-value>oaiserver</param-value>
167 </init-param>
168</servlet>
169
170<servlet-mapping>
171 <servlet-name>oaiserver</servlet-name>
172 <url-pattern>/oaiserver/*</url-pattern>
173</servlet-mapping>
174
175<servlet>
176 <servlet-name>halftone-library</servlet-name>
177 <description>A library servlet using the standard content, but with the halftone interface.</description>
178 <servlet-class>org.greenstone.gsdl3.LibraryServlet</servlet-class>
179 <init-param>
180 <param-name>library_name</param-name>
181 <param-value>halftone-library</param-value>
182 </init-param>
183 <init-param>
184 <param-name>site_name</param-name>
185 <param-value>localsite</param-value>
186 </init-param>
187 <init-param>
188 <param-name>interface_name</param-name>
189 <param-value>halftone</param-value>
190 </init-param>
191 <init-param>
192 <param-name>receptionist_class</param-name>
193 <param-value>DefaultReceptionist</param-value>
194 </init-param>
195 <init-param>
196 <param-name>default_lang</param-name>
197 <param-value>en</param-value>
198 </init-param>
199
200 <!-- For Google Analytics -->
201 <!--
202 <init-param>
203 <param-name>google_tracking_id</param-name>
204 <param-value>UA-?????.....?????</param-value>
205 </init-param>
206 -->
207
208 <!-- For Google Authenticated Signin, need to specify the client-id (*not* the secret one) -->
209 <!--
210 <init-param>
211 <param-name>googlesignin_client_id</param-name>
212 <param-value>?????.....?????.apps.googleusercontent.com</param-value>
213 </init-param>
214 -->
215</servlet>
216
217<servlet-mapping>
218 <servlet-name>halftone-library</servlet-name>
219 <url-pattern>/halftone-library/*</url-pattern>
220</servlet-mapping>
221
222<!--<servlet>
223 <servlet-name>gs2-library</servlet-name>
224 <description>Greenstone 2 lookalike library program: uses localsite with the gs2 interface</description>
225 <servlet-class>org.greenstone.gsdl3.LibraryServlet</servlet-class>
226 <init-param>
227 <param-name>library_name</param-name>
228 <param-value>gs2-library</param-value>
229 </init-param>
230 <init-param>
231 <param-name>site_name</param-name>
232 <param-value>localsite</param-value>
233 </init-param>
234 <init-param>
235 <param-name>interface_name</param-name>
236 <param-value>gs2</param-value>
237 </init-param>
238 <init-param>
239 <param-name>default_lang</param-name>
240 <param-value>en</param-value>
241 </init-param>
242 <init-param>
243 <param-name>session_expiration</param-name>
244 <param-value>1800</param-value>
245 </init-param>
246 <init-param>
247 <param-name>params_class</param-name>
248 <param-value>GS2Params</param-value>
249 </init-param>
250</servlet>
251
252<servlet-mapping>
253 <servlet-name>gs2-library</servlet-name>
254 <url-pattern>/gs2-library/*</url-pattern>
255</servlet-mapping>
256-->
257
258<!--<servlet>
259 <servlet-name>nzdl-library</servlet-name>
260 <description>gsdl3 library program</description>
261 <servlet-class>org.greenstone.gsdl3.LibraryServlet</servlet-class>
262 <init-param>
263 <param-name>library_name</param-name>
264 <param-value>nzdl</param-value>
265 </init-param>
266 <init-param>
267 <param-name>site_name</param-name>
268 <param-value>nzdl</param-value>
269 </init-param>
270 <init-param>
271 <param-name>interface_name</param-name>
272 <param-value>nzdl</param-value>
273 </init-param>
274 <init-param>
275 <param-name>default_lang</param-name>
276 <param-value>en</param-value>
277 </init-param>
278 <init-param>
279 <param-name>params_class</param-name>
280 <param-value>NZDLParams</param-value>
281 </init-param>
282 <init-param>
283 <param-name>session_expiration</param-name>
284 <param-value>600</param-value>
285 </init-param>
286</servlet>
287
288<servlet-mapping>
289 <servlet-name>nzdl-library</servlet-name>
290 <url-pattern>/nzdl/*</url-pattern>
291</servlet-mapping>
292
293-->
294
295<!--<servlet>
296 <servlet-name>gateway</servlet-name>
297 <description>gsdl3 library based on gateway site and basic interface. It uses SOAP to talk to localsite</description>
298 <servlet-class>org.greenstone.gsdl3.LibraryServlet</servlet-class>
299 <init-param>
300 <param-name>library_name</param-name>
301 <param-value>gateway</param-value>
302 </init-param>
303 <init-param>
304 <param-name>site_name</param-name>
305 <param-value>gateway</param-value>
306 </init-param>
307 <init-param>
308 <param-name>interface_name</param-name>
309 <param-value>basic</param-value>
310 </init-param>
311 <init-param>
312 <param-name>default_lang</param-name>
313 <param-value>en</param-value>
314 </init-param>
315</servlet>
316
317<servlet-mapping>
318 <servlet-name>gateway</servlet-name>
319 <url-pattern>/gateway/*</url-pattern>
320</servlet-mapping>
321-->
322
323<!--<servlet>
324 <servlet-name>basic-library</servlet-name>
325 <description>basic gsdl3 library program: uses localsite and the basic interface</description>
326 <servlet-class>org.greenstone.gsdl3.LibraryServlet</servlet-class>
327 <init-param>
328 <param-name>library_name</param-name>
329 <param-value>basic-library</param-value>
330 </init-param>
331 <init-param>
332 <param-name>site_name</param-name>
333 <param-value>localsite</param-value>
334 </init-param>
335 <init-param>
336 <param-name>interface_name</param-name>
337 <param-value>basic</param-value>
338 </init-param>
339 <init-param>
340 <param-name>default_lang</param-name>
341 <param-value>en</param-value>
342 </init-param>
343 <init-param>
344 <param-name>allow_client_side_xslt</param-name>
345 <param-value>true</param-value>
346 </init-param>
347</servlet>
348
349<servlet-mapping>
350 <servlet-name>basic-library</servlet-name>
351 <url-pattern>/basic-library/*</url-pattern>
352</servlet-mapping>
353-->
Note: See TracBrowser for help on using the repository browser.