Description

This module provides an environment validation tool that helps determine whether a server is suitable for hosting the Alfresco open source CMS.

The tool is distributed as an archive (zip) file that contains executable scripts that will run the tool. The tool itself is implemented as a Java (JVM 1.4+) command line application.

Please note that this tool is not exhaustive - it simply validates some of the more common environmental problems Alfresco has seen. Administrators intending to install Alfresco should ensure they have fully validated that their environment is on the Alfresco Supported Stack. They should also ensure they have reviewed, understood and applied the various installation related information available from the Alfresco Support Portal, the Alfresco Wiki and official product documentation.

After completing environment validation, but prior to installation, administrators should also review the Alfresco Day Zero Configuration Guide, to ensure they are able to complete basic configuration of Alfresco immediately following installation.

Pre-requisites

JVM 1.4+ (note: some JDBC drivers require JDK 1.5+)

Running the Tool

usage: evt[.sh|.cmd] [-?|--help] [-v] [-V|-vv]
            -t databaseType -h databaseHost [-r databasePort]
            [-d databaseName] -l databaseLogin [-p databasePassword]

where:      -?|--help        - display this help
            -v               - produce verbose output
            -V|-vv           - produce super-verbose output (stack traces)
            databaseType     - the type of database.  May be one of:
                               mysql, postgresql, oracle, mssqlserver, db2
            databaseHost     - the hostname of the database server
            databasePort     - the port the database is listening on (optional -
                               defaults to default for the database type)
            databaseName     - the name of the Alfresco database (optional -
                               defaults to 'alfresco')
            databaseLogin    - the login Alfresco will use to connect to the
                               database
            databasePassword - the password for that user (optional)

The tool must be run as the OS user that Alfresco will run as. In particular it will report misleading results if run as "root" (or equivalent on other OSes) if Alfresco is not intended to be run as that user.

Licensing

The Alfresco Environment Validation Tool is licensed under the GNU Public License, Version 2 (GPL v2) with the following exceptions that are licensed separately by their respective parties:

• Hyperic SIGAR API, released under the GNU Public License, Version 2 (GPL v2) - see gpl-2.0.txt

Source code for Hyperic SIGAR is available from https://github.com/hyperic/sigar

• MySQL Connector/J JDBC driver, released under the GNU Public License, Version 2 (GPL v2) - see gpl-2.0.txt

Source code for the MySQL Connector/J JDBC driver is available from http://dev.mysql.com/downloads/connector/j/

• PostgreSQL JDBC driver, released under the BSD License - see http://jdbc.postgresql.org/license.html

• jTDS JDBC driver, released under the GNU Lesser Public License Version 3 (LGPL v3) - see lgpl-3.0.txt

Source code for the jTDS JDBC driver is available from http://sourceforge.net/projects/jtds/files/jtds/1.2.4/

• Oracle JDBC driver, released under the Oracle Technology Network License Agreement - see http://www.oracle.com/technetwork/licenses/distribution-license-152002.html

• DB2 JDBC driver, released under the IBM International Program License Agreement - see http://www14.software.ibm.com/cgi-bin/weblap/lap.pl?la_formnum=&li_formnum=L-SRAN-7PW37R&title=IBM+Data+Server+Driver+for+JDBC+and+SQLJ+(JCC+Driver)&l=en

Source code for the Alfresco Environment Validation Tool itself is available from http://code.google.com/p/alfresco-environment-validation/source/checkout