Add a Ghost CMS connection

A Ghost CMS connection gives your organisation a governed destination for publishing approved, public-eligible documentation. Connecting Ghost CMS does not publish a document, expose a draft or change a document's classification. External publication remains a separate, explicit action on the exact approved version.

Before you begin

You need:

Organisation administrator access in Opries;
permission to create a Custom Integration in Ghost CMS;
approval to connect the destination and publish organisational information to it; and
the HTTPS Admin URL and Admin API key for a dedicated Ghost CMS Custom Integration.

Use a separate Custom Integration for each Opries organisation. Do not reuse a key from another organisation or an unrelated publishing workflow.

Create the Custom Integration in Ghost CMS

Sign in to Ghost CMS Admin for the destination site.
Open Settings, then Integrations.
Select Add custom integration.
Use these recommended integration details:
- Title or name: Opries
- Description: Publishes approved public documentation from Opries to this Ghost CMS site.
- Icon: use the Opries Ghost CMS integration icon.
Save the Custom Integration.
Copy the Admin API URL and Admin API key shown for the integration.

The icon is the approved square Opries identifier supplied as an SVG file. Open the icon link and save the file before uploading it to the Custom Integration. These details make the connection easy to recognise in Ghost CMS Admin; they do not change its access or publishing permissions.

Use the Admin API key, not the Content API key. The Admin API key can create and change pages, so keep it private. Ghost CMS documents Custom Integrations and Admin API authentication in its Custom Integrations guide and Admin API documentation.

Add the connection in Opries

Sign in to Opries and select the organisation that owns the connection.
Open your account menu and select Plugins & integrations.
Select Add connection.
Choose Ghost CMS · Available as the provider.
Enter a clear Connection name.
Enter the HTTPS Ghost CMS Admin URL shown by the Custom Integration. The Admin URL may differ from the site's public address. Do not add /ghost/api/admin/ to the end.
Paste the dedicated Ghost CMS Admin API key.
Confirm that the connection and public-document destination have been authorised by the organisation.
Select Test and add connection.

Opries first checks that the Admin URL is a reachable public HTTPS destination and uses the key to make a read-only connection test. The destination is added only if that test succeeds.

Confirm the connection

After a successful test, the Ghost CMS destination appears in the connection register as Enabled with its last verification time.

Use Verify connection to run the read-only test again. Verification does not publish, update or withdraw a page.

The stored Admin API key is encrypted and remains server-only. Opries does not display the key again after the connection is added.

If the test fails

Check that:

the URL is the HTTPS Admin URL for the same Ghost CMS site as the key;
you copied the Admin API key, not the Content API key;
the Custom Integration still exists in Ghost CMS;
the Ghost CMS site is publicly reachable; and
no firewall or access rule blocks the connection from Opries.

Correct the details and select Test and add connection again. A failed test does not register the destination.

If the key is exposed or revoked

Revoke or replace the Custom Integration key in Ghost CMS immediately, then contact Opries support to replace the stored connection credential. Existing publishing and verification actions will fail until the connection is updated.

Do not include the old or replacement key in a support case. Opries support will provide an approved secure replacement process.

What can be published

The connection does not make all organisational information public. Opries will allow external publication only when the document is public-eligible, the exact current version is approved and the person performing the action has the required permission.

Drafts, restricted information and documents that have not completed their governed workflow are not eligible for Ghost CMS publication.