Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.umbraco.com/umbraco-cms/tutorials/custom-error-page below:

Implement Custom Error Pages | Umbraco CMS

1. Tutorials

A set of tutorials for creating and implementating custom error pages in an Umbraco CMS project.

Umbraco is built on Microsoft's .NET Framework and uses ASP.NET. This provides different options when setting up custom error pages on your website.

Implementing custom error handling can make your site look more on-brand and minimize the impact that errors have on user experience. For example, a custom 404 page with helpful links or a search function can add extra value to your site.

In Umbraco, in-code error page handling refers to managing and displaying custom error pages directly through code. This method provides greater flexibility and control over how errors are handled and presented to users, especially within the context of an Umbraco site.

This article contains guides on how to create custom error pages for the most common scenarios:

To follow this guide successfully, ensure you're using Umbraco version 16.1 or later, as it fixes a regression from version 16.0. For more details, see the Breaking changes section in the Release Notes.

A 404 error occurs when a requested page cannot be found, usually due to deleted content, a changed URL, or an invalid path. In Umbraco, you can create and configure custom 404 pages using content from the backoffice.

1. Go to the Settings section in the backoffice.

2. Create a new Document Type with Template.

3. Name the Document Type Page Not Found.

4. [Optional] Add custom properties (for example, title, message), though most 404 pages are static.

6. Go to the Templates folder and edit the generated template.

7. Add your custom markup and design for the error page in the template.

You can create a Page Not Found page directly in your content tree, or organize it within a container for error pages. Using a container allows for better content organization, especially if you plan to handle multiple status codes (for example, 404, 500, maintenance, and so on). Both options work as long as the page ID is referenced correctly in the appsettings.json file.

1. Create a new Document Type.

2. Name it Error Pages Container.

3. Go to the Structure Workspace view.

   • Add the Page Not Found Document Type as an Allowed child node types.

1. Go to the Content section.

2. Create a new content node based on the Error Pages Container Document Type. For example Home Page.

3. Click Save or Save and Publish.

1. Create a child node, using the Page Not Found Document Type.

2. Name it Page Not Found or similar.

   • This will be the content shown when a 404 error occurs.

3. Click Save or Save and Publish.

After publishing the Page Not Found page, connect it in the configuration:

1. Go to the Info tab of the Page Not Found content item in the Backoffice.

2. Copy the Id of the page (for example: 06cf09c8-c83a-4dd7-84e5-6d98d51e4d12).

3. Go to your project's appsettings.json file.

4. Add the Error404Collection setting to Umbraco:CMS:Content, like shown below:

{
    "Umbraco": {
        "CMS": {
            "Content": {
                "Error404Collection": [
                    {
                        "Culture": "default",
                        "ContentKey": "06cf09c8-c83a-4dd7-84e5-6d98d51e4d12"
                    }
                ]
            }
        }
    }
}

Replace the value for ContentKey with the ID of your own Page Not Found page.

You can define different error pages for each language or culture (such as en-us, da-dk, and so on):

"Error404Collection": [
  {
    "Culture": "en-us",
    "ContentKey": "guid-for-english-404"
  },
  {
    "Culture": "da-dk",
    "ContentKey": "guid-for-danish-404"
  }
]

Each entry maps a culture to its specific 404 page using the content’s GUID.

It is also possible to set up a 404 error page programmatically using IContentLastChanceFinder. To learn more about IContentLastChanceFinder, read the Custom Routing article.

Before following this example, follow the Create a Page Not Found page in the backoffice part. The example below will use the Page Not Found alias of the Document Type to find and display the error page.

1. Create a new .cs file called PageNotFound at the root of the project.

2. Add the following code to the newly created class:

using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.Routing;
using Umbraco.Cms.Core.Web;

namespace YourProjectNamespace;

public class PageNotFound : IContentLastChanceFinder
{
    private readonly IServiceProvider _serviceProvider;

    public PageNotFound(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }

    public Task<bool> TryFindContent(IPublishedRequestBuilder request)
    {
        using var scope = _serviceProvider.CreateScope();

        var umbracoContextAccessor = scope.ServiceProvider.GetRequiredService<IUmbracoContextAccessor>();

        if (!umbracoContextAccessor.TryGetUmbracoContext(out var umbracoContext))
        {
            return Task.FromResult(false);
        }

        var notFoundPage = umbracoContext
            .Content
            ?.GetAtRoot()
            .SelectMany(x => x.DescendantsOrSelf())
            .FirstOrDefault(c => c.ContentType.Alias == "pageNotFound");

        if (notFoundPage == null)
        {
            return Task.FromResult(false);
        }

        request.SetPublishedContent(notFoundPage);
        request.SetResponseStatus(404);
        return Task.FromResult(true);
    }
}

// Register the content finder
public class MyComposer : IComposer
{
    public void Compose(IUmbracoBuilder builder)
    {
        builder.SetContentLastChanceFinder<PageNotFound>();
    }
}

This section guides you in setting up a custom page for handling internal server errors (500 errors) in your Umbraco site. This setup works when:

• A template throws an error.

• A controller throws an unhandled exception.

• A request hits the application, but something fails during rendering or processing.

1. Go to the Settings section in the Umbraco backoffice.

2. Create a new Document Type with Template called ErrorPage500.

3. [Optional] Add any relevant properties to the Document Type.

5. Go to the Templates folder.

6. Add your custom markup and design for the error page in the template. In this case, ErrorPage500.

1. Create a new Document Type.

2. Name it Error Pages Container.

3. Go to the Structure Workspace view.

   • Add the ErrorPage500 Document Type as an Allowed child node types.

1. Go to the Content section.

2. Create a new content node based on the Error Pages Container Document Type. For example Home Page.

3. Click Save or Save and Publish.

4. Create a child node, using the ErrorPage500 Document Type.

5. Name it Page 500 or similar.

   • This will be the content shown when a 500 error occurs.

To ensure that the 500 page is shown during server errors, you’ll need to configure a custom error controller and route handling.

1. Create a folder called Controllers in the root of your Umbraco project.

2. Add a new file called ErrorController.cs in the Controllers folder.

3. Add the following code to the file:

using Microsoft.AspNetCore.Mvc;

namespace YourProjectNamespace.Controllers;

public class ErrorController : Controller
{
    [Route("Error")]
    public IActionResult Index()
    {
        if (Response.StatusCode == StatusCodes.Status500InternalServerError)
        {
            return Redirect("/statuscodes/500");
        }
        else if (Response.StatusCode != StatusCodes.Status200OK)
        {
            return Redirect("/statuscodes");
        }
        return Redirect("/");
    }
}

Replace YourProjectNamespace with the actual project namespace. In Visual Studio, you can right-click the project and select Sync Namespaces.

1. Add the /error/ route to the list of reserved paths in the appSettings.json file:

"Umbraco": {
"CMS": {
    "Global": {
    "ReservedPaths": "~/app_plugins/,~/install/,~/mini-profiler-resources/,~/umbraco/,~/error/",
    ...
    }
  }
}

1. Update Program.cs to ensure the error route is triggered by unhandled exceptions:

WebApplication app = builder.Build();

if (builder.Environment.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
}
else
{
    app.UseExceptionHandler("/error");
}

To test locally, replace app.UseDeveloperExceptionPage(); with app.UseExceptionHandler("/error");. Otherwise, you'll get the default .NET error page during development.

To trigger a 500 error on your site, try introducing a rendering error:

For example, if a Document Type has a property called test, it is normally rendered as:

To trigger a 500 error, modify it to:

This will generate a server-side error, allowing you to verify that your custom 500 page is displayed correctly.

When Umbraco fails to start, you may see a blank screen or receive a 500.30 or 502.5 error. These indicate the web application crashed or failed to initialize.

During startup, Umbraco relies on the ASP.NET Core pipeline. If the app crashes before this pipeline is fully initialized, it can't handle requests or serve custom error pages. That's why you can't rely on Umbraco or ASP.NET Core routing to show error content at this point as it has already failed. For more information, see the Handle errors in ASP.NET Core documentation.

Instead, the web server itself (IIS, NGINX, Apache, and so on) must serve a static fallback 500 page. This page is independent of the application and helps communicate the issue to users when the site is down.

To handle these types of issues:

• Configure your web server (IIS, NGINX, Apache) to serve a static HTML 500 page when the app fails to respond.

• Use uptime monitoring to catch failed starts.

• Check Umbraco logs in App_Data/Logs for startup errors.

Sometimes you might experience issues with booting up your Umbraco project. This could be a brand new project, or it could be an existing project after an upgrade.

You will be presented with a generic error page when there is an error during boot.

You can replace the default BootFailed page with a custom static BootFailed.html. Follow the steps below to set it up:

2. Navigate to wwwroot/config/errors

   1. If this folder does not exist already, create it.

3. Add a new file called BootFailed.html.

4. Add your custom markup to the file.

The BootFailed.html page will only be shown if debugging is disabled in the appsettings.json file. Debugging is handled using the Debug key under Umbraco:CMS:Hosting:

{
    "Umbraco": {
        "CMS": {
            "Hosting": {
                "Debug": false
            }
        }
    }
}

The full error can always be found in the log file.

If you set up everything correctly and the error pages are not showing correctly, make sure that you are not using

• Any packages that allow you to customize redirects, or

• Rewrite rules that might interfere with custom error handling.

If your code or any packages configure a custom IContentLastChanceFinder, the settings in appSettings.json will not be used.

For common approaches to handling errors in ASP.NET Core web apps, see the Handle errors in ASP.NET Core article in the Microsoft Documentation.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4