Clearspace documentation includes content on installing, administering, and using Clearspace.

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

For the latest developer content and answers to development questions, visit the Developers guide on Jivespace.

Installing and Upgrading

Recommended Environments for Clearspace Deployments

Clearspace runs best on recommended hardware and environmental configurations. Use this document as a starting place for estimating what you'll need to support your deployment.

Installation Guide

Look here for information on installation steps, including for each of the components you'll need.

Upgrade and Migration Guide

You can upgrade to this version of Clearspace with these guidelines for each distribution.

LDAP and Active Directory Guide

When you have your own LDAP or Active Directory repository, you can configure Clearspace to integrate with it.

Clustering Support

This guide describes the clustering model through which Clearspace run over a group of servers.

 

Administering the Site

System Administrators' Guide

If you're a system administrator, use this guide to set up and configure Clearspace using the admin console.

Fine-Tuning Clearspace Performance

Through adjustments to caches, JVM settings, and more, you can make sure that Clearspace is performing well.

Customizing UI the Basic Way

Through a simple user interface, you can change the site-wide logo and colors. This guide describes the basic, point-and-click way to customize the site's user interface.

Customizing UI with the Theme Resource Kit

If you need to add sophisticated view logic in your header or footer, you can do more ambitious site-wide theming by starting with the Clearspace resource kit. It includes a set of sample files you can tailor to your needs.

Advanced Theming Topics

Developers can build advanced themes that add or change CSS classes, map to specific parts of the UI, and change the structure of pages.

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.

System Properties Reference

System properties configure Clearspace with application-wide settings. Some of the settings correspond to configuration elements in the admin console user interface.

   

Managing Communities

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.

Moderating Content

Someone assigned as a space's moderator can edit, approve or reject content before the content is published and visible to others.

Developing Extensions

Clearspace Architecture

This high-level overview of Clearspace technologies provides links to more information about the pieces themselves.

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.

Authentication and Authorization

Clearspace has multiple facilities to handle the three primary facets of network application security. This section will discuss each and highlight APIs commonly of interest to developers customizing Clearspace installations.

Building Plugins

By building plugins, you can add new features to Clearspace. This includes new widgets and other UI features, as well as back-end components such as web services or custom authentication providers.

Building Actions

You can build plugins that enhance Clearspace with links to new functionality, additions to the admin console, and additions to the end user UI.

Building Widgets

This introduction gives you the basics on building widgets -- views for displaying content on customizable Clearspace pages.

Accessing the Database from a Plugin

You can add tables needed by your plugin to the Clearspace database. You do this by including a schema.xml file that describes the schema of your additions and by defining a Spring bean that represents access to the data from your Java code.

Working with Clearspace Feeds

Use this guide to learn about the feeds (RSS and Atom) that Clearspace makes available.

REST Web Services Reference

This document list the web services that Clearspace exposes via REST, or Representational State Transfer.

SOAP Web Services Development Guide

If you're looking to use SOAP-style web services to access Clearspace, this basic information can get you started.

Integrating Plugin UI

You can integrate your plugins into the Clearspace user interface by overriding and adding to the UI components that Clearspace defines by default. For instance, you can add a new tab to a space's main page, add a new "Action" link to user profiles, and add a new menu to the user bar (that navigation bar at the top of Clearspace pages).

Localizing Clearspace

Use this guide to learn about how to localize your Clearspace installation.

Database Schema Guide

This document describes tables in the Clearspace database.

Upgrading Extensions to Version 2

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

Plugin XML Reference

This reference describes the elements and attributes that make up a plugin's configuration XML file.

UI Components XML Reference

This reference describes the elements and attributes through which you can can UI components to Clearspace. You use the elements described here in a plugin.xml file.

Core Javadocs

 

Using Clearspace

Quick Tour

Use this tour to get a step-by-step view of some of the things you can do with Clearspace.

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.

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: