COmanage Registry is a very flexible tool. With this flexibility comes complexity. This installation guide was created to provide resources to guide you in the early days of your Registry journey. Along with the "Getting Started" guide, we provide links to resources, a set of use cases that you can use as a starting point, and information about where you can find help and support.

On this Page


1.  Getting Started with Registry

1.1. Deploying Registry

If you are new to COmanage Registry and deploying it for the first time, you're in the right place.

COmanage Registry can be deployed directly into a web server (e.g. Apache HTTP Server) configured with PHP or can be deployed using a container image (e.g. Docker or Kubernetes). Detailed instructions can be found at:


Already have Registry installed?
See the Maintenance section for information about upgrading registry.

1.2. Testing Your Installation

To test open a web browser and browse to 

https://yourserver.org/registry 

(or wherever you mounted the registry for your web server). You should see the page "Welcome to COmanage" and a link to "Login". Click on the link and you should be prompted to authenticate using whichever mechanism you configured. After properly authenticating you should see the COmanage Registry dashboard.

1.3. Using the Registry

Now that you have installed COmanage Registry, it is time to use it! The COmanage wiki provides details about the features of the tool. We suggest you start by setting up your first CO (Collaborative Organization).

2. Special Considerations

For some use cases you may have a need for high availability or have a particularly large deployment (> 10,000 records). For these needs, we suggest referencing the DevOps section of the wiki.

3. Planning Resources

Links to resources that will be helpful as you plan your deployment.

  • Page:
    Release History — A list of all released versions of COmanage including the release version, date of release, highlights of what is included in the release, a commit identifier, and links to documentation, details and announcements about the release and its features.

4.  Help & Support

There are many community resources that can be helpful if you get stuck. We encourage you to check out the COmanage Community page for more details.

5.  Use Cases

In this section we have compiled a set of use cases that can be helpful as you plan your deployment. These use cases follow three broad models:

5.1. Virtual Organizations

Virtual organizations usually consist of individuals from different organizations that are working together for a specific purpose. This may be a project, collaborative effort, or 

There is no content with the specified labels

5.2. Enterprise Uses

A growing number of institutions are using COmanage as the primary registry for their populations and their lifecycle management.

There is no content with the specified labels

5.3. Guest Systems

Guest populations are often helpful to manage separately from your overall institutional population. COmanage Registry is a popular choice for guest management system.

There is no content with the specified labels



  • No labels