Set Up an Instance Vanity Domain

The following steps must be completed to configure an instance vanity domain. While multiple instance vanity domains can be configured, only a single instance vanity domain will be used by the user interface to display site URLs.

Configure Oracle Content Management With Your Instance Vanity Domain

For Oracle Content Management sites to load properly on an instance vanity domain, you must configure Oracle Content Management properly.

  1. Sign in as an administrative user and click System under Administration in the side navigation panel.

  2. Select Sites from the banner menu.

  3. Click Manage Vanity Domains under the Vanity Domain Configuration section and enter your instance level vanity domain and click Save. Multiple domains can be added and managed.

  4. Select a vanity domain as the default.

  5. Enable or disable Display Short Paths to toggle on or off the display of /site/ or /site/authsite/ in the user interface. This is helpful when most or all of your sites are either public or secure, and your CDN is configured properly.

It can take up to an hour for Oracle Content Management to be ready to accept requests on the vanity domain. During this time, you can access your sites on the original domain.

Note:

If you are using the Oracle Content Management CDN you do not need to perform any additional actions. If you are using a different 3rd-party CDN, review Configure the CDN When Using Standard Paths and Configure the CDN When Using Short Paths. If necessary, consult your CDN for specific instructions.

Configure the CDN When Using Standard Paths

If Display Short Paths is disabled, all site URLs shown in the product will include the full instance vanity domain and site path. Your CDN needs to be configured to route those requests back to the Oracle Content Management origin unaltered.

Once Oracle Content Management is properly configured and ready to accept them, requests made using the instance vanity domain will be routed according to the DNS entries to the CDN and the CDN will forward the requests to Oracle Content Management properly. This is usually done using a CNAME entry in your DNS records. Consult your CDN for specific instructions.

For example, if an Oracle Content Management site has the URL of https://myinstance.cec.ocp.oraclecloud.com/site/MyFirstProjectSite/ and you want to access that site at https://www.example.com/site/MyFirstProjectSite/ the CDN must be configured to:

  • recognize the vanity domain: https://www.example.com/

  • identify the origin Oracle Content Management instance using the vanity domain: https://myinstance.cec.ocp.oraclecloud.com/

  • passthrough the request path: /site/MyFirstProjectSite/

  • and send the full request path to the origin Oracle Content Management instance: https://myinstance.cec.ocp.oraclecloud.com/site/MyFirstProjectSite/

  • Oracle Content Management receives the request and responds to the CDN, which satisfies the request to the visitor's browser, showing only the vanity domain and standard path to the visitor: https://www.example.com/site/MyFirstProjectSite/

These same steps would apply to all requests made for a secure site. The only difference is those paths include /site/authsite/ rather than just /site/.

CDN configuration steps are often specific to the CDN, so work with your CDN provider to properly configure the desired behaviors.

Configure the CDN When Using Short Paths

If Display Short Paths is enabled, site URLs shown in the product will only include the site name rather than including the /site/ or /site/authsite/ portion of the path.

For example, if you enable Display Short Paths and want to reach your Acme-Store site and you know it’s a public site, you could make a request to https://www.acme.com/Acme-Store/ and the CDN would inject /site/ when going back to the Oracle Content Management instance with the full path of https://acmeInstance.cec.ocp.oraclecloud.com/site/Acme-Store/.

A limitation of this feature is that the CDN must know to inject /site/ or /site/authsite/. This is because the Oracle Content Management instance must receive the full path, including /site/ or /site/authsite/, depending on if the site is a public site or a secure site. This means this option is most useful when the majority of your sites are of the same type, either public or secure.

If you have a large mix of public and secure sites, then short paths may not be worth the effort required to maintain your CDN configuration. Preferably most of your sites would be of one type and each of the few remainders could then be handled with exception rules.

For example, let’s say you have 10 sites, 9 of which are public and one is secure called MyAccountSite. Your CDN should be configured such that the public site requests coming to your domain, for a path other than /MyAccountSite/ or one of the excluded paths listed below, have /site/ injected into the path before going back to the Oracle Content Management instance to load the site resources. But if the request is for the secure site /MyAccountSite/, then an exception rule for that site will instead inject /site/authsite/ into the path and the additional behaviors needed to authenticate users are done. If most of your sites are secure, then the CDN configuration should be reversed so that each public site would need an exception rule.

If you do not set up exception rules for each site not covered by the default path injection behavior in your CDN configuration, those sites will fail to load as your Oracle Content Management instance will not know where to find the site.

Note:

The CDN configuration altering the path must not apply to any requests containing the following strings. The trailing wildcard is required for proper matching.
  • /documents*

  • /system*

  • /content*

  • /osn*

  • /pxysvc*

  • /_compdelivery/*

  • /_themes/*

  • /site*

  • /_sitesclouddelivery/*

  • /favicon.ico*

Once Oracle Content Management is properly configured and ready to accept them, requests made using the instance vanity domain will be routed according to the DNS entries to the CDN and the CDN will forward the requests to Oracle Content Management properly.

For example, if an Oracle Content Management has been configured to use short paths, your sites are public, and a request is made to https://www.example.com/MySecondProjectSite/ the CDN must be configured to:

  • recognize the vanity domain: https://www.example.com/

  • specify the origin Oracle Content Management instance using the vanity domain: https://myinstance.cec.ocp.oraclecloud.com/

  • prepend /site/ to the path

  • send the full site URL to the origin Oracle Content Management instance: https://myinstance.cec.ocp.oraclecloud.com/site/MySecondProjectSite/

  • Oracle Content Management receives the request and responds to the CDN, which satisfies the request to the visitor's browser, showing only the vanity domain and site name: https://www.example.com/MySecondProjectSite/

If most of your sites are secure sites the same rules apply. Instead of prepending /site/ you need to prepend /site/authsite/.

Exception rules must be defined for all sites that are not the default type. Configure that exception rule to match on the specific site names so those requests can have the proper path appended rather than the default.

CDN configuration steps are often specific to the CDN, so work with your CDN provider to properly configure the desired behaviors.