Thank you for choosing Clearspace! Clearspace is a team collaboration tool that combines discussions, blogs, documents and tags.

Important Note About This Release: Only the "Recommended" and "Certified" platform components `are supported for this release. Support for other components will be added in later releases.

Upgrading?

Are you upgrading your installation of Clearspace? If so, be sure to read the upgrade guide for each release.

Getting Started

By now you've downloaded and unpacked the Clearspace distribution. You're almost there! The few remaining steps depend on which Clearspace distribution you're using:

Using the Clearspace Installer Program (Windows Only)

If you're installing Clearspace for evaluation rather than production use, you can use the Windows installer. It installs Clearspace with the embedded application server (Jetty) and the evaluation database. It also installs Java for its own use.

Here are a few things you might want to be aware of as you use it:

  • Be sure to select the Show advanced options panel if you want to set the installation folder, jiveHome folder, server name, and server port number. If you don't set these options, the default values are:

    Clearspace

    • Installation folder: C:\Program Files\Clearspace 2.5
    • jiveHome folder: C:\Documents and Settings\LocalService\Local Settings\Application Data\Jive Software\Clearspace 2.5
    • Server name: <Default_machine_name>
    • Server port: 8080

    Clearspace Community

    • Installation folder: C:\Program Files\Clearspace Community 2.5
    • jiveHome folder: C:\Documents and Settings\LocalService\Local Settings\Application Data\Jive Software\Clearspace Community 2.5
    • Server name: <Default_machine_name>
    • Server port: 8080
  • If you click View License Agreement, then proceed through the wizard from that screen, you won't have an opportunity to set advanced options. So if you want to view the agreement and set advanced options, be sure to click Back in the license agreement screen, then select Show advanced options panel and click Next to proceed.

Finishing Installation and Starting

  1. Configure the Database (optional): If you use an external database you will need to put a JDBC driver in the application server's classpath. On the standalone server, this path is <installation_directory>/server/lib. You'll need to restart your application server for the driver to be registered. The application comes with an evaluation database if you don't have an external database or want to use the application quickly. Once the application is started you'll be prompted to enter a setup process. From there you can decide what database configuration to use.

    Note: Clearspace ships with schemas for eight databases. While the setup tool is designed to install the schema for the database you specify, you'll find scripts for installing the schema manually if you prefer. These scripts are located in the <installation_directory>/database directory. Installation documentation (per database) is available at the Clearspace resources page on the Jive Software web site.

  2. Run the Server: Clearspace is installed as a Windows service, called Clearspace 2.5 or Clearspace Community 2.5. You can control it using the Windows Services panel, or with our provided Clearspace 2.5 Manager. You will find the manager in your system tray (look for the Clearspace logo). If it is not running, you can launch it from the Start menu. From here, you can easily stop and start the server and check its current status.
  3. Open the URL: The final step is to open the application in your web browser. If you installed Clearspace as a Windows Service, you can open the application from the service manager by clicking View Site. If not, go to http://localhost:8080/clearspace/ for Clearspace and http://localhost:8080/clearspace_community/ for Clearspace Community.

The server will take about a minute to start up the first time. After that, it should only take a few seconds.

Installing & Running the Standalone Server

Use the standalone server if you're new to server-side Java installations or just want to get up and running as quickly as possible.

Setting Up from the Command Line (Windows, Unix)

  1. Verify Java 6 is Installed: On Windows, open a new command prompt (Start -> Run... -> Type "cmd" then ENTER). On Linux, open a terminal. At the prompt type "java -version" (without quotes).
    Windows
    C:\>java -version
    java version "1.6.0_10"
    Java(TM) 2 Runtime Environment, Standard Edition (build 1.6.0_10-b03)
    Java HotSpot(TM) Client VM (build 1.6.0_10-b03, mixed mode, sharing)
    Unix
    $ java -version
    java version "1.6.0_06"
    Java(TM) 2 Runtime Environment, Standard Edition (build 1.6.0_06-113)
    Java HotSpot(TM) Client VM (build 1.6.0_06-68, mixed mode, sharing)

    (Note, if you're repeating this step from #2 below, make sure you run the commands in a new command prompt.)

    If you see version information about your installed Java runtime then it is installed correctly. If you get an error, then follow the instructions in step 2, otherwise proceed to step 3.
  2. Install Java 6 (optional, might already be installed): Go to http://java.sun.com/javase/downloads/index.jsp to download Java 6. Look for "JDK 6 Update NN" where NN is an update version (ie, "JDK 6 Update 5"). Click the "Download" button to go to the next page.
    • For Windows, choose "Windows Offline Installation, Multi-language"
    • For Linux, choose the RPM or self-extracting file version
    • For Solaris, choose the right file for your system's architecture
    • If you have Windows or Linux on x64 architecture look at the bottom of the list for the right JDK
    Once you've downloaded the installation file for your platform, follow the installation instructions for your OS. When you're finished installation, repeat step 1 above.
  3. Configure the database. If you use an external database you will need to put a JDBC driver in the application server's classpath. On the standalone server, this path is <installation_directory>/server/lib. You'll need to restart your application server for the driver to be registered. The application comes with an evaluation database if you don't have an external database or want to use the application quickly. Once the application is started you'll be prompted to enter a setup process. From there you can decide what database configuration to use.

    Note: Clearspace ships with schemas for eight databases. You'll find scripts for installing the schema manually if you prefer. These scripts are located in the <installation_directory>/database directory. Installation documentation (per database) is available at the Clearspace resources page on the Jive Software web site.

  4. Run the Server: By default the standalone server is configured to run on port 8080, you can change this by editing [clearspace_distribution]/server/conf/server.xml and change Connector port="8080" to Connector port="xxxx" where xxxx is your desired port number.
    • On Windows: execute "start-clearspace.bat" either by double clicking on it or by typing that at a command prompt.
    • On Unix: execute "start-clearspace.sh" from a terminal. To stop the server, run the corresponding "stop-clearspace.sh" file.
      • NOTE: on Unix, non-root users cannot bind to ports below 1024. If you do need to deploy Clearspace on port 80, you can find instructions here.
  5. Open the URL: The final step is to open the application in your web browser. Go to http://localhost:8080/clearspace/. Note: If you're installing the Clearspace Community edition the link will be http://localhost:8080/clearspace_community/.

The server will take about a minute to start up the first time. After that, it should only take a few seconds.

Installing & Running the Pre-Packaged Web Application

Use the pre-packaged web application if you already have a Java application server. It is also assumed that Java is installed and configured correctly.

  1. Setup the jiveHome Directory: Clearspace stores its configuration and other local settings in the jiveHome directory. This is stored in the root of the distribution. Copy this file somewhere outside of your application server. A good idea would be to put this as a sibling to your appserver installation directory.
  2. Set the Path to jiveHome: The Clearspace application needs to know the path to the jiveHome directory you just created. There are many ways to do this but the easiest method is to use the Clearspace setup tool to set the value. After you deploy the web application (detailed below) and start the setup tool you'll be prompted for the jiveHome location, enter the full path to the jiveHome directory.
  3. Deploy Application to Appserver: Clearspace comes packaged as a standard J2EE WAR file. Follow directions on your appserver to deploy this package. Most application servers allow you to copy the war file to a "webapps" directory.
  4. Configure the Database: If you use an external database you will need to put a JDBC driver in the application server's classpath. You'll need to restart your application server for the driver to be registered. The application comes with an evaluation database if you don't have an external database or want to use the application quickly. Once the application is started you'll be prompted to enter a setup process. From there you can decide what database configuration to use.

    Note: Clearspace ships with schemas for eight databases. While the setup tool is designed to install the schema for the database you specify, you'll find scripts for installing the schema manually if you prefer. These scripts are located in the <installation_directory>/database directory. Installation documentation (per database) is available at the Clearspace resources page on the Jive Software web site.

  5. Start Your Appserver: Start your appserver normally -- during this process the Clearspace application will be deployed.
  6. Open the URL: The final step is to open the application in your web browser. The URL, port number, and path all depend on how your application server deployed the Clearspace application. Oftentimes, the URL will be: http://localhost:8080/clearspace/. Note: If you're installing the Clearspace Community edition the link will be http://localhost:8080/clearspace_community/.

Documentation

Clearspace comes with guides for installation, administration and info for developers. To read this documentation, view the Clearspace docs online.

Submitting Feedback

We'd love to hear your feedback. To get started, please visit the Clearspace feedback page on our website.

Known Issues

License Agreement

By using this software, you agree to the terms of the included evaluation license or the commercial license you agreed to when purchasing the software.

Click to read full license

SOFTWARE EVALUATION LICENSE AGREEMENT

JIVE SOFTWARE IS WILLING TO LICENSE THIS SOFTWARE AND ACCOMPANYING DOCUMENTATION FOR EVALUATION PURPOSES UPON THE CONDITION THAT YOU ACCEPT ALL OF THE TERMS OF THIS EVALUATION LICENSE AGREEMENT. PLEASE READ THESE TERMS CAREFULLY BEFORE INSTALLING OR USING THE SOFTWARE. BY INSTALLING OR USING THE SOFTWARE, YOU ARE CONSENTING TO BE BOUND BY AND ARE BECOMING A PARTY TO THIS AGREEMENT.

1. Software: The licensed Software ("Software") includes any software owned and distributed by Jive Software.

2. Grant of License: Jive Software grants to Evaluator, during the 30-day period (the "Evaluation Period") following the execution of this Agreement (the "Agreement"), the nontransferable, nonexclusive license to use one (1) copy of the Software on one (1) computer for the sole purpose of internal evaluation and testing for suitability for purchase by Evaluator only. Title to the Software shall remain with Jive Software at all times.

3. Exclusions: Evaluator shall not:

a. copy any part of the Software except to make one copy for back-up purposes;

b. reverse compile or reverse assemble any portion of the Software;

c. distribute, disclose, market, rent, lease, or transfer the Software;

d. export the Software;

e. disclose benchmarks or other comparisons of the Software without Jive Software's prior written consent;

f. disclose any confidential information provided by Jive Software;

g. modify the Software;

h. allow others to make or obtain copies of the Software; or

i. use the Software for production purposes. Use of the Software for production purposes constitutes an agreement to purchase the Software at Jive Software's list price in accordance with Jive Software's standard customer license.

4. Support: Jive Software may during the Evaluation Period make available updates, enhancements, and/or modifications to the Software and may provide such updates to Evaluator, but is under no obligation to do so. The provision by Jive Software to Evaluator of such updates, enhancements, and/or modifications to the Software shall be subject to all terms and conditions of this Agreement and shall expire at the end of the Evaluation Period.

5. Specific Disclaimer of Warranty and Limitation of Liability: THE SOFTWARE IS PROVIDED WITHOUT WARRANTY OF ANY KIND. JIVE SOFTWARE DISCLAIMS ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. JIVE SOFTWARE WILL NOT BE LIABLE FOR ANY DAMAGES ASSOCIATED WITH THE SOFTWARE, INCLUDING WITHOUT LIMITATION ORDINARY, INCIDENTAL, INDIRECT, OR CONSEQUENTIAL DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO DAMAGES RELATING TO LOST DATA OR LOST PROFITS, EVEN IF JIVE SOFTWARE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

6. Termination: Evaluator's license to use the Software shall terminate on the earlier of (i) written notice by either Jive Software or Evaluator, or (ii) expiration of the Evaluation Period. Upon termination of the license as provided above, Evaluator shall promptly destroy the Software and any back-up copy of the Software made during the Evaluation Period. Evaluator shall also promptly return all materials provided by Jive Software in connection with the Software.

7. Governing Law: This Agreement shall be governed by the laws of the State of Portland, OR, U.S.A. If either party employs attorneys to enforce any rights arising out of or relating to this Agreement, the prevailing party shall be entitled to recover reasonable attorney's fees. The parties consent to the jurisdiction of the California courts.

8. Assignment: This Agreement is not assignable or transferable by either party.

9. Entire Agreement: This Agreement constitutes the entire agreement between the parties concerning Evaluator's use of the Software. This Agreement supersedes any prior verbal understanding between the parties and any Evaluator purchase order or other ordering document, regardless of whether such document is received by Jive Software before or after execution of this Agreement. This Agreement may be amended only in a writing signed by an authorized officer of Jive Software.

Credits

The Clearspace 2.0 development team included: Aaron "Strike like a Cobra" Johnson, Alex "Loudmouth" Wenckus, Alok "@#$$@#$ #$@$@# Man" Singh, Amy "These boots are made for walkin'" Stewart, AJ "Bar Fight" Wright, Aron "The Optimizer" Racho, Bruce "MySQL" Ritchie, Daniel "Go Heels!" Henninger, Dolan "Dynohub" Halbrook, Erik "Wookie Defense" Onnen, Francisco "Coppola" Vives, Gabriel "Tractor" Guardincerri, Gaston "Leopard" Dombiak, James "I love ferrets" Lee, Jared "<script>alert('wfh!');</script>" Stanbrough, Jody "Trashtalk" Smith, Jon "Scruffy" Garrison, Lisa "Tea Snob" Farley, Marinus "Johnnie Cochran" Damm, Marty "Sugar Daddy" Kagan, Megan "Gas Guzzler" Chinburg, Nebiyu "Morpheus" Yohannes, Nick "Calorie Counter" Hill, Pablo "Honey" Zanetti, Pete "Stick it to the man" Matern, Ryan "I love Quickstart" Vanderzanden, Stan "Eye of the Tiger" Burnitt, Steve "Supposably" Traut, Todd "Sauerkraut" McCullough

Copyright © Jive Software, 1999-2008