Difference between revisions of "Deploy Token Service"

Revision as of 15:49, 16 January 2008

To deploy Token Service application, you should perform the following steps:

1. Download the built web application or build the web application

• Download the built web application:
  • Download .war file currently deployed on [https://shangrila.parityinc.net:8443/TokenService/ shangrila.parityinc.net.

• • OR Download and unzip the war.zip file from one of the builds from [http://www.eclipse.org/higgins/ver2/downloadsnew.php?loc=downloads/sts.binding.axis1x.service higgins download page

• Build the web application
  • Download required Higgins projects from Eclipse CVS server using tokenService.psf project set file (in Eclipse SDK execute command File -> Import, choose “Team -> Team Project Set”, click on “Next” button and select tokenService.psf file).

• • Build the web application (instructions in progress).

2. Install/configure Apache Tomcat server. You can download Apache Tomcat from http://tomcat.apache.org.

• If you are going to use Token Service via SSL, you need to configure SSL connector (you need to create a certificate and uncomment SSL Connector settings as described (for Tomcat 6.x) at http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html).

• You need to configure log4j logging (see http://tomcat.apache.org/tomcat-6.0-doc/logging.html). In case of Tomcat 6.x, you need just copy two files (log4j-1.2.13.jar and log4j.properties) to <Tomcat directory>/lib directory. log4j.properties file can be found in the TokenService Configuration folder (see p. 4 below).

3. Install OpenLDAP server http://www.openldap.org. OpenLDAP is required by JNDI Context Provider (see http://wiki.eclipse.org/index.php/Components).

• On Linux:

• • Install OpenLDAP http://www.openldap.org/software/download/.

• • Configure OpenLDAP. By default, OpenLDAP configuration folder is /etc/openldap. If you are using this folder, just replace schema folder and slapd.conf file with files from linux_config.zip, otherwise replace schema folder and edit your slapd.conf. Compare your slapd.conf with slapd.conf from linux_config.zip and make the following changes:

• • • include required schema files;
    • set root element rootdn "cn=root";
    • set root element password rootpw higgins.

• • Run OpenLDAP (in case of using default OpenLDAP paths, execute /usr/libexec/slapd -f /usr/etc/openldap/slapd.conf).

• • Import some required entries from org.ldif file (execute /usr/libexec/ldapadd -x -D "cn=root" -w higgins -a -f org.ldif).

• On Windows:

• • Install OpenLDAP openldap-2.2.29-db-4.3.29-openssl-0.9.8a-win32_Setup.exe.

• • Configure OpenLDAP. If your OpenLDAP working directory is C:\Program Files\OpenLDAP, replace schema folder and slapd.conf file with files from windows_config.zip. If you are using another directory, replace schema folder and edit your slapd.conf. Compare your slapd.conf with slapd.conf from windows_config.zip and make the following changes:

• • • include required schema files;
    • set root element rootdn "cn=root";
    • set root element password rootpw higgins.

• • Run OpenLDAP (C:\Program Files\OpenLDAP\slapd -d 1).

• • Import some required entries from org.ldif file (C:\Program Files\OpenLDAP\ldapadd -x -D "cn=root" -w higgins -a -f org.ldif).

4. Configure TokenService. TokenService application uses some configuration files which are stored within a single configuration directiory. If you did not yet download Higgins projects, download org.eclipse.higgins.sts.binding.axis1x.service project using stsService.psf project set file (see p. 1.1.). This project contains /WebContent/ConfigurationFiles folder. You need to copy this folder to your server and make some changes which are described at Token_Service_Build_Instructions. Shortly, you need:

• Rename ManagedConfiguration.xml to Configuration.xml;
• Replace "https://localhost" string in Configuration.xml file with URL of your site;
• Change some properties (like URL of server, principal, credentials) of LDAP server in Configuration.xml.

You can download configuration files used by Token Service deployed on shangrila.parityinc.net. In this case you only need replace https://shangrila.parityinc.net:8443 with URL of your site and file:///home/mruddy/ConfigurationFiles with your confiiguration path.

5. Deploy Token Service.

• Copy TokenService.war file to <Tomcat directory>/webapps directory.

• Add "org.eclipse.higgins.sts.conf" system property which should contain your Configuration directory path and "org.eclipse.higgins.sts.log4j.properties"

• • If you use Windows, add to catalina.bat the string like:

SET JAVA_OPTS=-Dorg.eclipse.higgins.sts.conf=C:\TokenService\ConfigurationFiles -Dorg.eclipse.higgins.sts.log4j.properties=C:\TokenService\ConfigurationFiles\log4j.properties %JAVA_OPTS%

• • If you use Linux, add to catalina.sh the string like:

JAVA_OPTS='-Dorg.eclipse.higgins.sts.conf=/etc/TokenService/ConfigurationFiles -Dorg.eclipse.higgins.sts.log4j.properties=/etc/TokenService/ConfigurationFiles/log4j.properties $JAVA_OPTS'