1 | |
---|
2 | 0. What the VLO is about |
---|
3 | |
---|
4 | The VLO application allows faceted browsing of meta data. Before |
---|
5 | being able to browse the data by using the VLO web application, it |
---|
6 | needs to be deployed and the VLO importer should be used to add |
---|
7 | the meta data to the database. |
---|
8 | |
---|
9 | 1. The archive |
---|
10 | |
---|
11 | The VLO importer and web application are contained in an |
---|
12 | archive. In the case of version 2.13, the archive is named |
---|
13 | |
---|
14 | vlo_parent-2.13-Distribution.tar.gz |
---|
15 | |
---|
16 | Deploying the VLO application means: |
---|
17 | - unpacking the archive in a suitable location |
---|
18 | - unpacking the war files contained in the archive |
---|
19 | - adapt the application's context files |
---|
20 | and |
---|
21 | - adapt the main configuration file. |
---|
22 | |
---|
23 | 2. Archive unpacking |
---|
24 | |
---|
25 | Unpack the archive in directory x, |
---|
26 | for example: /var/lib/tomcat6/webapps/vlodist/ |
---|
27 | cd x |
---|
28 | With tar -xvf vlo_parent-2.13-Distribution.tar.gz |
---|
29 | vlo_parent-2.13 will be created in the x directory. |
---|
30 | |
---|
31 | To begin with, make the server's Tomcat user own the files unpacked. |
---|
32 | |
---|
33 | 3. Solr server installation |
---|
34 | |
---|
35 | The VLO importer and web application use Solr as their database |
---|
36 | server. |
---|
37 | |
---|
38 | Unpack x/vlo_parent-2.13/war/solr.war in a directory named y in which you |
---|
39 | want the Solr server to reside. This could, for example be: |
---|
40 | |
---|
41 | /var/lib/tomcat6/webapps/vlodist/vlo_parent-2.13/war/solr |
---|
42 | |
---|
43 | cd y |
---|
44 | unzip x/vlo_parent-2.13/war/vlo_solr.war |
---|
45 | |
---|
46 | Make the Tomcat user owner of the files in the tree that starts in |
---|
47 | the y directory. |
---|
48 | |
---|
49 | In y/META-INF/context.xml file you will probably need to modify some |
---|
50 | definitions. |
---|
51 | |
---|
52 | - The context path value. If you define vlo_solr/ to be the value of the |
---|
53 | context path, and prefix is some string pointing to web server the |
---|
54 | application is installed on, the Solr server will be reachable at the |
---|
55 | |
---|
56 | prefix/vlo_solr/ |
---|
57 | |
---|
58 | url. |
---|
59 | |
---|
60 | - Assign x/vlo_parent-2.13/config/solr to the solr/home parameter. |
---|
61 | |
---|
62 | Next, copy the y/META-INF/context.xml file to |
---|
63 | |
---|
64 | /var/lib/tomcat6/conf/Catalina/localhost/vlo_solr.xml |
---|
65 | |
---|
66 | or to a directory equivalent to it. If necessary, make the Tomcat user owner |
---|
67 | of the vlo_solr.xml file. |
---|
68 | |
---|
69 | Create a link for the Tomcat server so that it knows where to look for the |
---|
70 | solr server installation: |
---|
71 | |
---|
72 | ln -sf y/solr/ /var/lib/tomcat6/webapps/vlo_solr |
---|
73 | |
---|
74 | or equivalent. The link created should identify the path defined the context |
---|
75 | file, vlo_solr in this case. |
---|
76 | |
---|
77 | If necessary, change the ownership of the link to the Tomcat user. And if |
---|
78 | you would like logging to be configured different from the type of logging |
---|
79 | packaged, please modify |
---|
80 | |
---|
81 | y/WEB-INF/classes/log4j.properties |
---|
82 | |
---|
83 | Restart tomcat: |
---|
84 | /etc/init.d/tomcat6 restart |
---|
85 | |
---|
86 | Inspect the Tomcat log file directory, and inspect the solr.log file. |
---|
87 | |
---|
88 | 4. Web application installation |
---|
89 | |
---|
90 | Similar to the solr archive, unpack x/vlo_parent-2.13/war/vlo.war in |
---|
91 | a directory z in which you want the vlo web application to reside. |
---|
92 | |
---|
93 | cd z |
---|
94 | unzip x/vlo_parent-2.13/war/vlo.war |
---|
95 | |
---|
96 | Make the Tomcat own the files in and below the z directory. |
---|
97 | |
---|
98 | Modify the META-INF/context.xml file. Like in the case of the solr server, |
---|
99 | assign the desired context path value. Again, if prefix is a string pointing |
---|
100 | to the web server the application is installed on, the vlo web application |
---|
101 | will be reachable at the url/vlo/ url. |
---|
102 | |
---|
103 | Because the packaged configuration is suitable to very specific (development) |
---|
104 | circumstances only, in most cases it does fit the production environment. You |
---|
105 | can specify an alternative, external configuration file, preferably the same |
---|
106 | file as the one used by the importer (see 5). |
---|
107 | |
---|
108 | Most likely, you will need to assign another value to the solrUrl parameter. |
---|
109 | This parameter is used to let the VLO web application know where it can reach |
---|
110 | the Solr server. You can set the value of this parameter in an external |
---|
111 | configuration file, or directly in the context file. |
---|
112 | |
---|
113 | Like in the case of the solr server, copy the z/META-INF/context.xml context |
---|
114 | file to: |
---|
115 | |
---|
116 | /var/lib/tomcat6/conf/Catalina/localhost/vlo.xml |
---|
117 | |
---|
118 | or to another, comparable path. Please make the Tomcat user own this file. |
---|
119 | |
---|
120 | Also, create a link for the Tomcat server so that it knows where to look |
---|
121 | for the vlo web application installation: |
---|
122 | |
---|
123 | ln -sf z/solr /var/lib/tomcat6/webapps/vlo |
---|
124 | |
---|
125 | Like in the case of the Solr server, the link created should identify the |
---|
126 | path defined the context file. Again, if necessary, change the ownership of |
---|
127 | the context file and the link to the Tomcat user. |
---|
128 | |
---|
129 | If you like, you can change the web application's way of logging. This time, |
---|
130 | modifications should be applied to: |
---|
131 | |
---|
132 | z/WEB-INF/classes/log4j.properties |
---|
133 | |
---|
134 | Restart the Tomcat server: |
---|
135 | |
---|
136 | /etc/init.d/tomcat6 restart |
---|
137 | |
---|
138 | or equivalent. This will cause the new Solr server and vlo web application to |
---|
139 | become active. |
---|
140 | |
---|
141 | Finally, inspect the Tomcat log file directory, and inspect the vlo.log file |
---|
142 | also. |
---|
143 | |
---|
144 | 5. Importer configuration |
---|
145 | |
---|
146 | Both the web application and the importer should use one and the same |
---|
147 | configuration file. So if, for example, the web application's configuration |
---|
148 | is in |
---|
149 | |
---|
150 | path/VloConfig.xml, add |
---|
151 | |
---|
152 | -c path/VloConfig.xml |
---|
153 | |
---|
154 | to the command in the importer script in the x/vlo_parent-2.13/bin directory. |
---|
155 | |
---|
156 | Most likely, the dataRoot values need to be changed. This is what a |
---|
157 | dataRoot definition could look like: |
---|
158 | |
---|
159 | <DataRoot> |
---|
160 | <originName>IPROSLA</originName> |
---|
161 | <rootFile>/lat/apache/htdocs/static-data-for-vlo-importer/</rootFile> |
---|
162 | <prefix>http://catalog.clarin.eu/</prefix> |
---|
163 | <tostrip>/lat/apache/htdocs/</tostrip> |
---|
164 | <deleteFirst>false</deleteFirst> |
---|
165 | </DataRoot> |
---|
166 | |
---|
167 | A dataRoot describes the meta data files. The toStrip part of the |
---|
168 | description is left out of the rootFile part to create a link to the |
---|
169 | meta data; the links starts with the prefix. |
---|
170 | |
---|
171 | Apart from the dataRoot values, the solrUrl parameter might need to be |
---|
172 | changed. Please note that the context path value defined in |
---|
173 | |
---|
174 | /var/lib/tomcat6/conf/Catalina/localhost/vlo_solr.xml |
---|
175 | |
---|
176 | or in a file equivalent to this one, should be reflected in the value of |
---|
177 | this parameter. |
---|
178 | |
---|
179 | Whenever the definition of the database changes, it is recommended to clear |
---|
180 | the database before starting an importer run. To do this, make sure that the |
---|
181 | 'deletaAllFirst' parameter equals true before the run. After that, the |
---|
182 | original value of the parameter could be restored. |
---|
183 | |
---|
184 | 6. Importing data |
---|
185 | |
---|
186 | You can run the importer by starting the |
---|
187 | |
---|
188 | ./vlo_solr_importer.sh |
---|
189 | |
---|
190 | script in the x/x/vlo_parent-2.13/bin directory. Messages are logged to the |
---|
191 | console. Because meta data is not static, it is recommended to run the |
---|
192 | importer a couple of times a week. Please note that, given the current |
---|
193 | (04.2013) set of data, a run typically takes between four and file hours. |
---|