# Configure Redoc CE

Redoc CE comes with many configuration options to help you customize your API documentation.
This page lists all the options you can use with Redoc CE 3.x, and how to pass them in each deployment method.

## Pass options

Options have the same names in every deployment method; only the syntax differs:

- **[Redocly CLI](/docs/redoc/v3.x/deployment/cli#configure-redoc-ce):** the `openapi`, `asyncapi`, or `graphql` key in `redocly.yaml`, matching the type of your description, or the same names as command-line options: `--graphql.layout=stacked`.
- **[HTML element](/docs/redoc/v3.x/deployment/html#configure-redoc-ce):** kebab-case attributes on `<redoc>`, for example `schemas-expansion-level="all"`.
  Attributes are strings, so options that take objects or arrays need the `init` function instead.
- **[JavaScript `init` function](/docs/redoc/v3.x/deployment/html#the-init-function):** the second argument, for example `init(url, { schemasExpansionLevel: 'all' })`.
- **[React component](/docs/redoc/v3.x/deployment/react):** the `options` prop of `RedocStandalone`.
- **[Docker image](/docs/redoc/v3.x/deployment/docker#pass-configuration-options):** kebab-case attributes in the `REDOC_OPTIONS` environment variable.

## Standalone options

The following options control the Redoc CE page itself.
In HTML and Docker they are attributes of `<redoc>`, and in `init` they are part of the options object.
In React, `basePath` is a prop of `RedocStandalone`, and the other options go in the `options` prop.

| Option | Type | Description |
| --- | --- | --- |
| router | string | Routing mode for deep links. `hash` keeps the route in the URL fragment and works from any static host. `history` uses path-based URLs and needs a server that returns the page for every path. Available in HTML, Docker, and `init`. The React component always uses path-based routing unless it renders inside a `HashRouter`. Default: `hash`. |
| basePath | string | Path prefix the documentation is served under, used to build route URLs with `history` routing and in React. Default: `/`. |
| disableTelemetry | boolean | Turns off [telemetry](/docs/redoc/v3.x/telemetry) when set to `true`. Available in HTML, Docker, `init`, and the React `options` prop. With Redocly CLI, the page follows the [CLI telemetry setting](/docs/redoc/v3.x/telemetry#redocly-cli) instead. Default: `false`. |
| hideLoading | boolean | Hides the loading spinner shown while the description loads. Default: `false`. |
| skipBundle | boolean | Skips resolving and bundling `$ref`s in the description. Requires a description object rather than a URL. Default: `false`. |
| scrollYOffset | number \| function | Vertical offset in pixels, or a function that returns one, for pages with a fixed header above the documentation. Default: `0`. |
| apiLogo | object | Logo at the top of the sidebar, as `{ imageUrl, href, altText, backgroundColor }`. OpenAPI and AsyncAPI descriptions can set the logo in the `info.x-logo` extension instead; GraphQL schemas have no `info` object, so use this option. |

## Common options

Redoc CE 3.x also supports the following configuration options:

### OpenAPI options

- [downloadUrls](/docs/platform/config/openapi/download-urls)
- [events](/docs/platform/config/openapi/events)
- [generatedSamplesMaxDepth](/docs/platform/config/openapi/generated-samples-max-depth)
- [hideDownloadButtons](/docs/platform/config/openapi/hide-download-buttons)
- [hidePropertiesPrefix](/docs/platform/config/openapi/hide-properties-prefix)
- [hideSchemaTitles](/docs/platform/config/openapi/hide-schema-titles)
- [jsonSamplesExpandLevel](/docs/platform/config/openapi/json-samples-expand-level)
- [layout](/docs/platform/config/openapi/layout)
- [maxDisplayedEnumValues](/docs/platform/config/openapi/max-displayed-enum-values)
- [onlyRequiredInSamples](/docs/platform/config/openapi/only-required-in-samples)
- [sanitize](/docs/platform/config/openapi/sanitize)
- [schemaDefinitionsTagName](/docs/platform/config/openapi/schema-definitions-tag-name)
- [schemasExpansionLevel](/docs/platform/config/openapi/schemas-expansion-level)
- [showExtensions](/docs/platform/config/openapi/show-extensions)
- [sortRequiredPropsFirst](/docs/platform/config/openapi/sort-required-props-first)

### AsyncAPI options

In `redocly.yaml`, these options go under the `asyncapi` key.

- [downloadUrls](/docs/platform/config/asyncapi/download-urls)
- [jsonSamplesDepth](/docs/platform/config/asyncapi/json-samples-depth)
- [layout](/docs/platform/config/asyncapi/layout)

### GraphQL options

In `redocly.yaml`, these options go under the `graphql` key.

- [fieldExpandLevel](/docs/platform/config/graphql/field-expand-level)
- [info](/docs/platform/config/graphql/info)
- [jsonSamplesDepth](/docs/platform/config/graphql/json-samples-depth)
- [menu](/docs/platform/config/graphql/menu)
- [samplesMaxInlineArgs](/docs/platform/config/graphql/samples-max-inline-args)
- [showBuiltInDirectives](/docs/platform/config/graphql/show-built-in-directives)
- [showBuiltInScalars](/docs/platform/config/graphql/show-built-in-scalars)

The `layout` and `downloadUrls` options work for GraphQL as for OpenAPI.

### Other options

| Option | Type | Description |
| --- | --- | --- |
| codeSamples | object | Order and labels of the language tabs in the request samples panel of OpenAPI operations, as `{ languages: [{ lang, label }] }`. Redoc CE does not generate code samples. A language tab appears next to the **Payload** tab only when the operation provides a sample for it in `x-codeSamples`. Default order: curl, JavaScript, Node.js, Python, Java, C#, PHP, Go, Ruby, R, and Payload. |
| hideSchemaPattern | boolean | Hides the `pattern` constraint in OpenAPI schema fields. Default: `false`. |
| ignoreNamedSchemas | [string] | Names of OpenAPI schemas to show without their properties where they are referenced. As an attribute, pass a comma-separated string. Default: none. |

## Example

The same configuration passed as `<redoc>` attributes, as an `init` options object, and under the `openapi` key of `redocly.yaml` for Redocly CLI:

```html
<redoc
  spec-url="https://redocly.github.io/redoc/cafe.yaml"
  layout="stacked"
  schema-definitions-tag-name="Schemas"
  schemas-expansion-level="all"
  json-samples-expand-level="1"
  sort-required-props-first="true"
  show-extensions="true"
  hide-schema-titles="true"
  max-displayed-enum-values="5"
  disable-telemetry="true"
></redoc>
<script type="module" src="https://cdn.redoc.ly/redoc/v3.x/bundles/redoc.standalone.js"></script>
```

```js
import { init } from 'https://cdn.redoc.ly/redoc/v3.x/bundles/redoc.standalone.js';

init('https://redocly.github.io/redoc/cafe.yaml', {
  layout: 'stacked',
  schemaDefinitionsTagName: 'Schemas',
  schemasExpansionLevel: 'all',
  jsonSamplesExpandLevel: 1,
  sortRequiredPropsFirst: true,
  showExtensions: true,
  hideSchemaTitles: true,
  maxDisplayedEnumValues: 5,
  disableTelemetry: true,
  downloadUrls: [
    { title: 'Download OpenAPI description', url: 'https://redocly.github.io/redoc/cafe.yaml' },
  ],
});
```

```yaml
openapi:
  layout: stacked
  schemaDefinitionsTagName: Schemas
  schemasExpansionLevel: all
  jsonSamplesExpandLevel: 1
  sortRequiredPropsFirst: true
  showExtensions: true
  hideSchemaTitles: true
  maxDisplayedEnumValues: 5
  downloadUrls:
    - title: Download OpenAPI description
      url: https://redocly.github.io/redoc/cafe.yaml
```

## Resources

- **[Redoc CE deployment guide](/docs/redoc/v3.x/deployment/intro)** - The different ways to deploy API documentation with Redoc CE
- **[Use Redocly CLI with Redoc CE](/docs/redoc/v3.x/deployment/cli)** - Pass options in `redocly.yaml` or as command line flags
- **[Use Redoc CE in HTML](/docs/redoc/v3.x/deployment/html)** - Pass options as attributes or through the `init` function
- **[Use Redoc CE React component](/docs/redoc/v3.x/deployment/react)** - Pass options in the `options` prop
- **[Use the Redoc CE Docker image](/docs/redoc/v3.x/deployment/docker)** - Pass options in the `REDOC_OPTIONS` environment variable
- **[Redoc CE specification extensions](/docs/redoc/v3.x/redoc-vendor-extensions)** - The `x-` extensions Redoc CE reads
- **[Migration from Redoc CE 2.x to 3.x](/docs/redoc/v3.x/config-migration)** - Migrate Redoc CE configuration to version 3.x
- **[Telemetry](/docs/redoc/v3.x/telemetry)** - The telemetry Redoc CE collects and how to turn it off