Configure your build settings

Learn how to enable Site builds on CloudCannon and configure your build settings for visual editing.

Before you can use the Visual Editor, you must have at least one successful build on CloudCannon.

Let's configure your build settings and complete a successful build. If you have already met these requirements, such as by completing the Host your website on the Internet guide, you can skip this step of the guide.

Configure your build#

To build your Site, CloudCannon needs to know a few details about how your website functions.

Click the Configure your build button in your in-app guide under the Configure your Site's build settings task.

A screenshot of the Site Dashboard shows the Set up Visual Editing in-app guide with the first task, Configure your Site's build settings.

CloudCannon will open the Configure your build modal.

A screenshot of the Configure your build modal.

CloudCannon can make suggestions for your build settings based on the SSG your Site uses and the contents of your files. You can enter your own build settings or accept a suggestion by clicking the Use button, and CloudCannon will populate the text field. If you are unsure about the correct build settings for your Site, please contact your developer or reach out to our friendly support team.

A screenshot of the Install Command text field and CloudCannon's suggested value in a light blue box.

Under the Command line options section, enter your Install Command, Build Command, Output Path, and Environment Variables. CloudCannon requires a value for Output Path.

A screenshot of the Configure your build modal shows the command line options.

Under the Build system options section, enter your Preserved Paths, and choose whether you want to enable the Preserve Output, Include .git folder, and Manually Configure URLs settings.

A screenshot of the Configure your build modal shows the build system options, including Preserved Paths.

Finally, under the Library Versions section, review the versions of Hugo, Ruby, Node, and Deno. If your website uses any of these libraries, please ensure the version number is correct.

A screenshot of the Configure your build modal shows the library versions for Hugo, Ruby, Node, and Deno.

When you are happy with your answers, click the Update Configuration and Build button. CloudCannon will start your first Site build using the configuration you defined.

Your first build#

Your first Site build should start immediately.

Whenever CloudCannon is building your Site, the Building... notification will appear in the bottom right of your screen. Clicking on the View output button on this notification will open the Build output modal.

A screenshot of the Content Editor with the Building notification in the bottom right shows a button labeled View Output.

The Build output modal displays the Build log for your current build. Build logs are useful for keeping track of your build progress and diagnosing any issues if your build fails.

A screenshot of the Content Editor with the Build Terminal modal open shows the progress of the current Site build.

You can access a list of all your past Build logs on the Builds tab of your Site Dashboard. CloudCannon added this tab to your Dashboard after you configured your first build.

A screenshot of the Builds tab on the Site Dashboard shows a list of all past build logs for this Site.

You can also see the progress of your most recent build on the Summary tab of your Dashboard, on the right under Build. You can trigger a new build at any time using the Rebuild button on the Site Dashboard or cancel a running build using the Cancel build button.

If your build fails, please reach out to our friendly support team.

In the next step of this guide, we'll learn about Editable Regions, including their types and best practices for implementing them.

Open in a new tab