1 | INSTALLING THE COMPONENT REGISTRY REST SERVICE AND FLEX UI |
---|
2 | |
---|
3 | Important to know |
---|
4 | ----------------- |
---|
5 | The Component Registry REST service depends on a PostgreSQL database to |
---|
6 | store its data. It is packaged as a servlet and has been tested to work with |
---|
7 | Tomcat. |
---|
8 | |
---|
9 | The package includes a Flex based client that runs client-side in the |
---|
10 | user's browser. It is wrapped by an index.jsp page that embeds it and passes |
---|
11 | some parameters; it is located in the root of the application directory. |
---|
12 | |
---|
13 | The web application uses the Spring framework and in the current version it |
---|
14 | is partly configured through Spring (see below). |
---|
15 | |
---|
16 | Setting 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 | |
---|
21 | Configuring Tomcat |
---|
22 | ------------------ |
---|
23 | By default, the application assumes a named (JNDI) datasource |
---|
24 | jdbc/ComponentRegistry that provides access to the ComponentRegistry |
---|
25 | database. Set it up for the database described above in the Tomcat |
---|
26 | configuration. |
---|
27 | |
---|
28 | For more information, or configuring a custom datasource Spring bean, |
---|
29 | see WEB-INF/spring-config/datasource-jdbc.xml |
---|
30 | |
---|
31 | Deploying the application |
---|
32 | ------------------------- |
---|
33 | Deploy the ComponentRegistry.war file to the Tomcat instance. |
---|
34 | |
---|
35 | Configuring the application |
---|
36 | --------------------------- |
---|
37 | Some aspects could require additional configuration depending on the |
---|
38 | context: |
---|
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 |
---|