Clearspace 1.10.18 Documentation

Be sure to visit the Jive Software web site for additional information about Clearspace. You'll find the documentation included here falls into the following three groups:

• Content on installing, setting up, and configuring Clearspace.
• Content intended for end users.
• Content for developers writing plugins, macros, web services, and the like.

Installation, Setup & Configuration

Recommended Environments for Clearspace Deployments

Describes the best configurations for deployment both Clearspace and Clearspace X.

• General Requirements
  • Internal Deployments (Clearspace)
  • External Deployments (Clearspace X)
• Example JVM Settings
• Network Topology
• Example Hardware

Clearspace Installation Guide

Installation requirements, database information, setup & initial administration.

• Installation Overview
• System Requirements
• Files in the Distributions
• Java Setup
• Database Setup
  
  
  • MySQL
  • Oracle
  • SQL Server
  • PostgreSQL
  • DB2
  • HSQLDB
• Application Server Setup
  
  
  • Generic Server Information
  • Apache Tomcat
  • BEA WebLogic Server
  • Caucho Resin Server
  • IBM WebSphere Application Server
  • JBoss Application Server
  • Jetty Server
  • Oracle Application Server
  • Orion Application Server
  • Sun GlassFish Application Server
• Setting the jiveHome Directory

Fine-Tuning Clearspace Performance

Be sure to read this to get the best performance out of your Clearspace instance.

• Adjusting Caching
• Adjusting Java Virtual Machine (JVM) Settings
• Other Ways to Tune

Clearspace Administrators' Guide

Information on managing content, users, and Clearspace collaboration features.

• Before You Get Started
• Setting Up Clearspace
• Clearspace Basics
  
  
  • Content
  • Users and Groups
  • Profiles
  • Tags
  • Spaces

Designing Pages with Widgets

Describes how you can use Clearspace widgets to design the overview pages for spaces in your Clearspace instance.

Clearspace LDAP and Active Directory Guide

Instructions on how to configure Clearspace to integrate with an LDAP or Active Directory repository.

• Overview
• Configuring for LDAP During Setup
• Getting Debug Messages
• Setting a Custom Initial Context Factory
• Disabling Connection Pooling

Clearspace Clustering Information

An overview of clustering support in Clearspace, along with setup information.

• Cluster Architecture
• Setting Up a Cluster
• Clustering FAQ

Clearspace Upgrade and Migration Guide

Instructions on how to upgrade your Clearspace installation from older versions of Clearspace. Also describes how to migrate data from other Jive products.

• Upgrading from the Standalone Distribution to the Installer Distribution
• Upgrading the Standalone Distribution
• Upgrading the WAR Installation
• Upgrading the Source Build
• Migrating from Other Jive Products
• Back Up Your jiveHome Directory
• Back Up Your Database
• Clearspace Upgrade Philosophy
• Known Issues

For Users

Quick Tour

Take a stroll around Clearspace.

Clearspace Help

Answers to questions on how to get things done in Clearspace.

For Developers

Be sure to check out Jivespace, Jive's developer community, for the latest samples and content, including discussions, documentation, and blogs.

Building Clearspace from Source

Information on setting up your development environment to build Clearspace.

Clearspace Theming Guide

Customizing the Clearspace UI.

Clearspace Plugin Development Guide

Information for developing plugins for Clearspace.

Tutorial: Simple Clearspace Action Plugin

Write a simple plugin to learn about the action plugin framework.

Developing Macros

Information for developing macros in Clearspace.

Tutorial: Simple Clearspace Macro

Get started building macros with this simple example.

Tutorial: Simple Clearspace Widget

A tutorial on building components for customizing Clearspace space overviews.

Developing Filters

Information for developing filters in Clearspace.

UI Integration Points For Plugins

Describes integration points between plugins and the clearspace user interface.

Community Everywhere

Provide access to Clearspace discussions from within your own web pages.

Clearspace Web Services Development Guide

Information about web services in Clearspace and how to develop using them.

Building Web Services as a Plugin

Information about writing custom web services as a plugin.

Working with Clearspace Feeds

The basics of the feeds (RSS, Atom, and JSON) provided by Clearspace, including a list of the available feeds.

Database Schema Guide

Database table/column descriptions.

Providing Custom Support for Authentication and User Data Stores

Use your own database for authentication and user data.

Internationalization (i18n)

How to localize your Clearspace installation.

Core Javadocs

Web Services Javadocs