UVOS Web Registration Extension Manual
======================================
UNICORE Team <unicore-support@lists.sourceforge.net>
:revnumber: 1.5.1
:numbered:

UNICORE VO Service (UVOS) is a client-server system, developed to be used as an additional tool for large
distributed systems, providing a solution for grid users management. 
Grid systems, especially UNICORE grid middleware, are the mainspring of the UVOS system. 
UVOS can be used with different systems, however is designed primarily to support UNICORE grid middleware. 

For more information about UVOS visit http://uvos.chemomentum.org[http://uvos.chemomentum.org].

Introduction
------------

VO application forms web UI for the UVOS system provides an on-line registration
form for users applying for VO membership. For a general overview of the UVOS system please
review UVOS server documentation.

The main features of this module are:

 - a customizable interface for submitting VO registration
 requests,
 - customization allows for choosing agreement form, requested attributes,
 base VO, request additional groups, provide contact details and provide
 identity in a supported format,
 - multiple application forms might be used,
 - updates of forms do not require server's restart.
 - it is possible to connect this module with PnP CA, so user can automatically
 request a VO membership and a certificate. 


Compatibility
-------------

This release is compatible with UVOS 1.4.0 and 1.4.1 (future versions might be
supported too).


Installation
------------

UVOS web application extension is distributed either as a 
platform independent archive or as an installable, platform dependent package 
such as RPM. Depending on the installation source used, installation method and paths 
after installation are different. 


Installation from RPM package (RedHat distributions) 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The preferred way is to use Yum  to install (and subsequently update) UVOS webapp.

To perform the Yum installation, EMI Yum repository must be installed first. 
Refer to the EMI release documentation (available at the EMI website http://www.eu-emi.eu/releases ) 
for detailed instructions. Typically installation of the EMI repository requires to 
download a single RPM file and install it. 

After the EMI repository is configured, the following command installs UVOS webapp:
 
 $> yum install unicore-uvos-webapp

The installed extension will be placed in the directory 
+/var/lib/unicore/uvos-server/webapps/+

You have to restart UVOS server to complete the installation.

Installation from the DEB package (Debian distributions) 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	
The preferred installation way is to use apt to install and subsequently update UVOS webapp.
	 
To perform the apt installation, EMI apt repository must be installed first. 
Refer to the EMI release documentation (available at the EMI website http://www.eu-emi.eu/releases ) 
for detailed instructions. Typically installation of the EMI repository requires to 
download a single DEB file and install it. 

After the EMI repository is configured, the following command installs UVOS webapp:

 $> apt-get install unicore-uvos-webapp

The installed extension will be placed in the directory 
+/var/lib/unicore/uvos-server/webapps/+

You have to restart UVOS server to complete the installation.

Installation from the archive
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If installing using a portable archive you have:

 1. Download the archive from the UNICORE download site and unpack it.
 2. In the unpacked archive you can find a file with a .war extension. 
 Copy it to the +webapps/+ directory of UVOS server. This directory 
 is placed directly under installation root folder which was
 used when installing UVOS server from portable archive.  

You have to restart UVOS server to complete the installation.

Web browser path
----------------

The name of the war file is important as it is reflected in the 
URL by which web application is available. By default it is 
uvos-webapp-VERSION.war, where VERSION is e.g. "1.2". You can freely
change the name of the war file. From now we will use label
WAR_FILE_NAME to refer to actual base name of your war file.

You should be able to reach the web UI indirectly (via redirect) 
at the address:

	<UVOS server base address>/WAR_FILE_NAME

or directly at:

----------
<UVOS server base address>/WAR_FILE_NAME/VOapplications.do?_flowId=application-flow
----------

Example for the default server configuration and release 1.0:

	https://localhost:2443/uvos-webapp-1.0
	
Example application form is present in this package. See its comments for 
the information how to set it up. Use the UVOS command line client (UVOS CLC) to 
add/update/delete forms. You can use both UVOS CLC ant VOManager to manage applications
(accept/reject/delete/update). 

VO application form changes are detected automatically by this component so you 
don't need to restart the UVOS server.

Since the version 1.3.1 this module can automatically send user's CSR to
the new PnP CA (see http://pnp-ca.sourceforge.net). 

Reference application form
--------------------------

The +referenceApplicationForm.xml+ file which can be found in this extension
distribution provides a complete and up to date example of what can be configured
in the application form. Its contents is also presented below.

----------------
include::referenceApplicationForm.xml[]
----------------