source: ComponentRegistry/branches/ComponentRegistry-2.0/UPDATE @ 6899

Last change on this file since 6899 was 6899, checked in by Twan Goosen, 9 years ago

Instructions for base url configuration

File size: 5.7 KB
Line 
1UPDATING THE COMPONENT REGISTRY REST SERVICE AND FLEX UI
2
3Procedure for updating
4----------------------
5
6- When upgrading to a new version of the ComponentRegistry, check if there are
7  updates to the schema of the PostgreSQL database. These will be named
8  upgrade-x.yy.sql, e.g. upgrade-1.10.sql for version 1.10.
9
10- If the database needs upgrading, first make a backup (dump) of the existing
11  database. Stop the application before doing so
12
13- Execute the upgrade script. When upgrading over multiple minor versions,
14  execute the upgrade scripts incrementally
15
16- Make sure to grant all required rights (GRANT ALL unless specified
17  otherwise) to the component registry database user (usually compreg) on
18  any newly added tables, views, and sequences.
19
20- Then redeploy the WAR and start the application
21
22Version specific update instructions
23-------------------------------------
24
25=== 2.0 ===
26
27- The application's public base URL is configured differently as of this
28  release.
29
30  The following context parameter is NO LONGER USED:
31
32    eu.clarin.cmdi.componentregistry.serviceRootUrl <- DEPRECATED
33
34  Instead, configure the parameter:
35
36    eu.clarin.cmdi.componentregistry.serviceUrlPath
37        e.g. "/ds/ComponentRegistry" (or "" for root deployment)
38  and
39
40    EITHER
41        eu.clarin.cmdi.componentregistry.serviceUrlBase
42            e.g. "http://catalog.clarin.eu"
43    OR (if the application is running behind a proxy)
44            eu.clarin.cmdi.componentregistry.serviceUrlProtocolHeader
45                    e.g. (usually) "X-FORWARDED-PROTO"
46                AND
47            eu.clarin.cmdi.componentregistry.serviceUrlHostHeader
48                    e.g. (usually) "X-FORWARDED-HOST"
49
50  See the bundled context.xml for details and examples.
51
52- The scheme for bookmark URLs of the front end have changed. Add a rewrite rule
53  that causes a redirect from
54 
55    http://server/ComponentRegistry?param1=x&param2=y
56                                   ^
57  to
58 
59    http://server/ComponentRegistry#/?param1=x&param2=y
60                                   ^^^
61  (Difference marked)
62
63- Since the JS front end (like the previous Flash based front end) is quite heavy
64  on the loading of compressible content, consider enabling content compression
65  on the Tomcat server to improve performance, especially on clients with slow
66  connections. In particular the loading of content of types 'application/json'
67  and 'application/javascript' benefits from this.
68 
69  E.g., use the following in the Tomcat's server.xml:
70
71    <Connector port="8080" protocol="HTTP/1.1"
72               connectionTimeout="20000"
73               redirectPort="8443"
74               compression="on"
75               compressableMimeType="text/html,text/xml,text/plain,text/javascript,text/css,application/json,application/javascript"
76               />
77
78  More information can be found at the following page:
79        <https://tomcat.apache.org/tomcat-7.0-doc/config/http.html>
80
81=== 1.15.0 ===
82
83- Remove the context parameter eu.clarin.cmdi.componentregistry.jpaDialect from the global
84  context.xml or application context fragment, as it is now provided within the web.xml
85  of the application itself.
86 
87=== 1.14.5 ===
88
89The context parameter eu.clarin.cmdi.componentregistry.isocatRestUrl has been replaced
90with the new parameter eu.clarin.cmdi.componentregistry.ccrRestUrl. An example
91configuration with the default value for the new parameter is:
92
93
94  <Parameter
95                name="eu.clarin.cmdi.componentregistry.ccrRestUrl"
96                value="https://openskos.meertens.knaw.nl/ccr/api/"/>
97
98=== 1.14.2 ===
99
100No additional steps required.
101
102=== 1.14.1 ===
103
104No additional steps required.
105
106=== 1.14.0 ===
107
108- Execute DB update script upgrade-1.14.sql
109
110- Add the following context parameter (default values given):
111
112  <Parameter
113          name="eu.clarin.cmdi.componentregistry.jpaDialect"
114          value="org.hibernate.dialect.PostgreSQLDialect"/>
115         
116- ComponentRegistry no longer provides its own JDBC driver jar. In case the Tomcat
117  container does NOT provide a suitable PostgreSQL JDBC driver yet:
118
119    - Download a suitable version and deploy it as a provided library in the Tomcat
120
121
122=== 1.13 ===
123
124- The following context fragment have been renamed, and should be updated
125  in the context fragment for the Component Registry:
126 
127  componentRegistryServiceRootUrl -> eu.clarin.cmdi.componentregistry.serviceRootUrl
128  componentRegistryAdminUsers -> eu.clarin.cmdi.componentregistry.adminUsers
129 
130  The results should look something like:
131  <Parameter
132                name="eu.clarin.cmdi.componentregistry.serviceRootUrl"
133                value="http://catalog.clarin.eu/ds/ComponentRegistry" />
134  <Parameter
135                name="eu.clarin.cmdi.componentregistry.adminUsers"
136                value="admin1@clarin.eu admin2@clarin.eu" />
137
138- The following should be added to the context fragment for the Component
139  Registry:
140
141        <Parameter
142                        name="eu.clarin.cmdi.componentregistry.documentationUrl"
143                        value="http://www.clarin.eu/cmdi" />
144        <Parameter
145                        name="eu.clarin.cmdi.componentregistry.generalComponentSchemaUrl"
146                        value="https://infra.clarin.eu/cmd/general-component-schema.xsd" />
147        <Parameter
148                        name="eu.clarin.cmdi.componentregistry.component2SchemaXslUrl"
149                        value="https://infra.clarin.eu/cmd/xslt/comp2schema-v2/comp2schema.xsl" />
150        <Parameter
151                        name="eu.clarin.cmdi.componentregistry.componentSpecSchemaLocation"
152                        value="http://www.clarin.eu/cmd https://infra.clarin.eu/cmd/general-component-schema.xsd" />
153        <Parameter
154                        name="eu.clarin.cmdi.componentregistry.isocatRestUrl"
155                        value="https://catalog.clarin.eu/isocat/rest/" />
156                       
157=== 1.11 ==
158
159- The following should be added to the context fragment for the Component
160  Registry:
161    <Parameter
162        name="componentRegistryAdminUsers"
163        value="space-separated-list-of-admin-eppns"/>
164
165- Added to database schema:
166        * comments
167        * comments_id_seq
Note: See TracBrowser for help on using the repository browser.