This document describes how to install Clearspace, a team collaboration tool that combines discussions, blogs, wiki documents and tags.
Clearspace Distributions: Clearspace is downloadable in three distributions. For more information, see Files in the Distributions.
This document includes the following sections:
Installation Overview— A high-level view of the installation steps.
System Requirements— Describes the technologies that Clearspace needs and supports.
Files in the Distributions— A list of what's included in the distribution.
Java Setup— Setting up Java if you're using the standalone application server.
Database Setup— Setting up a database to support Clearspace.
Application Server Setup— How to set up your application server to support Clearspace.
Setting the jiveHome Directory— Finding a good location for the jiveHome directory.
Here's a high level view of installing Clearspace.
After you finish installing Clearspace and start the server, use its web-based setup tool to establish a database connection and to set up the administrator account. Clearspace will display the setup tool the first time you navigate to Clearspace using a web browser. The URL you use will vary depending on the application server technology you're using. By default for a local installation with the included server (standalone or installer distribution), the URL will be http://localhost:8080/clearspace. You'll find more information about the setup tool in the Clearspace Administrators' Guide.
After you complete the setup tool, use the admin console to begin configuring your Clearspace installation.
Clearspace requires a Java application server and a database, as described in the following recommendations. The following lists supported technologies and recommended system configuration. The following table lists the platform components supported by Jive Software for Clearspace. The components are divided into three configurations indicating level of reliability, stability, and support:
Note: Be sure also to read Fine-Tuning Clearspace Performance for tips on making the most of your configuration.
|
|
OS | JDK | Application Server | Database | AAA |
|---|---|---|---|---|---|
| Recommended | Linux (2.6 Kernel) | Sun Java 6 (Latest JDK 1.6) | Apache Tomcat 6.0.10 (or later in 6.0.x series) | Postgres 8.x | LDAP or AD |
|
Certified |
Windows Server 2003 SP2 Linux (2.6 Kernel) Solaris 10 |
Sun Java 6 (JDK 1.6) with latest patches IBM Java 6 (JDK 1.6) with latest patches |
LDAP or AD |
||
|
Supported |
Windows Server 2003 SP2 Linux (2.6 Kernel) Solaris 10 |
Sun Java 5 (JDK 1.5) with latest patches IBM Java 5 (JDK 1.5) with latest patches |
LDAP or AD |
Additional Recommendations
When you run a server-side application, you should also have a daily backup solution. At a minimum you should back up your database on a regular basis as well as the configuration files for Clearspace (note: those are stored in one directory).
The files in your distribution will differ depending on whether you downloaded the installer (Windows only), standalone distribution or WAR distribution. Among the things you'll find in all three distributions are:
These include an application server. The installer distribution requires the least amount of installation effort and is a great choice for evaluating Clearspace. For the quickest installation (such as for evaluation), use the included application server and evaluation database. With the standalone distribution, included app server and evaluation database, installation is complete when you extract the distribution's contents as shown in the hierarchy below.
If you're going to be using a separate database technology (rather than the evaluation database), see Database Setup for further installation instructions.
To start Clearspace:
jive_clearspace_<dist>_x_x_x/ |- database/ |- jiveHome/ |-
server/ |- webservices/ |- README.html |- start-clearspace.bat |-
start-clearspace.sh |- stop-clearspace.bat |- stop-clearspace.sh
The WAR distribution does not include an application server. This distribution is intended for deployment on the application server of your choice. Clearspace supports several app server technologies as describes in the System Requirements.
The clearspace.war file is a standard Web Application Archive (WAR) that contains the Clearspace application.
jive_clearspace_war_x_x_x/ |- database/ |- jiveHome/ |- webservices/ |-
clearspace.war |- EditWAR.jar |- README.html
Clearspace requires a valid Java installation and a JAVA_HOME environment variable set. If you already have an application server installed then you already have Java installed and working properly. You'll need to go through the following steps if you're using the standalone distribution. The installer installs Java for you.
You can install Java so that it will be found system-wide, or you can install it so that it will be found by the standalone distribution.
Clearspace stores data about users, documents, spaces, and so on in a database. While the setup tool is designed to install the schema for the database you specify, these instructions are for when you might want or need to install the schema manually.
You can use either your own database (Clearspace supports several of the most common) or the evaluation database that's included with the Clearspace distribution. When you're setting up Clearspace with its setup tool, you'll be prompted for information about the data source you want to connect to — in other words, it's a good idea to make your database decision before using the Clearspace setup tool.
All three distributions include an evaluation database, but you should use a separate database for production deployment. If you're using the evaluation database, you can skip to Application Server Setup.
If you're using a separate database technology, you should set it up before you set up your application server. You will need to create a database from schema and ensure that the application server you're using includes JDBC drivers for the database. You can find schemas in the distribution's database directory. View the Database Setup to learn how to install the schemas and JDBC drivers.
JNDI Settings: The Clearspace setup tool provides a mechanism for configuring your data source connection, however, you can also configure this connection via your application server's JNDI settings.
Note: The evaluation database Clearspace provides is suitable for evaluation and testing, but you shouldn't use it for deployment. If you want to use the evaluation database, simply select the "Evaluation Database" option when running through the Clearspace setup tool. For more information on the setup tool, see the Clearspace Administrators' Guide.
This guide includes setup guidelines for the following database technologies:
Clearspace Schemas. If you use your own database, you'll need to create a new database using the database schema appropriate to your database technology before using the Clearspace setup tool. You'll find schemas for nine database technologies in the database directory just beneath the root of the Clearspace distribution.
Required JDBC Drivers. You'll need to put a JDBC driver for your database technology in the application server's classpath. Your database's setup documentation should include information on how to install the schemas and required JDBC drivers. The installer and standalone distributions of Clearspace include a standalone application server; if you use this server the path is for installing the JDBC driver is <installation_directory>/server/shared/lib. You'll need to restart your application server for the driver to be registered. For more information about setup instructions specific to certain application servers, see Application Server Setup.
Note: If you need to re-run the setup tool, open the jiveHome/setup.xml file, find the line <setup>true</setup>, and change the true value to false. Restart your application server, point your browser at http://localhost:8080/clearspace
MySQL does not have proper Unicode support, which makes supporting postings in non-Western languages difficult. However, the MySQL JDBC driver has a workaround which you can enable by adding <mysql><useUnicode>true</useUnicode></mysql> to the <database> section of your jive_startup.xml file. When using this setting, you should also set the Jive character encoding to utf-8 in the Admin Console.
MySQL 4.1 introduced better support for character encodings than previous versions. This functionality assigns a default character encoding to the database and its tables and columns. It's best to set the default character encoding for your database before installing the Jive schema so that you can be sure that you will not have encoding problems in the future. After creating your database, execute the following line in the MySQL console:
ALTER DATABASE <database name> DEFAULT
CHARACTER SET <character set>;
For example, if you plan on using UTF-8 in Clearspace, you should enable the JDBC driver workaround mentioned above and then execute this line in the MySQL console:
ALTER DATABASE <database name> DEFAULT
CHARACTER SET utf8;
You can fix the max attachment size problem on a MySQL server by following the directions here:
http://dev.mysql.com/doc/refman/5.0/en/packet-too-large.html
The easiest way to change the MySQL server setting on Windows is to add a line to your my.ini file (you'll find this file in a location such as C:\database\mysql\5.0.19); on Linux, look for the my.cnf file instead. Add the following line after the [mysqld] section heading:
max_allowed_packet = 500M
After you add the line, restart MySQL.
Use the following values in the Clearspace setup tool:
CREATE USER clearspace IDENTIFIED BY clearspace;
GRANT CONNECT, RESOURCE TO clearspace;
sqlplus clearspace/clearspace @
jive_clearspace_oracle.sql
For most users, the best drivers for Oracle are the ones written by Oracle (which come with the database or can be downloaded from Oracle's website). Jive Software recommends using the "thin" drivers.
Please consult the Oracle documentation to decide which version of the JDBC thin driver is best for you. Typically, the drivers are in "classes12.zip" or "classes12.jar". Do not use the classes11.zip JDBC driver. If you use the ZIP file you may wish to rename the classes12.zip file to classes12.jar or oracle.jar because some application servers will not work correctly with ZIP files.
Use the following values in the Clearspace setup tool:
createuser \-W
createdb \--encoding=UNICODE dbname
local all all trust host all all 127.0.0.1
255.255.255.255 trust host all all your.ip.address 255.255.255.255
trust
Note, this is a pretty open configuration. Please consult your system administrator for the best access configuration.
psql \-U user_you_created \-W \-d dbname
\i /path/to/jive/schema/file.sql
JDBC Driver for PostgreSQL can be found in various distribution packages at PostgreSQL's Home Page. Refer to the JDBC documentation at that site for the latest driver and for more information.
Use the following values in the Clearspace setup tool:
You'll need to create a new database with a name limit of eight characters, or use an existing database. Connect to the database using any valid user name allowed to create tables and indexes. Keep in mind that DB2 UDB applies the user name as the table schema. Use the same user when you configure Clearspace with the administration interface.
DB2 CREATE DB [DBNAME] ALIAS [DBALIAS] DB2 CONNECT TO jive USER [DBUSER] USING [DBPASSWORD]
db2 \-tvf jive_clearspace_db2.sql
By default, the maximum size for a BLOB in DB2 is 1MB; this limits the maximum attachment size in Clearspace to 1MB. The issue will be fixed in an upcoming release, but for now, the work around is to issue the following command against your Clearspace Database hosted by DB2. (This fix has been tested on DB2 9.1.)
ALTER TABLE jiveAttachData ALTER attachmentData SET DATA TYPE BLOB(2G)
For more details see forum thread: http://www.jivesoftware.com/jive/thread.jspa?messageID=115395 or issue tracker: http://www.jivesoftware.com/issues/browse/CS-1171
Use the JDBC 1.2 compliant driver, db2jcc.jar and valid db2jcc_license_cu.jar, located in the bin directory of your DB2 installation directory:
<DB2_INSTALL_DIR>\SQLLIB\BIN\db2jcc.jar, db2jcc_license_cu.jar
Use the following values in the Clearspace setup tool:
For SQL Server, Jive Software recommends using the open source jTDS Driver found here: http://jtds.sourceforge.net/
Use the following values in the Clearspace setup tool:
While Clearspace is a pure Java application, the application servers on which it can be deployed vary in how they support such applications. This document describes the application server-specific steps you might need to take in order to get your Clearspace installation fully deployed and running.
Note: If you're using the application server that's included in the installer and standalone distribution of Clearspace, you don't need this guide.
The server technologies covered here include:
When deploying the WAR distribution, if the server you are deploying Clearspace on is headless, you must set the Java system property java.awt.headless to "true". If you don't, certain portions of the application that use the Java AWT for generating images will not function properly.
Enable the JVM headless mode by setting the java.awt.headless flag to true, as in the following command line example:
-Djava.awt.headless=true
<!-- Uncomment to use jdk1.5 features in jsp pages-->
<init-param>
<param-name>compilerSourceVM</param-name>
<param-value>1.5</param-value>
</init-param>
unzip -d clearspace clearspace.warIssue: WebLogic is incompatible with certain Clearspace libraries out-of-the-box.
Workaround: Use JDK 1.5 and update the EXT_PRE_CLASSPATH with the JAR files described below.
You can update the path with a command such as the following:
export EXT_PRE_CLASSPATH="/path/to/commons-logging.jar:/path/to/wss4j.jar:/path/to/xmlsec-1.4.1.jar:/path/to/geronimo-ws-metadata.jar:/path/to/velocity-tools.jar
NOTE: WebSphere 6.1.0.15 or better is required for Rich Text Editor icon support.
Issue: WebSphere is incompatible with certain Clearspace libraries out-of-the-box.
Workaround: On WebSphere 6.1.0.15, locate aspectjrt.jar in the exploded instance of Clearspace (in its WEB-INF/lib directory). Copy the JAR in place of WebSphere's /lib/aspectjrt.jar. You'll also need the Apache Velocity tools. Download velocity-tools JAR from the Tools section of http://velocity.apache.org/download.cgi#Tools and copy it into the Clearspace WEB-INF/lib directory.
OC4J contains a version of the JAX-WS libraries that conflict with Clearspace. For Clearspace to deploy properly, a few rather intrusive changes must be made to OC4J to remove their JWX-WS libraries from loading.
mkdir /tmp/oc4j cd /tmp/oc4j jar xvf oc4j.jar
<code-source path="${oracle.home}/webservices/lib/jws-api.jar" if="java.specification.version == /1\.[5-6]/"/>
jar cvfm <OC4J_HOME>/j2ee/home/oc4j.jar META-INF/MANIFEST.MF *
References
http://cwiki.apache.org/CXF20DOC/appserverguide.html#AppServerGuide-OC4J
The Oracle JDBC driver packaged with Clearspace is older than Clearspace requires. Confirm that you have the 10.2 or newer JDBC driver. You can download the newer driver from http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/htdocs/jdbc_10201. html
If the driver is not updated there will be startup errors, and database behavior may not be as desired.
When deploying the Clearspace WAR file, this library should be configured in the classpath settings for the deployment descriptor. The next section will explain how to do this.
Reference
http://www.jivesoftware.com/issues/browse/CS-2730
The Clearspace WAR file will not deploy correctly with the default deployment plan for OC4J due to some conflicts with libraries inherited from Oracle. The deployment plan classpath must be customized to allow the WAR file to deploy.
References
http://www.jivesoftware.com/issues/browse/CS-2944
http://www.jivesoftware.com/community/thread/26035?tstart=0
The jiveHome directory contains configuration files, logs, data (for the evaluation database) and other items that Clearspace needs to run correctly. You need to set up your jiveHome directory in a permanent location. The directory must be readable and writable by your application server, but should not be in the document path of your webserver (such that someone could access the directory from a URL such as http://www.yourserver.com/jiveHome). Windows users might pick a directory such as c:\jiveHome while Unix users might install jiveHome to /opt/jiveHome.
Now that your jiveHome directory is set up, Clearspace will need to know its location. There are several ways to do this. Choosing one of the following options depends largely on how you want to register your value in your environment.
java -jar EditWAR.jar clearspace.war
The tool will then lead you through the process of updating the WAR.
java -DjiveHome=/usr/foo/jiveHome -cp .
com.myappserver.Server
Please consult your server documentation if you are not familiar with setting up web applications. Most servers give you a choice between deploying a web application by copying a WAR file into a certain directory (typically "webapps"), or by using a deploy tool. Use the method that you are most familiar with.