Clearspace documentation includes content on installing, administering, and using Clearspace. It also includes content on upgrading extensions; full information on developing extensions with version 2 will be available in a future release.

Be sure to visit the Jive Software web site for additional information about Clearspace.

Installation, Setup, and Configuration

Recommended Environments for Clearspace Deployments

This document outlines recommended hardware and environmental configurations for Clearspace and Clearspace Community deployments.

Installation Guide

This document describes how to install Clearspace, a team collaboration tool that combines discussions, blogs, wiki documents and tags.

Fine-Tuning Clearspace Performance

It's almost certain that you'll want to adjust Clearspace system settings from their defaults shortly after you're up and running. In particular, you'll want to keep an eye on caching, but there are other things you can do to ensure that the application is performing as well as possible. Here's a list of what's included:

System Administrators' Guide

If you're a system administrator, use this guide to set up and configure Clearspace using the admin console. This guide includes information about console features that are only available to system administrators.

Managing Spaces

If you're a space or system administrator, use this guide to learn about how to create and configure spaces, including setting up defaults for content and managing discussions and documents.

Managing Permissions

If you're a space or system administrator, use this guide to learn about granting permissions to people for access to content and administrative features.

Managing Users and Groups

If you're a system admin, user admin, or group admin, use this brief guide to learn how to use the admin console to add, remove, and edit accounts for users and groups. Note that this guide does not describe how to set permissions for users and groups. You can set permissions if you're a system or space admin, but not a user or group admin. For more on setting permissions, see Managing Permissions.

Moderating Content

If you're a system administrator, space administrator, or a space's content moderator, use this document to learn how to moderate content. This document covers moderation for discussions and documents (content related to blogs can only be moderated by their authors or a system administrator).

LDAP and Active Directory Guide

This document explains how to configure Clearspace to integrate with an LDAP or Active Directory repository. You'll find the following in this document:

Clustering Information

The clustering module allows Clearspace to work over a group of application servers, providing increased speed and fault-tolerance. Clusters are auto-configuring, have no single point of failure, and provide nearly linear scalability as additional servers are added.

Upgrade and Migration Guide

This document describes how to upgrade to the latest versions of Clearspace from previous versions of Clearspace. It also includes information on how to migrate from other Jive Software products, including Knowledge Base, Forums, and Integrated server.

For Developers

Upgrading Extensions to Version 2

Here's a run down of the changes you might need to make to get your Clearspace customizations working on version 2. This topic looks at upgrading actions, macros, widgets, themes, and web services (client and server components), and other customizations.

Theming Guide

The Clearspace user interface is designed to be easily customizable. Through small gestures, you can make changes large and small to the look and feel of your Clearspace instance.

REST Web Services Reference

This document list the web services that Clearspace exposes via REST, or Representational State Transfer. This guide includes the following sections:

Web Services Development Guide

Clearspace exposes a lot of its functionality as web services. This topic describes the technology on which those services are based and provides examples on how you can use the services. 

Using Community Everywhere

With Community Everywhere, you can embed discussion threads directly into existing news articles, blog posts or other content that would benefit from comments or discussions. Instead of forcing users to leave your content to create a comment or view a discussion thread, you use Community Everywhere to enable users to log in or create an account and participate in discussions while on the page that contains your content.

Database Schema Guide

This document outlines the data type conventions and tables in the Clearspace database schema. Some information, like column indexes and foreign keys, is omitted. For this, please read the individual schema of the database you're interested in. Data types may also differ somewhat in each individual database schema. See the Clearspace Installation Guide for more database-related information.

Tutorial: Simple Macro

This tutorial gives you the basics on how to build macros. A user adds a macro to content in order to do specific kinds of formatting, include particular kinds of content, and so on.

Tutorial: Simple Widget

In this tutorial you'll build a simple Hello World widget. Widgets are views for displaying content on customizable Clearspace pages.

Localizing Clearspace

This section describes how to localize your Clearspace installation. Internationalization is the process of changing the format of dates and numbers to obey rules unique to your region and translating user-interface text to your language. For example the number 1,234.00 is an English locale would be formatted as 1.234,00 in the locale for France. Similarily, user-interface text like "Your Name" in English would be translated to "Ihr Name" for German locales.

Core Javadocs

Web Services Javadocs

For Users

Quick Tour

Welcome to the Clearspace Tour! Use this tour to get a step-by-step view of some of the things you can do with Clearspace. As you read through the tour, it will point out features and suggest things you can do to start putting Clearspace to work for you and your team. Here are the steps:

Clearspace Help

Use this list of frequently asked questions to get help on how to do things in Clearspace. For a step-by-step tour of Clearspace, be sure to see the Clearspace Quick Tour.

Designing Pages with Widgets

You can easily get some of the pages in Clearspace to look the way you want to by using widgets to choose and arrange content. Each widget displays content of a particular kind — for example, HTML, recent documents in Clearspace, or feed subscription results — in a box that you can drag into position on a page. After you publish it, you can come back later to update its content or design.

Search Tips

Most of the time, you just want to find content that has a particular phrase. Here are the three easiest steps to get what you want:

Wiki Syntax Reference

Wiki is a special markup you can use to format content in the plain text editor for documents, blogs, and discussions. This guide lists ways you can apply the markup.