{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"configuration-options","__idx":0},"children":["Configuration options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," file is the single place to configure everything Redocly."," ","This configuration file allows you to customize your API documentation, developer projects, and other Redocly services according to your needs."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide provides a comprehensive overview of available configuration options organized by functional areas."]},{"$$mdtype":"Tag","name":"ConfigIntroduction","attributes":{"title":"Filter configuration options","description":"Choose your Redocly products and plan to see only the configuration options available to you. Select filters below to get started."},"children":[]},{"$$mdtype":"Tag","name":"ConfigSection","attributes":{"title":"API Management","description":"Define your APIs and control how API descriptions are processed and validated."},"children":[{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"apis.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"asyncapi/index.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"catalog-classic.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"openapi/decorators.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"openapi/extends.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"graphql/index.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"mock-server.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"openapi/index.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"openapi/preprocessors.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"rules.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"scorecard-classic.md"},"children":[]}]},{"$$mdtype":"Tag","name":"ConfigSection","attributes":{"title":"Navigation elements","description":"These settings control how users navigate through your documentation project."},"children":[{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"ai-assistant.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"footer.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"navbar.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"navigation.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"search.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"sidebar.md"},"children":[]}]},{"$$mdtype":"Tag","name":"ConfigSection","attributes":{"title":"User interface","description":"Customize the look and feel of your documentation project with these options."},"children":[{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"banner.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"breadcrumbs.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"code-snippet.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"color-mode.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"logo.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"markdown.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"remove-attribution.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"user-menu.md"},"children":[]}]},{"$$mdtype":"Tag","name":"ConfigSection","attributes":{"title":"Content management","description":"Organize and control documentation content, versions, and localization."},"children":[{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"l10n.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"metadata.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"metadata-globs.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"products.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"version-picker.md"},"children":[]}]},{"$$mdtype":"Tag","name":"ConfigSection","attributes":{"title":"Security and access management","description":"Configure user authentication and access controls for your documentation."},"children":[{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"access/index.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"access/idps.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"access/logout-return-url.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"access/rbac.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"access/requires-login.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"access/residency.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"access/sso.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"cors-proxy.md"},"children":[]}]},{"$$mdtype":"Tag","name":"ConfigSection","attributes":{"title":"Customization","description":"Extend functionality with custom code and additional features."},"children":[{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"api-functions.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"env.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"links.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"mcp.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"plugins.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"openapi/resolve.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"response-headers.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"scripts.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"skills.md"},"children":[]}]},{"$$mdtype":"Tag","name":"ConfigSection","attributes":{"title":"Analytics and SEO","description":"Improve discoverability and track usage of your documentation."},"children":[{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"analytics/index.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"consent.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"ignore.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"redirects.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"seo.md"},"children":[]}]},{"$$mdtype":"Tag","name":"ConfigSection","attributes":{"title":"Developer experience","description":"Enhance the experience for developers using your APIs."},"children":[{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"developer-onboarding/index.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"feedback.md"},"children":[]},{"$$mdtype":"Tag","name":"ConfigProperty","attributes":{"file":"reunite.md"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-configuration","__idx":1},"children":["Example configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example demonstrates a typical ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," configuration combining various options:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"logo:\n  srcSet: './images/redocly-logo.svg light, ./images/redocly-logo-inverted.svg dark'\n  altText: Redocly logo\n  link: '/'\nnavbar:\n  items:\n    - page: index.md\n      label: '{{ process.env.HOME_LABEL }}' \n    - page: config/index.md\n      label: Config\nfeedback:\n  type: sentiment\n  settings:\n    comment:\n      likeLabel: What was most helpful?\n      dislikeLabel: What can we improve?\n\napis:\n  redocly-museum:\n    root: './openapi-files/redocly-museum.yaml'\n\nextends:\n  - recommended\n\nrules:\n  info-license: error\n  no-ambiguous-paths: error\n  no-http-verbs-in-paths:\n    severity: error\n    splitIntoWords: true\n  rule/operationId-casing:\n    subject:\n      type: Operation\n      property: operationId\n    assertions:\n      casing: camelCase\n  rule/no-description-start-with-the-a-an:\n    subject:\n      type: any\n      property: description\n    assertions:\n      notPattern: /^(The\\s|A\\s|An\\s)/\n\nrbac:\n  content:\n    '**'\n      authenticated: read\n\nredirects:\n  '/concepts/categories/':\n    to: 'author/concepts/categories/'\n  '/concepts/navigation/':\n    to: 'author/concepts/navigation/'\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This example includes logo customization, navigation setup, feedback controls, API descriptions, rule configurations, access controls, and redirects."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuration-principles","__idx":2},"children":["Configuration principles"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redocly has a few important configuration philosophies:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["universal config (all configuration in one place)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["zero config (you don't need to do any configuration because we have sane defaults)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["config-as-code (all configuration should be writable in a simple source-control friendly format)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Boolean options should be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," by default, and each name must say what ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," does."," ","Set one only when you want to turn that behavior on."," ","A few options are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," by default."," ","Check the reference pages for the option you need."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some options have multiple levels of nesting."," ","Pay attention to the indentation and nesting when modifying the file."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":3},"children":["Next steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After configuring your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," file, you can validate it using the Redocly CLI with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli check-config"]},"."," ","For more detailed information about specific configuration options, follow the links in each section."]}]},"frontmatter":{"keywords":{"includes":["redocly.yaml"]}},"tagList":["configIntroduction","configProperty","configSection"],"title":"Configuration options","lastModified":"2026-09-25T14:05:50.000Z"}