Web-based, open-source collections management software for museums and more ...
CollectionSpace is a web-based, open source collections management and information system for museums and other collecting institutions. You can use it to manage your museum's cataloging, acquisitions, loans, and many other activities.
If you're evaluating or implementing a CollectionSpace system, you can find readily navigable links to the currently available documentation in the left sidebar, as well as top-level links below.
- Release Notes
- System Requirements
- Using CollectionSpace
- Installing CollectionSpace
- Configuring CollectionSpace
- Maintaining CollectionSpace
- Upgrading CollectionSpace
- Migrating to CollectionSpace
- Developing for CollectionSpace
- Hosting CollectionSpace
- Reference Information
- Documentation Feedback
Changes you'll need to make when upgrading to version 4.1
As a result of work on CSPACE-6168, making it possible for multiple CollectionSpace instances to share a single database server (see New functionality: Hosting and Software as a Service (SaaS) support, below, for more details), there were several minor changes made to CollectionSpace-related environment variables. These variables are used when building CollectionSpace from source code, and when installing and running CollectionSpace servers.
If you will be upgrading an existing CollectionSpace system from version 4.0 or earlier, to version 4.1 or higher, please see Updating environment variables when migrating to CollectionSpace 4.1 or higher. It should typically take ten minutes or less to manually make these changes to environment variables.
These changes are also reflected in installation documentation, as well as incorporated in the automated installer for CollectionSpace 4.1. And if you haven't made one or more of the required changes, you'll be presented with specific error messages letting you know what you still need to change, each time that you run a Services layer build.
In System Requirements, you can find the system requirements for running a CollectionSpace system, as well as a list of supported web browsers for accessing your system.
If you are new to CollectionSpace, you can get a good sense of how it works from the demo available on the CollectionSpace website.
The User Manual describes how to use CollectionSpace 4.0's features to manage your collections. This manual also provides a useful overview of CollectionSpace's basic feature set.
You can find general server installation instructions that apply to all supported environments in Installing CollectionSpace, as well as detailed instructions for several specific platforms.
If you are an implementer or consultant, you can adapt CollectionSpace for the specific needs of your museum or client via the documentation in Configuring CollectionSpace.
This section focuses on configuration: changing the behavior and the look and feel of the system by making changes via web-based Administration pages and by editing text files: HTML templates, CSS stylesheets, XML- and JSON-based configuration files, and properties files.
Once you have your deployment up and running, you'll want to take care of it. In Maintaining CollectionSpace, you'll find both operational suggestions and troubleshooting techniques.
If you have an older version of CollectionSpace and want to upgrade it to a newer version, Upgrading CollectionSpace provides pertinent tips.
When you want to migrate your existing data into a CollectionSpace system, Migrating to CollectionSpace can help you do this.
If you are building or integrating applications or scripts that talk to CollectionSpace systems, or are a CollectionSpace software developer, integrator, or implementer who wishes to extend the system's capabilities by working with its source code, you can find documentation on these topics in Developing for CollectionSpace. This topic area includes details about CollectionSpace's Application Programming Interfaces (APIs).
Reference Information provides supporting information and requirements for CollectionSpace, and includes general documents that are referenced from across two or more of the topic areas above.
Many documentation additions and updates are planned. Please feel free to comment on the CollectionSpace project's Talk Mailing List if you have suggestions for improving current documentation, or if there is documentation you would like to see in the future.