next.js/examples/cms-sitecore-xmcloud/sitecore/config/xmcloud-nextjs-starter.config

<!--
  JSS Sitecore Configuration Patch File

  This configuration file registers the JSS site with Sitecore, and configures the Layout Service
  to work with it. Config patches need to be deployed to the Sitecore server.

  Normally `jss deploy config` can do this for local development. To manually deploy, or to deploy via CI,
  this file can be placed in the `App_Config/Include` folder, or a subfolder of it, within the Sitecore site.
-->
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" xmlns:set="http://www.sitecore.net/xmlconfig/set/" xmlns:role="http://www.sitecore.net/xmlconfig/role/">
  <sitecore>
    <!--
      Note that if any of these settings are enabled, they will apply to the entire Sitecore instance. If there are
      multiple sites defined in the instances, the settings will affect all of them.
    -->
    <settings>
      <!--
        ANALYTICS FORWARDED REQUEST HEADER
        When using Next.js SSR routes, Layout Service requests will send the original IP address of the client on the 'X-Forwarded-For' header.
        This setting tells Sitecore to read the forwarded header, thus making analytics track the correct original client IP address.

        <setting name="Analytics.ForwardedRequestHttpHeader" set:value="X-Forwarded-For" />
      -->
      
      <!--
        ANALYTICS DISABLE ROBOT DETECTION
        During development, activity will flag us as a robot.
        These settings will enable tracking of robot activity for ease of testing (development ONLY).
        
        <setting name="Analytics.AutoDetectBots" set:value="false" />
        <setting name="Analytics.Robots.IgnoreRobots" set:value="false" />
      -->

      <!--
        JSS EDITING SECRET
        To secure the Sitecore editor endpoint exposed by your Next.js app (see `serverSideRenderingEngineEndpointUrl` below),
        a secret token is used. This is taken from an env variable by default, but could be patched and set directly by uncommenting.
        This (server-side) value must match your client-side value, which is configured by the JSS_EDITING_SECRET env variable (see the Next.js .env file).
        We recommend an alphanumeric value of at least 16 characters.

        <setting name="JavaScriptServices.ViewEngine.Http.JssEditingSecret" value="" />
      -->

      <!--
        LANGUAGE FALLBACK
        These settings enable item-level language fallback for JSS apps that use Experience Edge.
        In addition to these settings, ensure that Language Fallback is configured on the Language
        item in Sitecore, and that items in the content tree have "Enable Item Fallback" field set
        to true. Other settings related to item-level language fallback that may exist in Sitecore
        configuration will not impact Edge functionality.

        <setting name="ExperienceEdge.EnableItemLanguageFallback" value="true"/>
        <setting name="ExperienceEdge.EnableFieldLanguageFallback" value="true"/>
      -->
    </settings>
    <sites>
      <!--
        JSS Site Registration
        This configures the site with Sitecore - i.e. host headers, item paths.
        If your JSS app lives within an existing Sitecore site, this may not be necessary.

        IMPORTANT: JSS sites ship in 'live mode', which makes development and testing easy,
        but disables workflow and publishing. Before going to production, change the `database`
        below to `web` instead of `master`.
      -->
      <site patch:before="site[@name='website']"
            inherits="website"
            name="xmcloud-nextjs-starter"
            hostName="xmcloud-nextjs-starter.dev.local"
            rootPath="/sitecore/content/xmcloud-nextjs-starter"
            startItem="/home"
            database="master" />
    </sites>
    <javaScriptServices>
      <apps>
        <!--
          JSS App Registration
          The JSS app needs to be registered in order to support layout service and import services.

          There are many available attributes, and they inherit the defaults if not explicitly specified here.
          Defaults are defined in `/App_Config/Sitecore/JavaScriptServices/Sitecore.JavaScriptServices.Apps.config`

          NOTE: graphQLEndpoint enables _Integrated GraphQL_. If not using integrated GraphQL, it can be removed.

          NOTE: layoutServiceConfiguration should be set to "default" when using GraphQL Edge schema.
          When using integrated GraphQL with Edge schema, a $language value is injected
          since language is required in all Edge queries. "jss" configuration does not do this (which is backwards
          compatible with JSS versions < 18.0.0).
        -->
        <app name="xmcloud-nextjs-starter"
            layoutServiceConfiguration="default"
            sitecorePath="/sitecore/content/xmcloud-nextjs-starter"
            useLanguageSpecificLayout="true"
            graphQLEndpoint="/sitecore/api/graph/edge"
            inherits="defaults"
            serverSideRenderingEngine="http"
            serverSideRenderingEngineEndpointUrl="http://localhost:3000/api/editing/render"
            serverSideRenderingEngineApplicationUrl="http://localhost:3000"
        />
      </apps>
      <!--
        IMAGE RESIZING WHITELIST
        Using Sitecore server-side media resizing (i.e. the `imageParams` or `srcSet` props on the `<Image/>` helper component or the `<NextImage/>` helper component)
        could expose your Sitecore server to a denial-of-service attack by rescaling an image with many arbitrary dimensions.
        In JSS resizing param sets that are unknown are rejected by a whitelist.

        Sets of image sizing parameters that are used in app components must be whitelisted here.
        If a param set is not whitelisted, the image will be returned _without resizing_.

        To determine the image parameters being used, look at the query string on the `src` of the rendered image, i.e. '/img.jpg?mw=100&h=72' -> mw=100,h=72
        Note: the parameter sets defined here are comma-delimited (,) instead of &-delimited like the query string. Multiple sets are endline-delimited.
       -->
      <allowedMediaParams>
        <!-- XML element name is arbitrary, useful for organizing and patching -->
        <styleguide-image-sample>
          mw=100,mh=50
        </styleguide-image-sample>
        <next-image-default>
          mw=16
          mw=32
          mw=48
          mw=64
          mw=96
          mw=128
          mw=256
          mw=384
          mw=640
          mw=750
          mw=828
          mw=1080
          mw=1200
          mw=1920
          mw=2048
          mw=3840
        </next-image-default>
      </allowedMediaParams>
    </javaScriptServices>
    <!--
      Media URLs resolving
      Tells Sitecore to not include the Sitecore server URL as part of the media requests, so that they are instead routed through Next.js rewrites (see next.config.js).
      This eliminates exposing the Sitecore server publicly.
      
      "default" configuration is used for Sitecore GraphQL Edge requests.
      "jss" configuration is used for Sitecore Layout Service REST requests.
    -->
    <layoutService>
      <configurations>
        <config name="default">
          <rendering>
            <renderingContentsResolver>
              <IncludeServerUrlInMediaUrls>false</IncludeServerUrlInMediaUrls>
            </renderingContentsResolver>
          </rendering>
        </config>
        <config name="jss">
          <rendering>
            <renderingContentsResolver>
              <IncludeServerUrlInMediaUrls>false</IncludeServerUrlInMediaUrls>
            </renderingContentsResolver>
          </rendering>
        </config>
      </configurations>
    </layoutService>
  </sitecore>
</configuration>