This add-on is operated by GroupDocs

GroupDocs: a one-stop-shop for your document management requirements


Last Updated: 07 May 2015

The GroupDocs add-on is currently in beta.

Table of Contents

GroupDocs is an add-on for providing you with all necessary apps to efficiently perform your document management. You might have encountered different document management solutions offered as stand-alone products, but all document management apps under a single roof, no chance! Our legacy apps such as GroupDocs Viewer, GroupDocs Signature, GroupDocs Annotation, GroupDocs Assembly, GroupDocs Conversion, and GroupDocs Comparison lets you manage your documents quickly, easily, and efficiently.

GroupDocs is accessible via an API and has supported client libraries for PHP, Java, Ruby, Python, JS, .NET

Provisioning the add-on

GroupDocs can be attached to a Heroku application via the CLI:

A list of all plans available can be found here.

$ heroku addons:create groupdocs
-----> Adding groupdocs to sharp-mountain-4005... done, v18 (free)

Once GroupDocs has been added a GROUPDOCS_CID, GROUPDOCS_PKEY and GROUPDOCS_URL settings will be available in the app configuration and will contain the ClientID, PrivateKey and canonical URL used to access the newly provisioned GroupDocs service instance. This can be confirmed using the heroku config:get command.

$ heroku config:get GROUPDOCS_CID
$ heroku config:get GROUPDOCS_PKEY
$ heroku config:get GROUPDOCS_URL

After installing GroupDocs the application should be configured to fully integrate with the add-on.

Local setup

Environment setup

After provisioning the add-on it’s necessary to locally replicate the config vars so your development environment can operate against the service.

Though less portable it’s also possible to set local environment variables using for example export GROUPDOCS_CID=value.

Use Foreman to configure, run and manage process types specified in your app’s Procfile. Foreman reads configuration variables from an .env file. Use the following command to add the GROUPDOCS_CID, GROUPDOCS_PKEY and GROUPDOCS_URL values retrieved from heroku config to .env.

$ heroku config -s | grep GROUPDOCS_CID, GROUPDOCS_PKEY and GROUPDOCS_URL >> .env
$ more .env

Credentials and other sensitive configuration values should not be committed to source-control. In Git exclude the .env file with: echo .env >> .gitignore.

Service setup

GroupDocs can be installed for use in a local development environment. Typically this entails installing GroupDocs SDK package and pointing the GROUPDOCS_CID, GROUPDOCS_PKEY and GROUPDOCS_URL to this remote service.

If you have… Install with…
Mac OS X brew install X
Windows Link to some installer
Ubuntu Linux apt-get install X
Other Link to some raw package

Using with Rails 3.x

Ruby on Rails applications will need to add the following entry into their Gemfile specifying the GroupDocs client library.

gem 'groupdocs'

Update application dependencies with bundler.

$ bundle install

Full example application is under development.

Using with Python

To see how GroupDocs Heroku addon works with Python, check this example.

Using with Java

To see how GroupDocs Heroku addon works with Java, check this example.

Monitoring & Logging

Stats and the current state of GroupDocs can be displayed via the CLI.

$ heroku groupdocs:command
example output
$ heroku logs -t | grep 'groupdocs pattern'


For more information on the features available within the GroupDocs dashboard please see the docs at

The GroupDocs dashboard allows you to .

The dashboard can be accessed via the CLI:

$ heroku addons:open groupdocs
Opening groupdocs for sharp-mountain-4005…

or by visiting the Heroku apps web interface and selecting the application in question. Select GroupDocs from the Add-ons menu.


Migrating between plans

Application owners should carefully manage the migration timing to ensure proper application function during the migration process.

Use the heroku addons:upgrade command to migrate to a new plan.

$ heroku addons:upgrade groupdocs:newplan
-----> Upgrading groupdocs:newplan to sharp-mountain-4005... done, v18 ($49/mo)
       Your plan has been updated to: groupdocs:newplan

Removing the add-on

GroupDocs can be removed via the CLI.

This will destroy all associated data and cannot be undone!

$ heroku addons:destroy groupdocs
-----> Removing groupdocs from sharp-mountain-4005... done, v20 (free)


All GroupDocs support and runtime issues should be submitted via on of the Heroku Support channels. Any non-support related issues or product feedback is welcome at Hosted Graphite Dashboard