source: ComponentRegistry/trunk/INSTALL @ 2300

Last change on this file since 2300 was 2300, checked in by twagoo, 12 years ago

Moved README etc files into project root. Fixed and extended some bits in README

File size: 2.0 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
31Deploying the application
32-------------------------
33Deploy the ComponentRegistry.war file to the Tomcat instance.
34
35Configuring the application
36---------------------------
37Some aspects could require additional configuration depending on the
38context:
39
40- Admin users. The application expects a context parameter
41  'componentRegistryAdminUsers' to be set as a white-space separated list of
42  users that should be granted access to the administration interface. So,
43  make sure the following is set in the relevant context fragment:
44
45    <Parameter
46        name="componentRegistryAdminUsers"
47        value="joe.admin@mpi.nl someone.else@clarin.eu"/>
48
49- Shibboleth authentication. ComponentRegistry uses the SHHAA filter, which
50  is configured in WEB-INF/shhaa.xml. Make sure SSO and SLO URL's are correct.
51
52- Misc configuration including admin users (has sensible defaults for
53  catalog server): WEB-INF/spring-config/component-registry.xml
Note: See TracBrowser for help on using the repository browser.