Changeset 5594 for VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/doc/README.txt

Timestamp:

08/22/14 12:01:57 (10 years ago)

Author:

Twan Goosen

Message:

Added REST service information to the help page. Moved the documentation into a separate 'doc' directory in the project.
Refs #614

Location:

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/doc

Files:

• . (added)
• README.txt (moved) (moved from VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/README.txt) (4 diffs)

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/doc/README.txt

@@ -27 +27 @@
   NOTE: currently only MySQL is supported.
 
+* CONTEXT PARAMETERS *
+
+PUBLIC APPLICATION URL:
+
+Add the following context parameter (typically to the global context.xml file)
+and substitute the value with the correct *public* base location of the VCR:
+
+  <Parameter name="eu.clarin.cmdi.virtualcollectionregistry.base_uri"
+             value="http://my/server/VirtualCollectionRegistry"
+             override="false"/>
+
+Add no trailing slash. You can verify this by checking the service links in the
+help page of the running application.
+
+ADMINISTRATOR USERS:
+
+Add the following context parameter:
+
+<Parameter
+           name="eu.clarin.cmdi.virtualcollectionregistry.admindb"
+           value="/path/to/vcr-admin.conf" />
+
+Add the username of each user that should get administrator rights to the 
+referenced file, one username per line.
+
 * PID PROVIDER *
 
@@ -43 +68 @@
              value="vcr.pid.gwdg"
              override="false"/>   
-  <Parameter name="pid_provider.base_uri"
-             value="http://127.0.0.1:8080/VirtualCollectionRegistry"
-             override="false"/>
   <Parameter name="pid_provider.username" value="$gwdg_user" override="false"/>
   <Parameter name="pid_provider.password" value="$gwdg_password" override="false"/>
@@ -55 +77 @@
              value="vcr.pid.epic”
              override="false"/>   
-  <Parameter name="pid_provider.base_uri"
-             value="http://127.0.0.1:8080/VirtualCollectionRegistry"
-             override="false"/>
 
 * AUTHENTICATION *
@@ -104 +123 @@
 Change the value of the 'value' attribute if desired. If this parameter is not set,
 the default value "CLARIN Virtual Collection Registry" will be used as a collection name.
-
-* ADMINISTRATOR USERS *
-
-Add the following context parameter:
-
-<Parameter
-           name="eu.clarin.cmdi.virtualcollectionregistry.admindb"
-           value="/path/to/vcr-admin.conf" />
-
-Add the username of each user that should get administrator rights to the referenced
-file, one username per line.