source: ComponentRegistry/tags/ComponentRegistry-1.14.6/INSTALL @ 6453

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

tagged 1.14 branch as 1.14.6

File size: 2.9 KB
Line 
1INSTALLING THE COMPONENT REGISTRY REST SERVICE AND FLEX UI
2
3Important to know
4-----------------
5The Component Registry REST service depends on a PostgreSQL database to
6store its data. It is packaged as a servlet and has been tested to work with
7Tomcat.
8
9The package includes a Flex based client that runs client-side in the
10user's browser. It is wrapped by an index.jsp page that embeds it and passes
11some parameters; it is located in the root of the application directory.
12
13The web application uses the Spring framework and in the current version it
14is partly configured through Spring (see below).
15
16Setting up the database
17-----------------------
18- Create a new PostgreSQL database and configure users and roles
19- Run the create script 'create.sql' under the appropriate permissions
20
21Configuring Tomcat
22------------------
23By default, the application assumes a named (JNDI) datasource
24jdbc/ComponentRegistry that provides access to the ComponentRegistry
25database. Set it up for the database described above in the Tomcat
26configuration.
27   
28For more information, or configuring a custom datasource Spring bean,
29see WEB-INF/spring-config/datasource-jdbc.xml
30
31If you keep the context parameters in a per-application context fragment,
32make sure it is up-to-date with the one in the META-INF directory of the
33war package. If not, make sure all context parameters defined in this file
34are present in your global context configuration.
35
36Deploying the application
37-------------------------
38Deploy the ComponentRegistry.war file to the Tomcat instance.
39
40Configuring the application
41---------------------------
42Some aspects require additional configuration depending on the context:
43
44- Shibboleth authentication. ComponentRegistry uses the SHHAA filter, which
45  is configured in WEB-INF/shhaa.xml. Make sure SSO and SLO URL's are correct.
46 
47- Admin users. The application expects a context parameter
48  'componentRegistryAdminUsers' to be set as a white-space separated list of
49  users that should be granted access to the administration interface. So,
50  make sure the following is set in the relevant context fragment:
51
52    <Parameter
53        name="eu.clarin.cmdi.componentregistry.adminUsers"
54                value="joe.admin@mpi.nl someone.else@clarin.eu"/>
55
56- Documentation url: The application expects a context parameter
57  'eu.clarin.cmdi.componentregistry.documentationUrl' to be set. The application
58  redirects to this page when the user browses to /documentation.jsp or clicks
59  the 'help' link in the GUI.
60
61- Location parameters: a number of context parameters define locations of
62  schema and XSLT locations. Usually the defaults should be fine. The concerning
63  parameters are:
64        * eu.clarin.cmdi.componentregistry.documentationUrl
65        * eu.clarin.cmdi.componentregistry.generalComponentSchemaUrl
66        * eu.clarin.cmdi.componentregistry.component2SchemaXslUrl
67        * eu.clarin.cmdi.componentregistry.componentSpecSchemaLocation
68        * eu.clarin.cmdi.componentregistry.ccrRestUrl
Note: See TracBrowser for help on using the repository browser.