Integrating your site with CloudCannon

Last modified: September 5th, 2023

Working with a specific static site generator?
Customize CloudCannon's documentation to suit your SSG.

Great! We'll show you documentation relevant to .
You can change this any time using the dropdown in the navigation bar.

Integrating a site in CloudCannon means getting your data and content to an editable state. A good starting point for this process is completing a successful build.

Follow these steps to fully integrate your site:

1. Create a global configuration file#

The global configuration file is the heart of your integration with CloudCannon. You can create your configuration file locally or using the CloudCannon configuration GUI.

Once you have created your site, CloudCannon will automatically detect if you do not have a configuration file. In your sidebar, you will see the “Get started” button, which will prompt you to “Generate your global configuration file”.

CloudCannon will prompt you to create a configuration file
Click Generate your global configuration file to create your file

The CloudCannon configuration GUI will guide you through creating a configuration file for your website.

2. Define your collections#

Defining your collections in the global configuration file creates the base navigation for your content, organizes your files into groups, and populates the metadata used in file previews.

The navigation plays a crucial rule directing team members where to edit content in CloudCannon.

3. Refine your editing experience#

At this point you should have a good base integration with CloudCannon. There are a number of optional features from here that improve the editing experience. Depending on your site and use case, each feature will have a different priority for you.

The rest of the documentation covers these features in depth, and here are some suggestions to get started:

Integration tools#

You don't have to install integration tools or generate integration files yourself.

CloudCannon integrates your site through a JSON file automatically generated during your build. This file contains your global configuration and metadata from your collections and files. The integration file is generated for you with one of the following automatically installed plugins or tools:

Check your build output to see logs and potential warnings from these integration tools to diagnose issues.

Related Articles

Open in a new tab