source: ComponentRegistry/branches/ComponentRegistry-2.0/INSTALL @ 6881

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

documentation updated for JS front end

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