Configuration

To fully complete the environment extension in the Contentful application, Arboretum must be properly configured. At this stage, it is necessary to enter mandatory access tokens - Content Delivery API token and Content Preview API token - so that Arboretum gets access to all entries (both published and unpublished) and can build the sitemap.

API keys generation

There are several options for obtaining access keys - either by generating a new set or using sample tokens prepared by Contentful.

To obtain the access tokens, click the "here" link in the Access tokens area, you will be automatically redirected to the master environments' API keys section where you can create new set of tokens for your configuration.

The keys can be accessed as well directly from the master environment.

Alternatively, go to Settings → API keys and select Add API key button on the top-right.

Make sure that the keys will be available in the environment for which the installation and configuration of Arboretum is performed. If the target environment, on which the application is to be accessed, is not the master environment, make sure that this environment is marked as selected. Then you can go ahead and enter these keys to complete the setup of Arboretum.


* Hint: If the environment is cloned from the master on which Arboretum is already installed, you need to go to Arboretum app configuration (Apps > Manage apps > Arboretum) and finalize the configuration choosing the type of installation you prefer and then creating API keys for this environment.

Content model configuration

Depending on which installation type you have chosen it might be the time to adjust or create three necessary content types: Page, Settings and Redirects. If your choice was automatic, or semi-automatic installation type those will be already adjusted for you.

Manual installation requires creating or adjusting those three content types with fields and configuration that matches exactly (and at minimum) those described below:

*Hint: While creating required content types manually remember that Field ID based on the entry name will be then used in the dropdowns for content types configuration in Arboretum configuration screen.

Settings type configuration:

Internal name settings:
-
Text - Short text
- Field represents the Entry title
- Validation: required field
- Appearance as Single line
Home page settings:
- Reference/Link - One reference
- Validation: required field, Accept only specific entry type - Page
- Appearance as Entry link

Page type configuration

Slug settings:
- Text - Short text
- Localization enabled
- Validation: required field, match a specific pattern: ^((\/)|(([\/\w\-\._~:!$&'\(\)*+,;@]|(%\d+))+))$
- Appearance as Signle line
Internal name settings:
- Text - Short text
- Field represents the Entry title
- Validation: required field
- Appearance as Single line
Page title settings:
- Text - Short text
- Localization enabled
- Required field
- Appearance as Single line
Child pages settings:
- Reference/Array - Many references
- Validation: Accept only specific entry type - Page
- Appearance as Entry links list

Redirects type configuration:

Internal name settings:
- Text - Short text
- Field represents the Entry title
- Validation: required field
- Appearance as Single line
Type settings:
- Text - Short text
- Validation: required field, Accept only specified values (add values "redirect" and "alias")
- Appearance as dropdown
Page settings:
- Reference/Link - One reference
- Validation: required field, Accept only specific entry type - Page
- Appearance as Entry link
Path settings:
- Text - Short text
- Localization enabled
- Validation: required field, match a specific pattern: \/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?$
- Appearance as Single line

Settings type configuration:

Internal name settings:
-
Text - Short text
- Field represents the Entry title
- Validation: required field
- Appearance as Single line
Home page settings:
- Reference/Link - One reference
- Validation: required field, Accept only specific entry type - Page
- Appearance as Entry link

Page type configuration

Slug settings:
- Text - Short text
- Localization enabled
- Validation: required field, match a specific pattern: ^((\/)|(([\/\w\-\._~:!$&'\(\)*+,;@]|(%\d+))+))$
- Appearance as Signle line
Internal name settings:
- Text - Short text
- Field represents the Entry title
- Validation: required field
- Appearance as Single line
Page title settings:
- Text - Short text
- Localization enabled
- Required field
- Appearance as Single line
Child pages settings:
- Reference/Array - Many references
- Validation: Accept only specific entry type - Page
- Appearance as Entry links list

Configuration summary

Once the configuration is done, Arboretum credentials will be generated for you.
You can also add the URL under which your project will be available. If you have Compose installed on your environment, select that option in the additional configuration.


Now you can create and view your page structure using the Arboretum sitemap. Follow the instructions on how to use Arboretum in the User Guide.