Global configuration files contain your global CloudCannon configuration, and top-level values for the configuration cascade.
Configuration is set in one of the following files, the first supported file found in this order is used:
This file is stored in the root directory of your repository (e.g.
/cloudcannon.config.*). Alternatively, use a specific config file in a custom location using the
CLOUDCANNON_CONFIG_PATH environment variable:
Here's an example file:
The following is automatically read from Jekyll if not set in the global configuration file:
--sourceCLI option or
The following is automatically read from Hugo if not set in the global configuration file:
collections_configfrom your folder structure inside
contentDirin Hugo config
layoutsDirin Hugo config
dataDirin Hugo config
staticDirin Hugo config
--baseURLCLI option or
baseURLin Hugo config
sourcein Hugo config
The following is automatically read from Eleventy if not set in the global configuration file:
--inputCLI option or
These options match Eleventy's configuration format and are set as follows:
Automatically installed is the recommended default with Manage eleventy-plugin-cloudcannon manually disabled in your build configuration.
Applicable if you have Manage eleventy-plugin-cloudcannon manually enabled in your build configuration.
Global configuration files have the following options available:
The subpath your output files are mounted at.
Contains definitions for your collections, the related sets of content files for your site grouped by folder. Entries are keyed by your collection key, and contain configuration specific to that collection. Read more about defining your collections and the available configuration.
Prevents CloudCannon from automatically discovering collections for supported SSGs if
true. Defaults to
collection_groups- Array of objects#
Controls which collections are displayed in the site navigation and how those collections are grouped. Defaults to splitting all available collections between Pages, Blogging and Data groups. Read more about configuring your navigation section.
data_config- Object or boolean#
Controls what data sets are available to populate select and multiselect inputs.
If set as a boolean and
true, all auto-discoverable data sets are added. This is only applicable to Jekyll and Hugo sites.
If set as an object, only those data sets are added.
Contains settings for the default editor actions on your site. The only available option is
default_path, which sets what URL the editor opens from the dashboard.
Global paths to common folders. These are often automatically populated from your SSG, and not all paths are relevant to all SSGs. Each path is relative to
source. The available keys are:
uploadsfor the default location of newly uploaded site files.
dam_uploadsfor the default location of newly uploaded DAM files.
staticfor the location of statically copied assets.
dam_staticfor the location of statically copied assets for DAM files.
collectionsfor the parent folder of all collections.
datafor the location of site data files.
layoutsfor the top-most folder of site layout files.
includesfor the top-most folder of includes/partials/shortcode files.
dam_uploads have a number of dynamic placeholders available.
Base path to your site source files, relative to the root folder of your site.
Contains settings for the behavior and appearance of the Source Editor.
Timezone of your site in IANA format. Used by date and datetime inputs. Defaults to
Generates the integration file in another folder. Not available for Jekyll, Hugo and Eleventy. Defaults to the root folder of your site.
Configuration cascade options#
Global configuration files are the base level for defining options in the configuration cascade, allowing you to define these options here at a global scope.