Installing Compose

How to install Compose

To install Compose:

  1. Log into Contentful web app.

  2. In the top pane, click Apps and select Manage apps.

    Install Compose 001

  3. Navigate to Compose and click Start installation. Go through the installation steps.

    Install Compose 002

  4. Click Open. Compose is displayed.

    Install Compose 003

  5. Start creating pages within the Compose app according to one of the following options:

  • Quick start - Selecting this option will install an example content model and some example content that can be used as a starting point for your project.

  • Guided setup - Selecting this option will open the Guided setup page that will guide you through a setup process to configure a project on your own from scratch.

NOTE: With the Guided setup option, we recommend that you have some familiarity with content modeling.

Install Compose 004

Spaces and environments

Compose is installed individually for every environment. When you install Compose, it’s content model is created in the environment that you are currently working in.

You can switch to a different space or environment when logged in to Compose. If Compose wasn’t installed in that space/environment, you will be prompted to install it.

NOTE: We recommend using Compose for new projects and installing it in a space where there is no existing content. This way you won’t risk mixing up content from different projects and breaking your production environment.

Compose content model requirements

The Compose content model is based on two content types: "Compose: Page" and "Compose: SEO". They are created programmatically before you start working on your first project with Compose.

"Compose: Page" is the parent content type for each Compose page, and includes "Compose: SEO" and Page as references.

"Compose: SEO" is used to add SEO metadata to the pages you create in Compose.

"Page" is a custom content type with custom fields that defines how your page in Compose will look. The mandatory field for all page content types is a Text field that should have a Field ID with a value “name”. The rest of the fields can be of any type.

NOTE: You can link more than one page to the "Compose: Page" content type to have several page types in Compose.

Was this helpful?
add-circle arrow-right remove style-two-pin-marker subtract-circle