#
# Install instructions for the AstroGrid registry.

#
# These instructions assumes that the following environment variables have already been set :
# JAVA_HOME
# CATALINA_HOME
# ASTROGRID_HOME
# ASTROGRID_HOSTNAME

#
# -------- -------- -------- --------
# Install registry webapp.
#

#
# Set the local registry authority identifier.
# Convention is to use your DNS domain name reversed.
# Example 'www.astrogrid.org' DNS domain becomes 'org.astrogrid' registry authority.
export ASTROGRID_REGISTRY_AUTH=<your dns domain reveresed>


#
# Set the registry version.
export ASTROGRID_REGISTRY_VERSION=2006.3.03r

#
# Create registry directories.
mkdir ${ASTROGRID_HOME}/registry
mkdir ${ASTROGRID_HOME}/registry/webapp
mkdir ${ASTROGRID_HOME}/registry/log
mkdir ${ASTROGRID_HOME}/registry/exist
mkdir ${ASTROGRID_HOME}/registry/exist/data

#
# Get the latest registry webapp.
wget -P ${ASTROGRID_HOME}/registry/webapp http://www.astrogrid.org/maven/org.astrogrid/wars/astrogrid-registry-${ASTROGRID_REGISTRY_VERSION}.war

#
# Extract the default registry config.
unzip -j -d ${ASTROGRID_HOME}/registry/exist $ASTROGRID_HOME/registry/webapp/astrogrid-registry-${ASTROGRID_REGISTRY_VERSION}.war WEB-INF/conf.xml

#
# Configure the database location.
vi ${ASTROGRID_HOME}/registry/exist/conf.xml

** Replace {ASTROGRID_HOME} with the full path (two places) **
<exist>
    ....
    <db-connection
        database="native"
        files="{ASTROGRID_HOME}/registry/exist/data"
        pageSize="4096"
        cacheSize="48M"
        free_mem_min="5"
        >
        ....
        <recovery
            enabled="yes"
            sync-on-commit="no"
            journal-dir="{ASTROGRID_HOME}/registry/exist/data"
            size="10M"
            />
        ....
    </db-connection>
</exist>

#
# Create registry context file.
vi ${CATALINA_HOME}/conf/Catalina/localhost/astrogrid-registry.xml

** Replace {ASTROGRID_HOME} with the full path (three places)
** Replace {ASTROGRID_REGISTRY_VERSION} with the webapp version (one place)
** Replace {ASTROGRID_REGISTRY_AUTH} with the local authority identifier (one place)
** Replace {ASTROGRID_REGISTRY_EMAIL} with your email address (one place)
<?xml version='1.0' encoding='utf-8'?>
<!-- Configure the docBase -->
<Context
    displayName="AstroGrid publishing registry"
    docBase="{ASTROGRID_HOME}/registry/webapp/astrogrid-registry-{ASTROGRID_REGISTRY_VERSION}.war"
    path="/astrogrid-registry"
    >

    <!-- Configure the main authority ID -->
    <Environment
        description="The main authority ID for this registry"
        name="reg.amend.authorityid"
        type="java.lang.String"
        value="{ASTROGRID_REGISTRY_AUTH}"
        />

    <!-- Configure the OAI registry name -->
    <Environment
        description="The OAI identify verb"
        name="reg.amend.identify.repositoryName"
        type="java.lang.String"
        value="AstroGrid publishing registry"
        />

    <!-- Configure the OAI administrator email -->
    <Environment
        description="The OAI administrator email"
        name="reg.amend.identify.adminEmail"
        type="java.lang.String"
        value="mailto:{ASTROGRID_REGISTRY_EMAIL}"
        />

    <!-- Disable harvesting -->
    <Environment
        description="Enable harvesting."
        name="reg.amend.harvest"
        type="java.lang.String"
        value="false"
        />

    <!-- Configure the log directory -->
    <Environment
        description="Registry log directory."
        name="reg.custom.loggingdirectory"
        type="java.lang.String"
        value="{ASTROGRID_HOME}/registry/log"
        />

    <!-- Configure the eXist config file and data directory -->
    <Environment
        description="eXist configuration and data directory"
        name="reg.custom.exist.configuration"
        type="java.lang.String"
        value="{ASTROGRID_HOME}/registry/exist/conf.xml"
        />

    <!--+
        | Configure the internal OAI URLs.
        | These are used internally by the service, hence localhost address. 
        +-->
    <Environment
        description="The the OAI publishing url for 0.10 (not required)"
        name="reg.amend.oaipublish.0.10"
        type="java.lang.String"
        value="http://localhost:8080/astrogrid-registry/OAIHandlerv0_10"
        />
    <Environment
        description="The the OAI publishing url for 0.1 (not required)"
        name="reg.amend.oaipublish.0.1"
        type="java.lang.String"
        value="http://localhost:8080/astrogrid-registry/OAIHandlerv0_10"
        />

</Context>

#
# Check the registry home page.
# http://${ASTROGRID_HOSTNAME}:8080/astrogrid-registry/

#
# Check the registry admin page (workshop, qwerty).
# http://${ASTROGRID_HOSTNAME}:8080/astrogrid-registry/admin/index.jsp


#
# Self register form
# http://${ASTROGRID_HOSTNAME}:8080/astrogrid-registry/admin/selfRegisterForm.jsp 

    Title           <your institute>
    Publisher       <your institute>
    ContactName     <your name>
    ContactEmail    <your email>

#
# Check for entry listed in browse page.
# http://${ASTROGRID_HOSTNAME}:8080/astrogrid-registry/browse.jsp?IvornPart=${ASTROGRID_REGISTRY_AUTH}

#
# -------- -------- -------- --------
# Set the registry endpoint URLs.
# This will set the endpoint URLs that your services will use to find other services.
# Please check with the astrogrid team a Leicester for the correct URLs.

#
# The registry update endpoint should always point to your local registry.
export ASTROGRID_REGISTRY_ADMIN=http://${ASTROGRID_HOSTNAME}:8080/astrogrid-registry/services/RegistryUpdate

#
# For a local test system, this should point to your local registry.
# This will mean that your components will only be able to use services within your local system.
export ASTROGRID_REGISTRY_QUERY=http://${ASTROGRID_HOSTNAME}:8080/astrogrid-registry/services/RegistryQuery
#
# For a test service, you need to point to the development grid registry at Leicester.
# This will mean that your components will be able to use services registered with the development system.
# export ASTROGRID_REGISTRY_QUERY=http://katatjuta.star.le.ac.uk:8080/astrogrid-registry/services/RegistryQuery
#
# For a live service, you need to point to the main global registry at Leicester.
# This will mean that your components will be able to use services registered with the main AstroGrid system.
# export ASTROGRID_REGISTRY_QUERY=http://galahad.star.le.ac.uk:8080/astrogrid-registry/services/RegistryQuery


#
# -------- -------- -------- --------
# Register your registry with the AstroGrid registry.
# For a local test system, you don't need to register with the main AstroGrid system.
# For a test system, you should register with the development grid registry at Leicester.
# For a live system, you should register with the main global registry at Leicester.
#

#
# Add an entry for your registry into the external registry.
# This record will tell the external registry where to find our publishing registry.
# ** Edit the following entry and then email it to a member of the AstroGrid team at Leicester.
# ** Replace {ASTROGRID_REGISTRY_NAME} with your institute name (one place).
# ** Replace {ASTROGRID_REGISTRY_AUTH} with the local authority identifier (three places).
# ** Replace {ASTROGRID_HOSTNAME} with the the correct host name (one place).
#
<vor:VOResources
    xmlns:vor="http://www.ivoa.net/xml/RegistryInterface/v0.1"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:xs="http://www.w3.org/2001/XMLSchema" 
    xmlns:vr="http://www.ivoa.net/xml/VOResource/v0.10" 
    xmlns:vg="http://www.ivoa.net/xml/VORegistry/v0.3" 
    xmlns:vs="http://www.ivoa.net/xml/VODataService/v0.5"
    xmlns="http://www.ivoa.net/xml/VOResource/v0.10">
    <vor:Resource
        status="active"
        xsi:type="vg:Registry"
        >
        <title>{ASTROGRID_REGISTRY_NAME} registry</title>
        <identifier>ivo://{ASTROGRID_REGISTRY_AUTH}/org.astrogrid.registry.RegistryService</identifier>
        <interface xsi:type="vs:WebService">
            <accessURL use="full">http://{ASTROGRID_HOST}:8080/astrogrid-registry/services/RegistryHarvest</accessURL>
        </interface>
        <vg:managedAuthority>{ASTROGRID_REGISTRY_AUTH}</vg:managedAuthority>
    </vor:Resource>
</vor:VOResources>

#
# Ask the AstroGrid registry to harvest your local registry.
# ** This needs to be done by a member of the AstroGrid team at Leicester **

#
# Check your registry is visible in the AstroGrid registry.