Beruflich Dokumente
Kultur Dokumente
INSTALLATION GUIDE
LINUX
Europe, Middle-East, Africa: Polarion Software GmbH Hedelfinger Strae 60 70327 Stuttgart, GERMANY Tel +49 711 489 9969 - 0 Fax +49 711 489 9969 - 20 www.polarion.com - info@polarion.com
Americas & Asia-Pacific: Polarion Software, Inc. 100 Pine St. Ste. 1250 San Francisco, CA 94111, USA Tel +1 877 572 4005 (Toll free) or +1 510 995 8955 Fax +1 510 814 9983 www.polarion.com - info@polarion.com
Version: 2013 Copyright 2008-2013 Polarion Software Permission is granted to use, copy, and distribute this document provided that the content is not modified and the above copyright notice and this statement appear in all copies. Polarion is a registered trademark of Polarion Software. Polarion ALM, Polarion REQUIREMENTS, Polarion QA and Polarion TRACK & WIKI are trademarks of Polarion Software. Linux is a trademark of Linus Torvalds. Microsoft, Microsoft Office, Microsoft Excel, and Microsoft Word are trademarks or registered trademarks of Microsoft Corporation. Other mentioned trademarks are property of their respective owners.
Updated: 16-Jan-2013
Table of Contents
ABOUT THIS GUIDE ......................................................................................................................... 4 Evaluation Installation .............................................................................................................. 4 Multi-repository Installation ...................................................................................................... 4 CHAPTER 1. SYSTEM REQUIREMENTS/RECOMMENDATIONS ............................................... 5 SERVER SOFTWARE AND HARDWARE .............................................................................................. 5 Server Software ....................................................................................................................... 5 Server Hardware ...................................................................................................................... 5 CLIENT SOFTWARE AND HARDWARE ................................................................................................ 6 Client Software ......................................................................................................................... 6 Client Hardware ....................................................................................................................... 6 ADDITIONAL RECOMMENDATIONS .................................................................................................... 6 Libraries required for building the demo projects .................................................................... 6 Enable support for Javadoc ..................................................................................................... 7 Enable Notifications ................................................................................................................. 7 CHAPTER 2. LINUX INSTALLATION OVERVIEW ........................................................................ 8 INSTALLATION TYPES AND OPTIONS ................................................................................................. 8 Automated vs. Manual Installation ........................................................................................... 8 Default vs. Custom Installation ................................................................................................ 8 ABOUT AUTOMATED INSTALLATION .................................................................................................. 9 Supported Linux versions for automated installation ............................................................... 9
Supported Platforms and Installation Types ...................................................................................... 9 Automated Installation Process ....................................................................................................... 10
ABOUT MANUAL INSTALLATION ...................................................................................................... 10 CHAPTER 3. AUTOMATED INSTALLATION PROCEDURE ...................................................... 11 CHAPTER 4. MANUAL LINUX INSTALLATION .......................................................................... 12 REQUIRED THIRD-PARTY SOFTWARE COMPONENTS ........................................................................ 12 Apache Server ....................................................................................................................... 12
htpassword utility ............................................................................................................................. 12
Subversion ............................................................................................................................. 12 Jakarta JK-connector module ................................................................................................ 13 Java SE JDK .......................................................................................................................... 13 CONFIGURATION OF THIRD-PARTY COMPONENTS ........................................................................... 13 Apache HTTPD ...................................................................................................................... 13
Special Apache configuration on Linux systems with older mod_jk ................................................. 15 Java Virtual Machine Memory Limit ................................................................................................. 16
Subversion ............................................................................................................................. 15 Java JRE and SDK ................................................................................................................ 16 INSTALLING POLARION .................................................................................................................. 16 About the Installation Archive ................................................................................................ 16 Manual Installation Procedure ............................................................................................... 16
Setting Permissions ......................................................................................................................... 17 Notes on the manual installation ...................................................................................................... 17
Configuring Polarion .............................................................................................................. 17 CHAPTER 5. SYSTEM STARTUP AND SHUTDOWN ................................................................. 19 Starting Polarion .................................................................................................................... 19 Shutting Down Polarion ......................................................................................................... 19 Integration with init system..................................................................................................... 19 CHAPTER 6. AFTER INSTALLATION .......................................................................................... 20 CHANGING DEFAULT SYSTEM PASSWORDS.................................................................................... 20 Changing the Default System Administrator Password ......................................................... 20 Changing the password for SVN user polarion .................................................................... 20
Note for LDAP Users ....................................................................................................................... 21
Using different license types .................................................................................................. 21 Assigning named and concurrent users ................................................................................ 21 License usage log file ............................................................................................................ 21 USING POLARION WITH AN EXISTING SUBVERSION REPOSITORY ..................................................... 22 Modify the polarion.properties file .......................................................................................... 22 Re-index the Repository ........................................................................................................ 22 Rename or Remove the Default Repository .......................................................................... 23 MULTIPLE REPOSITORY SETUP ..................................................................................................... 23 ACCESSING THE POLARION PORTAL .............................................................................................. 23 LDAP AUTHORIZATION .................................................................................................................. 24 FIRST STEPS AFTER INSTALLATION................................................................................................ 24 UNINSTALLING POLARION .............................................................................................................. 24 CHAPTER 7. TECHNICAL SUPPORT .......................................................................................... 25 APPENDIX ..................................................................................................................................... 26 DEFAULT USERS AND GROUPS ...................................................................................................... 26 SUPPORTED MICROSOFT OFFICE VERSIONS ................................................................................ 27
Evaluation Installation
If you installing Polarion for evaluation purposes, you may want to read instead the Polarion Trial Guide (PDF), available for download on any product download page at www.polarion.com. This guide focuses on getting you up and running with an evaluation installation as quickly as possible, using the 1-click install option of the Windows installer. (This option, available only for Windows, is recommended for the initial stage of any evaluation. You may of course choose to run an evaluation on Linux, in which case this document provides the necessary information.)
Multi-repository Installation
If you have need to use Polarion with multiple repositories, either hosted externally to Polarion, or running on multiple concurrent instances of the Polarion server, you should get the Polarion Multi-repository Setup Guide (PDF), also available on product download pages on the Polarion Software website.
Server Software
Requirement
Operating System
Description
SUSE Linux Enterprise Server 11 or Red Hat Enterprise Linux 6.x/CentOS 6.x or Debian GNU/Linux 6.0 or Ubuntu Server 12.04 LTS Supported architectures are x86, x86_64 or amd64. Java Platform, Standard Edition 6 Development Kit - Oracle JDK 6 (http://www.oracle.com/technetwork/java/javase/downloads/index.html) Note that OpenJDK 6 is not the same as Oracle Java 6 and is not officially supported. JAVA_HOME/bin should exist in the system paths.
Subversion version 1.6.x or higher: http://subversion.apache.org/ If you are compiling Subversion yourself, compile using the --with-apsx or --with-httpd option
Web server
Apache HTTPD server with mod_proxy_ajp (or Jakarta JK connector - mod_jk extension) and Subversion extension (WebDAV+SVN apache modules): http://httpd.apache.org/ In general, the Polarion server should run with whatever Apache version is present in a Linux system provided it is at least the minimum required version (2.0.59), and mod_proxy_ajp (or JK Connector) and Subversion extension modules are also installed.
Server Hardware
Requirement
RAM
Description
Minimum: 4 gigabytes for production installation Recommended: 8 gigabytes or more and a 64-bit operating system Minimum: 10 gigabytes Recommended: 40 gigabytes or more There is no hard and fast rule for disk storage space. The actual amount you will require depends on the number and size of projects managed with Polarion. The more projects, and the larger they are, the more disk storage you will require
Client Software
Requirement
Operating System
Description
Any operating system that can run the supported web browsers with support for the Flash plugin (see below). If the client user will use a Polarion product supporting data interchange with Microsoft Office, the client user must run a Windows operating system compatible with a supported version of the Microsoft Office application(s) used. For details, please see Appendix: Supported Microsoft Office Versions. All you need to use Polarion is a web browser. The most current list of supported browsers and versions is provided in the Release Notes section of the README.html file, delivered in all download distributions of all Polarion products. The Polarion web portal displays charts and other graphical data about Polarion-managed projects using Adobe Flash. To view these properly using a web browser, the client computer must have Adobe Flash Player installed. You can download it free at http://www.adobe.com/products/flashplayer/.
Web Browser
Adobe Flash
Client Hardware
Requirement
RAM Display resolution Server connection
Additional Recommendations
The items described in this section are not critical for running and evaluating Polarion. However, the components described are needed to be able to fully utilize the product's capabilities.
Enable Notifications
The Polarion server can send email notifications in response to various events in the system such as build completions, new work items, etc. It can also notify users about external changes. To enable Polarion to send out email notifications you need to: 1. Configure the SMTP server to be used by the Polarion server for sending e-mails. You can do this before starting Polarion server by setting the host name in the announcer.smtp.host property in the polarion.properties file located in $POLARION_HOME$/etc/. There you should also set the announcer.smtp.user and announcer.smtp.password properties to a valid e-mal account on the SMTP host specified in announcer.smtp.host. If your SMTP server doesnt listen on default port 25, change the port setting in announcer.smtp.port. You may wish to create a special account on your SMTP host for use with Polarion notifications. 2. Provide a valid e-mail address for each user in their user account. (Administration > User Management > Users.) This can be automated through user self-creation of accounts, or integration with LDAP. See Help, Administrators Guide: Managing Users and Permissions. When this configuration is correctly set up, the system will send notification e-mails about various events according to the notification targets configuration. For information on configuring email notifications, see Help, Administrators Guide: Configuring Notifications.
Note
If a work item is modified outside the Polarion portal (e.g. manually in SVN), email notifications are sent the same as they would be if the modification has been done in the portal.
Manual installation means you must pre-install required infrastructure software before
you attempt to install the Polarion platform. You follow steps in documentation as opposed to interactive instructions from a script. You may also need to write some shell scripts by hand or modify the manual_install.sh file before running it. Manual installation is necessary on Linux platforms that are not officially tested or supported by Polarion Software. For more information see About Manual Installation.
Semi- automated installation is a third type in which the automated installation process
script is not able to install all the prerequisites for some platform automatically, so it requests you to install something manually before proceeding. For installation types and the platforms for which they are applicable, see About Automated Installation.
Default means installing with the default values and settings, especially default installation
directories and Unix user accounts. The option to install or not to install demo projects and data is part of the default installation. This is probably the best option for evaluation purposes.
Custom means you modify some of the installation parameters (in scripts or property
files) before executing the installation script or beginning the manual process. Installing to a non-default path is one example of custom installation.
Type
Automated
RedHat
Semi-Automated
Ubuntu
Automated
Debian
Automated
Manual
10
./polarion/license/
If you do not yet have a license key or need help obtaining one (evaluation or other) please contact sales@polarion.com before continuing with the installation procedure. 3. If SELinux is bundled with/installed on your Linux OS, make sure it is not activated. Check the status of SELinux with command /usr/sbin/sestatus -v. 4. Log in to the root account. 5. Navigate into the unpacked directory. 6. Run the installation script:
time)
./install.sh
Important
If yo u a lr e a d y h a ve o n e o r m or e o f t he r e q uir ed th ir d -p ar t y s o ftw ar e s ys t e m s in st al le d, yo u ca n r e sp o nd N O t o t h e pr o mp t s a s ki ng i f yo u w an t t o in s tal l t he m, B U T BE AL S O LU T E LY S URE Y O U D O H AV E I T I NS T AL L E D, o t herw ise yo u ca n b r ea k th e au t o ma te d p r oc es s an d i t ca n be pr ob l em a tic to re s u me . If yo u a r e n o t AB S O L U TE LY S U RE yo u h a ve th e r e q uir e d i n st al la ti o n an d c on f ig ur at i on , i t is be t te r t o r es p on d YES t o su c h pr o m p ts.
7. Continue with the installation, answering questions when prompted by the script. 8. After the installation process the Polarion server will start automatically, which you can verify by navigating to the http://localhost/polarion URL.
11
Apache HTTP Server version 2.0.59 or higher (latest 2.2.x is recommended) Subversion version 1.6.x or higher (1.7.x is recommended) Subversion server version 1.6.x or higher (1.7.x is recommended) installed in your
Apache server
For Apache 2.0.x , Jakarta JK-connector module 1.2.15 or higher, installed in your
Apache server
Apache Server
Apache HTTP Server is a required application for Polarion. We highly recommend to install it first. You should use version 2.0.59 or higher (latest 2.2.x is recommended). You can download the appropriate distribution at the Apache website at http://httpd.apache.org/. Installation Help for Apache HTTP server is available from Apache at http://httpd.apache.org/docs-2.0/install.html.
htpassword utility
After installation you must ensure that htpasswd utility is executable. This means that the apache/bin folder must be present among other paths in PATH system variable OR the full path needs to be specified in the polarion.properties file.
Note
On SUSE the utility may be called httpasswd2.
Subversion
The Subversion version control system is also required for Polarion. You should use version 1.6 or higher (see above for recommended version). You can download the appropriate distribution from the Subversion website at http://subversion.apache.org/. Full user/administrator documentation is available on a third-party website at http://svnbook.red-bean.com/.
12
Java SE JDK
You should also download and install the Java SE 6 JDK at http://www.oracle.com/technetwork/java/javase/downloads/index.html.
[Polarion_Unpack_Dir]/libinstall/predefined/[OS]/**
Apache HTTPD
You should inspect supported OS configurations first and look at this section only if you use Apache 2.0.x. 1. Apache must be compiled with WebDAV module (mod_dav.so). 2. Modules from Subversion must be properly installed (mod_authz_svn.so and mod_dav_svn.so) The following lines must be added into an Apache configuration file into the LoadModule section. This can be the default configuration file httpd.conf file ([Apache2_Dir]/conf/httpd.conf), or any other conf file, including a new one you create for the purpose. Lines: LoadModule dav_svn_modulemodules/mod_dav_svn.so LoadModule authz_svn_modulemodules/mod_authz_svn.so 3. Add the following lines to your httpd.conf: <Location /repo> DAV svn SVNPath "/opt/polarion/data/svn/repo"
# try anonymous access first, resort to real # authentication if necessary. Satisfy Any Require valid-user
13
# How to authenticate a user. (NOTE: Polarion does not currently support # HTTP Digest access authentication.) AuthType Basic AuthName "Subversion repository on localhost" AuthUserFile "/opt/polarion/data/svn/passwd" SVNAutoversioning on
</Location>
#polarion specific configuration of apache for svn and maven2 repo # Maven 2 shared repository
<Directory "/opt/polarion/data/shared-maven-repo"> Options Indexes Order allow,deny Allow from all </Directory>
Alias /maven2 "/opt/polarion/data/shared-maven-repo" Pay attention to the name of repository (/repo) in the first tag (<Location /repo>). It's the name (an alias) of your Subversion repository. Don't forget to specify correct paths to the real repository folder (in the SVNPath parameter), to the access file (in the AuthzSVNAccessFile parameter), and to the passwd file (in the AuthUserFile parameter). Pay attention to the paths used in the httpd.conf example above. They must be the same as those used by default by the libinstall/default.sh script - this script won't work if different paths are used. 4. JK-Connector (Jakarta Tomcat Connector) module must be properly installed (file: mod_jk.so) Copy the module file mod_jk.so to the Apache module folder ([Apache2_Dir]/modules/). Then add the following string to the httpd.conf file ([Apache2_Dir]/conf/httpd.conf) in the LoadModule section: LoadModule jk_module modules/mod_jk.so Pay attention to the module name jk_module do not change it! 5. Create a file named workers.properties in your Apache server's configuration directory (where the httpd.conf file resides) with the following:
14
worker.list=worker1 worker.worker1.type=ajp13 worker.worker1.host=127.0.0.1 worker.worker1.port=8889 worker.worker1.lbfactor=50 worker.worker1.cachesize=50 worker.worker1.cache_timeout=600 worker.worker1.socket_keepalive=1 worker.worker1.recycle_timeout=300 6. Create a file named polarion_mounts.properties in your Apache server's configuration directory (where the httpd.conf file resides). Add the following lines: /polarion/*=worker1 /polarion=worker1 /svnwebclient/*=worker1 /svnwebclient=worker1 7. Add the following lines to your httpd.conf file: JkWorkersFile conf/workers.properties JkLogFile JkLogLevel logs/mod_jk.log error
JkMountFile conf/polarion_mounts.properties You must specify correct paths to the workers.properties file and the polarion_mounts.properties file. The path to the mod_jk.log file should point to the directory where Apache's error_log file is written (search for the ErrorLog directive in httpd.conf).
Subversion
Either the Subversion binary (svn) must be on PATH or the javahl libraries must be properly installed.
15
If you use only the JRE (runtime), you must add bin/javac and lib/tools.jar
from Java SE JDK, and, optionally, bin/javadoc if you want Javadoc generation to work in Polarion.
Installing Polarion
After the required third-party software is installed and configured, you are ready to undertake the installation of the Polarion platform itself.
6. Create a Unix system account named polarion for the Polarion server.
7. Review the path variables defined in the libinstall/default.sh. Set up v_web_user and v_web_group. 8. Execute (under root):
16
This will install Polarion into the standard location /opt/polarion. Data will be installed into the standard location /opt/polarion/data.
Setting Permissions
After manual installation you need to set up permissions on unpacked folders. Standard permissions are:
Read only for everybody, owner and group root:root on folders and its subfolders:
/opt/polarion/polarion /opt/polarion/maven
Change the value of the host.name parameter from localhost to the host name
specified in httpd.conf.
Check that the repository alias in the svn.url parameter corresponds to the one in the
httpd.conf file (see Required configuration).
Check that the correct paths to the files passwd and access are specified in the
relevant parameters svn.passwd.file and svn.access.file
Note that you may need to reconfigure the htpasswd.path parameter and set it to
/usr/sbin/htpasswd2 if necessary (instead of the usual /usr/local/apache2/bin/htpasswd)
Check Apache's htpasswd utility path in the htpasswd.path parameter. Check that the port specified in the tomcat.ajp13-port parameter corresponds to
the port specified in the worker.worker1.port parameter of the workers.properties file.
Configuring Polarion
1. Execute commands from installation temporary directory to create new Subversion repository:
17
2. Import production data or demo data configuration. You cannot import both. You can execute both scripts only on fresh repository!
/etc/init.d/polarion init
or
/etc/init.d/polarion demo
Note: Parameters could be different on your OS. For example values of User and Group directives from httpd.conf: the value of Group in the standard Apache distribution is #-1 (which is the numerical group ID -1) can't be used. Use apache/apache as user and group instead.
Important
O nc e t he sc ri p t ( /etc/init.d/polarion
init ,
or
/etc/init.d/polarion demo )
ha s be e n ex ec u te d, i t is n o t po ss i b le t o i n st al l
de m o d at a w it ho u t de le ti n g t he S ub ve r si on r e p o si to r y i n
/srv/polarion/data/svn/repo .
18
On startup and on re-index operations, Polarion estimates and reports the amount of time the operation will take. You will see this estimate in the console and log file on subsequent startups, but the first time, no data exists on which to base the estimate. The following startup phases are reported in the console and log file:
Platform startup Context recognition Context initialization Revisions processing Build artifacts recognition BIR inspection Data indexing Polarion startup
19
Before you change the password on the default system administrator account, you may wish to create another account with administrator rights for yourself and/or someone else.
20
Utility syntax: htpasswd path\passwdfilename username Example: htpasswd /opt/polarion/data/svn/passwd polarion 3. Next, change the value of the password property in the polarion.properties file to the password you set with the htpasswd utility. Typical location of this file is /opt/polarion/etc/polarion.properties.
21
2. If the access and passwd files are accessible from the file system where Polarion is installed, change properties svn.access.file and svn.passwd.file property so they contain the proper paths to these files. 3. If the access and passwd files are not accessible from the file system where Polarion is installed, the set this property as shown: com.polarion.platform.persistence.IAuthSrcPermissionService.allowed=false and leave both svn.access.file and svn.passwd.file pointing to the default paths. (If you want to remove the bundled SVN data, copy these two files and change the paths accordingly.) Note that the Access Management topic in Polarions administration will be accessible but meaningless because the path to the real access file in use is missing. So creation of new users and editing existing user accounts must be done manually by the repository administrator. (Polarion plans to address this issue in a future release.)
22
In all cases, after reconfiguring Polarion to use a custom SVN repository, you need to re-index repository by executing the [polarion]/bin/polarion.init script with the reindex parameter ([polarion]/bin/polarion.init reindex).
[polarion]/bundled/apache/conf/extra/polarionSVN.conf
and remove [polarion]/data/svn.
http://localhost/polarion/
On your first login after installation, you can login with the default system administrator credentials:
23
LDAP authorization
In a new installation, users are authorized using the Subversion integrated policy access functions (directives AuthzSVNAccessFile and AuthUserFile in polarionSVN.conf file). If you have LDAP infrastructure, you can make Polarion authorize users against the LDAP database. Information on performing this configuration, together with some examples, is provided in the
polarionSVN.conf configuration file. The file is located on one of the following paths,
depending on your Linux distribution:
/etc/apache2/conf.d /etc/httpd/conf.d
After modifying the configuration file, the Apache server must be restarted to reflect the changes. For more information about the Apache LDAP modules and their capabilities, visit these web pages: http://httpd.apache.org/docs/2.2/mod/mod_authnz_ldap.html and http://httpd.apache.org/docs/2.2/mod/mod_ldap.html. You can find information on configuring Polarion to work with LDAP in the Polarion Help topic Administrators Guide: User Management: Integrating Polarion ALM Server with LDAP/Active Directory.
Uninstalling Polarion
An automated uninstaller script uninstall.sh is provided for Linux platforms.
Warning!
Polarions Subversion repository is stored in the /opt/polarion folder. Be sure this repository does not contain production data that must be preserved! If it does, be sure to make a backup before uninstalling Polarion.
Remove the /var/log/polarion folder and /var/run/polarion.pid. Polarion should then be uninstalled.
24
25
APPENDIX
Default Users and Groups
The following table shows the default users and groups used for Apache under different Linux versions. OS
RedHat (CentOS) Debian Ubuntu Server SUSE
User
apache www-data www-data wwwrun
Group
apache www-data www-data www
Passwd utility
htpasswd htpasswd htpasswd htpasswd2
26
Action
Import from Word Word Round-trip Export, Re-import Excel export Word export
Extension
DOCX XLS
Data format
DOCX
2003
2010
SUPPORTED SUPPORTED
UNSUPPORTED1 SUPPORTED
CONDITIONAL
UNSUPPORTED
NOTES: 1. Unsupported, but may possibly work with the Microsoft Office Compatibility Pack (http://support.microsoft.com/kb/924074). Polarion has not tested it,so it is officially unsupported. 2. Supported prior to the January, 2010 update of Microsoft Office. Versions of Word 2007 that are distributed by Microsoft after January 10, 2010, no longer read the custom XML markup that may be contained within .docx, .docm, .dotx, .dotm or .xml files. The new versions of Word 2007 or the updated version of Word 2003 can still open these files, but any custom XML markup is removed. See http://support.microsoft.com/kb/978951. If your pre-2011 projects contain Word LiveDoc documents, it is recommended to migrate the Work Items in them to the new 2011 Live Document format. Information is provided in online Help.
27