---
title: Configuration
description: Write configuration reference documentation.
image: https://developers.cloudflare.com/cf-twitter-card.png
---

> Documentation Index  
> Fetch the complete documentation index at: https://developers.cloudflare.com/style-guide/llms.txt  
> Use this file to discover all available pages before exploring further.

[Skip to content](#%5Ftop) 

# Configuration

## Purpose

The purpose of a configuration is to show examples of specific settings, values, and options.

## Tone

plain, descriptive, straightforward

## content\_type

YAML

```

pcx_content_type: configuration

products:

  - product-a

  - product-b

  - product-c


```

For more details, refer to [pcx\_content\_type](https://developers.cloudflare.com/style-guide/frontmatter/custom-properties/#pcx%5Fcontent%5Ftype).

## When to use

Configurations are useful for parts of the product that are very configuration-intensive; for example, rules.

## Structure

### Required components

[**Title**](https://developers.cloudflare.com/style-guide/documentation-content-strategy/component-attributes/titles/): The title should be noun-based, because configurations are not designed to guide users towards achieving a goal – rather, they describe common ways to set up a specific feature depending on the user's needs.

**Context**: The context should be given in a paragraph right after the title. It should introduce the features, contextualize what type of configurations the user will encounter, and link to other relevant documentation.

**Settings and values**: This should be a reference table with a 1:1 correspondence between a setting the user can change, and the value they should input/select in order to reach the goal outlined in the context paragraph.

### Optional components

[**Navigation**](https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/navigation/): When we have many configurations to cover, it's useful to include a navigation list to help the user find what they need.

## Template

```

---

weight: xx

pcx_content_type: configuration

description: Configure <Cloudflare product or feature> settings for <use case or goal>. Covers <key settings or values>.

products:

  - product-a

  - product-b

  - product-c

---


# Title


Write an overview of the high-level feature here, not more than 2-3 sentences. Outline what users can achieve with it, and if necessary, link to other parts of the docs.


* [Feature 1](/feature-1)

* [Feature 2](/feature-2)

* [Feature 3](/feature-3)


## Feature 1


(Feature 1) allows you to (placeholder). For example, the following configuration (placeholder).


| Setting 1 | Setting 2 | Setting 3 |


| - | - | - |


| Value 1 | Value 2 | Value 3 |


## Feature 2


(Feature 2) allows you to (placeholder). For example, the following configuration (placeholder).


| Setting 1 | Setting 2 | Setting 3 |


| - | - | - |


| Value 1 | Value 2 | Value 3 |


## Feature 3


(Feature 3) allows you to (placeholder). For example, the following configuration (placeholder).


| Setting 1 | Setting 2 | Setting 3 |


| - | - | - |


| Value 1 | Value 2 | Value 3 |


```

## Additional Information

Configurations, also known as use cases, are reference pages with examples of how you might set a product up based on your requirements. If you are creating a configuration and feel yourself wanting to include instructions, consider a [tutorial](https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/tutorial/), [how-to](https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/how-to/), or [example](https://developers.cloudflare.com/style-guide/documentation-content-strategy/component-attributes/examples/) instead.

```json
{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/style-guide/","name":"Style Guide"}},{"@type":"ListItem","position":3,"item":{"@id":"/style-guide/documentation-content-strategy/","name":"Product docs content strategy"}},{"@type":"ListItem","position":4,"item":{"@id":"/style-guide/documentation-content-strategy/content-types/","name":"Content types"}},{"@type":"ListItem","position":5,"item":{"@id":"/style-guide/documentation-content-strategy/content-types/configuration/","name":"Configuration"}}]}
```