| 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 Javascript (REACT) based client that runs client-side in |
|---|
| 10 | the user's browser. It is wrapped by an index.html page that loads it and passes |
|---|
| 11 | some configuration; it is located in the root of the application directory. |
|---|
| 12 | |
|---|
| 13 | The application is mainly configured through context parameters (see below). |
|---|
| 14 | |
|---|
| 15 | Setting 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 | |
|---|
| 20 | Configuring Tomcat |
|---|
| 21 | ------------------ |
|---|
| 22 | By default, the application assumes a named (JNDI) datasource |
|---|
| 23 | jdbc/ComponentRegistry that provides access to the ComponentRegistry |
|---|
| 24 | database. Set it up for the database described above in the Tomcat |
|---|
| 25 | configuration. |
|---|
| 26 | |
|---|
| 27 | For more information, or configuring a custom datasource Spring bean, |
|---|
| 28 | see WEB-INF/spring-config/datasource-jdbc.xml |
|---|
| 29 | |
|---|
| 30 | If you keep the context parameters in a per-application context fragment, |
|---|
| 31 | make sure it is up-to-date with the one in the META-INF directory of the |
|---|
| 32 | war package. If not, make sure all context parameters defined in this file |
|---|
| 33 | are present in your global context configuration. |
|---|
| 34 | |
|---|
| 35 | Deploying the application |
|---|
| 36 | ------------------------- |
|---|
| 37 | Deploy the ComponentRegistry.war file to the Tomcat instance. |
|---|
| 38 | |
|---|
| 39 | Configuring the application |
|---|
| 40 | --------------------------- |
|---|
| 41 | Some 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 |
|---|
| 68 | |
|---|
| 69 | - Public base location for the application: needs to be configured, and will |
|---|
| 70 | need additional attention if the application is running behind a proxy. |
|---|
| 71 | See context.xml for details. |
|---|
