Installation

At the moment, you can obtain the catworkx Confluence REST API Extension app as JAR file only directly from catworkx.

Content of this section:

Install App

To install the catworkx Confluence REST API Extension app, do the following on the Confluence server:

  1. Log into the Confluence server as administrator.
  2. From the Administration menu, select Add-ons.
  3. By default, you should see the "Manage Add-ons" dialog in the right frame. If not, search for Manage add-ons in the left frame and select it.
  4. Click Upload add-on.
  5. Select the app JAR file and click Upload.
  6. A message should appear that the installation was successful. Click Close to close the message window.
    The catworkx Confluence REST API Extension should be listed at "User-installed add-ons" in the right frame.


Uninstall App

To uninstall the catworkx Confluence REST API Extension app, do the following on the Confluence server:

  1. Log into the Confluence server as administrator.
  2. From the Administration menu, select Add-ons.
  3. By default, you should see the "Manage Add-ons" dialog in the right frame. If not, search for Manage add-ons in the left frame and select it.
  4. By default the user-installed apps are listed in the right frame. The catworkx Confluence REST API Extension should be listed.
  5. From the app list, select catworkx Confluence REST API Extension.
  6. To uninstall the catworkx Confluence REST API Extension app, select Uninstall.
  7. To confirm, click Uninstall add-on in the confirmation dialog.
  8. The app is removed and a confirmation should appear on the "User-installed add-ons" list.
  9. If you click the Reload button in your Web browser, the catworkx Confluence REST API Extension app should be removed from the list of "User-installed add-ons".

Disable/Enable App

Disable App

To disable catworkx Confluence REST API Extension, do the following on the Confluence server:

  1. Log into the Confluence server as administrator.
  2. From the Administration menu, select Add-ons.
    By default the user-installed apps are listed in the right frame. The catworkx Confluence REST API Extension app should be listed.
  3. From the app list, select catworkx Confluence REST API Extension.
  4. To disable the catworkx JIRA Field Value Macro app, click Disable.
  5. To indicate that the app is disabled, the font of the catworkx Confluence REST API Extension entry in app list changed from black to gray.
    An "Enable" button should appear.

Enable App

To enable a disabled catworkx Confluence REST API Extension app, do the following on the Confluence server:

  1. Log into the Confluence server as administrator.
  2. From the Administration menu, select Add-ons.
    By default the user-installed apps are listed in the right frame. The catworkx Confluence REST API Extension app should be listed.
  3. From the app list, select catworkx Confluence REST API Extension.
  4. To enable the catworkx Confluence REST API Extension app, click Enable.
  5. To indicate that the app is enabled, the font of the catworkx Confluence REST API Extension entry in app list changed from gray to black.
    An "Disable" button should appear.