source: main/trunk/greenstone3/web/WEB-INF/servlets.xml@ 37623

Last change on this file since 37623 was 37623, checked in by davidb, 6 months ago

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