Rewrite rules
To make rewrite rules on Umbraco Cloud as seamless as possible, we've installed the IIS Rewrite Module on all our Umbraco Cloud servers.
The rewrite rules should be added to the
<system.webServer><rewrite> module in your projects Web.config file.If you are running Umbraco 9 and above on IIS, you can still add a
web.config file to configure IIS features such as URL rewrites. If you wish to use IIS rewrite rules, see the URL Rewrites in Umbraco article.<!--
<rewrite>
<rules></rules>
</rewrite>
-->
When you are doing rewrite rules on Umbraco Cloud there are a few important things to keep in mind:
- Always make sure that you add a condition that negates the Umbraco Backoffice -
/umbraco, otherwise you will not be able to do deployments to/from the environment - To be able to continue working locally with your Umbraco Cloud project, you also need to add a condition that negates
localhost
Once you've assigned a hostname to your Live environment, you may want to "hide" the project's default URL (e.g. mysite.s1.umbraco.io) for different reasons. Perhaps for SEO or to make it clear to your users that the site can be accessed using only one hostname.
One approach for this is to add a new rewrite rule to the
<system.webServer><rewrite><rules> section in the web.config file. For example, the following rule will redirect all requests for the project mysite.euwest01.umbraco.io URL to the mysite.com URL and respond with a permanent redirect status.<rule name="Redirects umbraco.io to actual domain" stopProcessing="true">
<match url=".*" />
<conditions>
<add input="{HTTP_HOST}" pattern="^(.*)?.euwest01.umbraco.io$" />
<add input="{REQUEST_URI}" negate="true" pattern="^/umbraco" />
<add input="{REQUEST_URI}" negate="true" pattern="^/DependencyHandler.axd" />
<add input="{REQUEST_URI}" negate="true" pattern="^/App_Plugins" />
<add input="{REQUEST_URI}" negate="true" pattern="localhost" />
</conditions>
<action type="Redirect" url="http://<your actual domain here>.com/{R:0}"
appendQueryString="true" redirectType="Permanent" />
</rule>
This will not rewrite anything under the
/umbraco path so that you can still do content deployments. You don't have to give your editors the umbraco.io URL, and they won't see the umbraco.io URL if you give them the actual hostname. This rule will also not apply to your local copy of the site running on localhost.Once you've applied a certificate to your site, you can make sure that anybody visiting your site will always end up on HTTPS instead of the insecure HTTP.
To accomplish this, add a rewrite rule to the live environment's
web.config in the <system.webServer><rewrite><rules> section.For example, the following rule will redirect all requests for the site http://mysite.com URL to the secure https://mysite.com URL and respond with a permanent redirect status.
<rule name="HTTP to HTTPS redirect" stopProcessing="true">
<match url="(.*)" />
<conditions>
<add input="{HTTPS}" pattern="off" ignoreCase="true" />
<add input="{HTTP_HOST}" pattern="localhost" negate="true" />
<add input="{REQUEST_URI}" negate="true" pattern="^/\.well-known/acme-challenge" />
</conditions>
<action type="Redirect" url="https://{HTTP_HOST}/{R:1}" redirectType="Permanent" />
</rule>
This redirect rule will not apply when the request is already going to the secure HTTPS URL. This redirect rule will also not apply to your local copy of the site running on
localhost.It is possible to transform all of your URLs to use a trailing slash consistently for SEO.
To accomplish this, add a rewrite rule to the Live environment's
web.config in the <system.webServer><rewrite><rules> section.For example, the following rule will redirect all requests for
https://mysite.com/page to https://mysite.com/page/, and respond with a permanent redirect status. This way you can ensure that you use the trailing slashes consistently on your site.<rule name="Add trailing slash" stopProcessing="true">
<match url="(.*[^/])$" />
<conditions>
<add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
<add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
<add input="{REQUEST_FILENAME}" pattern="(.*?)\.[a-zA-Z1-5]{1,4}$" negate="true" />
<add input="{REQUEST_URI}" pattern="^/umbraco" negate="true" />
<add input="{REQUEST_URI}" pattern="^/DependencyHandler.axd" negate="true" />
<add input="{REQUEST_URI}" pattern="^/App_Plugins" negate="true" />
<add input="{REQUEST_URI}" pattern="^/\.well-known/acme-challenge" negate="true" />
</conditions>
<action type="Redirect" url="{R:1}/" />
</rule>
Take note of the negates in the rewrite rule.
It is important to negate the path to files on your site because with the trailing slash added, your media will not show correctly after your site has been migrated to use Azure Blob Storage.
Another example would be to redirect from non-www to www:
<rule name="Redirect to www prefix" stopProcessing="true">
<match url=".*" />
<conditions>
<add input="{HTTP_HOST}" pattern="^www\." negate="true" />
<add input="{HTTP_HOST}" pattern=".*azurewebsites.net*" negate="true" ignoreCase="true" />
<add input="{HTTP_HOST}" pattern="^localhost(:[0-9]+)?$" negate="true" />
<add input="{HTTP_HOST}" pattern="\.umbraco\.io$" negate="true" />
</conditions>
<action type="Redirect" url="https://www.{HTTP_HOST}/{R:0}" />
</rule>
Adding the
.*azurewebsites.net* pattern is required for the deployment service and the content transfer between environments to continue to function.Last modified 26d ago