Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Note
This isn't the latest version of this article. For the current release, see the .NET 9 version of this article.
Warning
This version of ASP.NET Core is no longer supported. For more information, see the .NET and .NET Core Support Policy. For the current release, see the .NET 9 version of this article.
Important
This information relates to a pre-release product that may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
For the current release, see the .NET 9 version of this article.
This article explains how to host and deploy server-side Blazor apps (Blazor Web Apps and Blazor Server apps) using ASP.NET Core.
Host configuration values
Server-side Blazor apps can accept Generic Host configuration values.
Deployment
Using a server-side hosting model, Blazor is executed on the server from within an ASP.NET Core app. UI updates, event handling, and JavaScript calls are handled over a SignalR connection.
A web server capable of hosting an ASP.NET Core app is required. Visual Studio includes a server-side app project template. For more information on Blazor project templates, see ASP.NET Core Blazor project structure.
Publish an app in Release configuration and deploy the contents of the bin/Release/{TARGET FRAMEWORK}/publish
folder, where the {TARGET FRAMEWORK}
placeholder is the target framework.
Scalability
When considering the scalability of a single server (scale up), the memory available to an app is likely the first resource that the app exhausts as user demands increase. The available memory on the server affects the:
- Number of active circuits that a server can support.
- UI latency on the client.
For guidance on building secure and scalable server-side Blazor apps, see the following resources:
- Threat mitigation guidance for ASP.NET Core Blazor static server-side rendering
- Threat mitigation guidance for ASP.NET Core Blazor interactive server-side rendering
Each circuit uses approximately 250 KB of memory for a minimal Hello World-style app. The size of a circuit depends on the app's code and the state maintenance requirements associated with each component. We recommend that you measure resource demands during development for your app and infrastructure, but the following baseline can be a starting point in planning your deployment target: If you expect your app to support 5,000 concurrent users, consider budgeting at least 1.3 GB of server memory to the app (or ~273 KB per user).
SignalR configuration
SignalR's hosting and scaling conditions apply to Blazor apps that use SignalR.
For more information on SignalR in Blazor apps, including configuration guidance, see ASP.NET Core Blazor SignalR guidance.
Transports
Blazor works best when using WebSockets as the SignalR transport due to lower latency, better reliability, and improved security. Long Polling is used by SignalR when WebSockets isn't available or when the app is explicitly configured to use Long Polling.
A console warning appears if Long Polling is utilized:
Failed to connect via WebSockets, using the Long Polling fallback transport. This may be due to a VPN or proxy blocking the connection.
Global deployment and connection failures
Recommendations for global deployments to geographical data centers:
- Deploy the app to the regions where most of the users reside.
- Take into consideration the increased latency for traffic across continents. To control the appearance of the reconnection UI, see ASP.NET Core Blazor SignalR guidance.
- Consider using the Azure SignalR Service.
Azure App Service
Hosting on Azure App Service requires configuration for WebSockets and session affinity, also called Application Request Routing (ARR) affinity.
Note
A Blazor app on Azure App Service doesn't require Azure SignalR Service.
Enable the following for the app's registration in Azure App Service:
- WebSockets to allow the WebSockets transport to function. The default setting is Off.
- Session affinity to route requests from a user back to the same App Service instance. The default setting is On.
- In the Azure portal, navigate to the web app in App Services.
- Open Settings > Configuration.
- Set Web sockets to On.
- Verify that Session affinity is set to On.
Azure SignalR Service
The optional Azure SignalR Service works in conjunction with the app's SignalR hub for scaling up a server-side app to a large number of concurrent connections. In addition, the service's global reach and high-performance data centers significantly aid in reducing latency due to geography.
The service isn't required for Blazor apps hosted in Azure App Service or Azure Container Apps but can be helpful in other hosting environments:
- To facilitate connection scale out.
- Handle global distribution.
The Azure SignalR Service with SDK v1.26.1 or later supports SignalR stateful reconnect (WithStatefulReconnect).
In the event that the app uses Long Polling or falls back to Long Polling instead of WebSockets, you may need to configure the maximum poll interval (MaxPollIntervalInSeconds
, default: 5 seconds, limit: 1-300 seconds), which defines the maximum poll interval allowed for Long Polling connections in the Azure SignalR Service. If the next poll request doesn't arrive within the maximum poll interval, the service closes the client connection.
For guidance on how to add the service as a dependency to a production deployment, see Publish an ASP.NET Core SignalR app to Azure App Service.
For more information, see:
- Azure SignalR Service
- What is Azure SignalR Service?
- ASP.NET Core SignalR production hosting and scaling
- Publish an ASP.NET Core SignalR app to Azure App Service
Azure Container Apps
For a deeper exploration of scaling server-side Blazor apps on the Azure Container Apps service, see Scaling ASP.NET Core Apps on Azure. The tutorial explains how to create and integrate the services required to host apps on Azure Container Apps. Basic steps are also provided in this section.
Configure Azure Container Apps service for session affinity by following the guidance in Session Affinity in Azure Container Apps (Azure documentation).
The ASP.NET Core Data Protection (DP) service must be configured to persist keys in a centralized location that all container instances can access. The keys can be stored in Azure Blob Storage and protected with Azure Key Vault. The DP service uses the keys to deserialize Razor components. To configure the DP service to use Azure Blob Storage and Azure Key Vault, reference the following NuGet packages:
Azure.Identity
: Provides classes to work with the Azure identity and access management services.Microsoft.Extensions.Azure
: Provides helpful extension methods to perform core Azure configurations.Azure.Extensions.AspNetCore.DataProtection.Blobs
: Allows storing ASP.NET Core Data Protection keys in Azure Blob Storage so that keys can be shared across several instances of a web app.Azure.Extensions.AspNetCore.DataProtection.Keys
: Enables protecting keys at rest using the Azure Key Vault Key Encryption/Wrapping feature.
Note
For guidance on adding packages to .NET apps, see the articles under Install and manage packages at Package consumption workflow (NuGet documentation). Confirm correct package versions at NuGet.org.
Update
Program.cs
with the following highlighted code:using Azure.Identity; using Microsoft.AspNetCore.DataProtection; using Microsoft.Extensions.Azure; var builder = WebApplication.CreateBuilder(args); var BlobStorageUri = builder.Configuration["AzureURIs:BlobStorage"]; var KeyVaultURI = builder.Configuration["AzureURIs:KeyVault"]; builder.Services.AddRazorPages(); builder.Services.AddHttpClient(); builder.Services.AddServerSideBlazor(); builder.Services.AddAzureClientsCore(); builder.Services.AddDataProtection() .PersistKeysToAzureBlobStorage(new Uri(BlobStorageUri), new DefaultAzureCredential()) .ProtectKeysWithAzureKeyVault(new Uri(KeyVaultURI), new DefaultAzureCredential()); var app = builder.Build(); if (!app.Environment.IsDevelopment()) { app.UseExceptionHandler("/Error"); app.UseHsts(); } app.UseHttpsRedirection(); app.UseStaticFiles(); app.UseRouting(); app.UseAuthorization(); app.MapRazorPages(); app.Run();
The preceding changes allow the app to manage the DP service using a centralized, scalable architecture. DefaultAzureCredential discovers the container app managed identity after the code is deployed to Azure and uses it to connect to blob storage and the app's key vault.
To create the container app managed identity and grant it access to blob storage and a key vault, complete the following steps:
- In the Azure Portal, navigate to the overview page of the container app.
- Select Service Connector from the left navigation.
- Select + Create from the top navigation.
- In the Create connection flyout menu, enter the following values:
- Container: Select the container app you created to host your app.
- Service type: Select Blob Storage.
- Subscription: Select the subscription that owns the container app.
- Connection name: Enter a name of
scalablerazorstorage
. - Client type: Select .NET and then select Next.
- Select System assigned managed identity and select Next.
- Use the default network settings and select Next.
- After Azure validates the settings, select Create.
Repeat the preceding settings for the key vault. Select the appropriate key vault service and key in the Basics tab.
IIS
When using IIS, enable:
For more information, see the guidance and external IIS resource cross-links in Publish an ASP.NET Core app to IIS.
Kubernetes
Create an ingress definition with the following Kubernetes annotations for session affinity:
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
name: <ingress-name>
annotations:
nginx.ingress.kubernetes.io/affinity: "cookie"
nginx.ingress.kubernetes.io/session-cookie-name: "affinity"
nginx.ingress.kubernetes.io/session-cookie-expires: "14400"
nginx.ingress.kubernetes.io/session-cookie-max-age: "14400"
Linux with Nginx
Follow the guidance for an ASP.NET Core SignalR app with the following changes:
- Change the
location
path from/hubroute
(location /hubroute { ... }
) to the root path/
(location / { ... }
). - Remove the configuration for proxy buffering (
proxy_buffering off;
) because the setting only applies to Server-Sent Events (SSE), which aren't relevant to Blazor app client-server interactions.
For more information and configuration guidance, consult the following resources:
- ASP.NET Core SignalR production hosting and scaling
- Host ASP.NET Core on Linux with Nginx
- Configure ASP.NET Core to work with proxy servers and load balancers
- NGINX as a WebSocket Proxy
- WebSocket proxying
- Consult developers on non-Microsoft support forums:
Linux with Apache
To host a Blazor app behind Apache on Linux, configure ProxyPass
for HTTP and WebSockets traffic.
In the following example:
- Kestrel server is running on the host machine.
- The app listens for traffic on port 5000.
ProxyPreserveHost On
ProxyPassMatch ^/_blazor/(.*) http://localhost:5000/_blazor/$1
ProxyPass /_blazor ws://localhost:5000/_blazor
ProxyPass / http://localhost:5000/
ProxyPassReverse / http://localhost:5000/
Enable the following modules:
a2enmod proxy
a2enmod proxy_wstunnel
Check the browser console for WebSockets errors. Example errors:
- Firefox can't establish a connection to the server at ws://the-domain-name.tld/_blazor?id=XXX
- Error: Failed to start the transport 'WebSockets': Error: There was an error with the transport.
- Error: Failed to start the transport 'LongPolling': TypeError: this.transport is undefined
- Error: Unable to connect to the server with any of the available transports. WebSockets failed
- Error: Cannot send data if the connection is not in the 'Connected' State.
For more information and configuration guidance, consult the following resources:
- Configure ASP.NET Core to work with proxy servers and load balancers
- Apache documentation
- Consult developers on non-Microsoft support forums:
Measure network latency
JS interop can be used to measure network latency, as the following example demonstrates.
MeasureLatency.razor
:
@inject IJSRuntime JS
<h2>Measure Latency</h2>
@if (latency is null)
{
<span>Calculating...</span>
}
else
{
<span>@(latency.Value.TotalMilliseconds)ms</span>
}
@code {
private DateTime startTime;
private TimeSpan? latency;
protected override async Task OnAfterRenderAsync(bool firstRender)
{
if (firstRender)
{
startTime = DateTime.UtcNow;
var _ = await JS.InvokeAsync<string>("toString");
latency = DateTime.UtcNow - startTime;
StateHasChanged();
}
}
}
@inject IJSRuntime JS
<h2>Measure Latency</h2>
@if (latency is null)
{
<span>Calculating...</span>
}
else
{
<span>@(latency.Value.TotalMilliseconds)ms</span>
}
@code {
private DateTime startTime;
private TimeSpan? latency;
protected override async Task OnAfterRenderAsync(bool firstRender)
{
if (firstRender)
{
startTime = DateTime.UtcNow;
var _ = await JS.InvokeAsync<string>("toString");
latency = DateTime.UtcNow - startTime;
StateHasChanged();
}
}
}
@inject IJSRuntime JS
<h2>Measure Latency</h2>
@if (latency is null)
{
<span>Calculating...</span>
}
else
{
<span>@(latency.Value.TotalMilliseconds)ms</span>
}
@code {
private DateTime startTime;
private TimeSpan? latency;
protected override async Task OnAfterRenderAsync(bool firstRender)
{
if (firstRender)
{
startTime = DateTime.UtcNow;
var _ = await JS.InvokeAsync<string>("toString");
latency = DateTime.UtcNow - startTime;
StateHasChanged();
}
}
}
@inject IJSRuntime JS
<h2>Measure Latency</h2>
@if (latency is null)
{
<span>Calculating...</span>
}
else
{
<span>@(latency.Value.TotalMilliseconds)ms</span>
}
@code {
private DateTime startTime;
private TimeSpan? latency;
protected override async Task OnAfterRenderAsync(bool firstRender)
{
if (firstRender)
{
startTime = DateTime.UtcNow;
var _ = await JS.InvokeAsync<string>("toString");
latency = DateTime.UtcNow - startTime;
StateHasChanged();
}
}
}
@inject IJSRuntime JS
@if (latency is null)
{
<span>Calculating...</span>
}
else
{
<span>@(latency.Value.TotalMilliseconds)ms</span>
}
@code {
private DateTime startTime;
private TimeSpan? latency;
protected override async Task OnAfterRenderAsync(bool firstRender)
{
if (firstRender)
{
startTime = DateTime.UtcNow;
var _ = await JS.InvokeAsync<string>("toString");
latency = DateTime.UtcNow - startTime;
StateHasChanged();
}
}
}
For a reasonable UI experience, we recommend a sustained UI latency of 250 ms or less.
ASP.NET Core