AspNetCore.SignalR.NCache 5.3.7

AspNetCore.SignalR.NCache

NCache Backplane Provider for ASP.NET Core SignalR applications. This package lets you use NCache as a scale-out backplane for SignalR, enabling real-time messages to be reliably broadcast across multiple SignalR server instances in a web farm — so clients connected to different servers still receive the same messages.

Installation

Install-Package AspNetCore.SignalR.NCache

or, using the .NET CLI:

dotnet add package AspNetCore.SignalR.NCache

What is Installed

Installing this package adds the following NCache configuration files to your project:

• client.ncconf — Defines the cache client settings, including the cache name and the list of server nodes the client connects to.
• config.ncconf — Contains the cache configuration (cache topology, partitions, eviction policy, etc.) used when the cache is created/registered.
• tls.ncconf — Contains TLS/SSL settings used to secure communication between the client and the NCache cluster, if enabled.

Prerequisites

• .NET 6.0+ Application.
• An NCache 5.3.7 (or later) server should be up and running, with the target cache already created/registered on it.

Getting Started

Setting up NCache

Before running your application (if NCache is not installed on the current machine), you need to update client.ncconf so the client knows which cache to connect to and where to find it:

1. Open client.ncconf.
2. Locate the cache entry named myCache and rename it to the name of your actual cache (the cache you created/registered on the NCache server).
3. Under the server settings, update the server address to point to one of the nodes in the cluster where that cache is running.

Example:

<cache id="myCache" ... >
  <server name="10.0.0.1" ... />
</cache>

Change myCache → YourCacheName, and 10.0.0.1 → the IP/hostname of a node hosting YourCacheName.

Setting up Package

Modify Program.cs to configure SignalR to use NCache as a backplane:

using Alachisoft.NCache.AspNetCore.SignalR;

var builder = WebApplication.CreateBuilder(args);

// Bind NCache configuration section
builder.Services.Configure<NCacheConfiguration>(
    builder.Configuration.GetSection("NCacheConfiguration"));

// Register SignalR with NCache backplane
builder.Services.AddSignalR().AddNCache(ncacheOptions =>
{
    ncacheOptions.CacheName = builder.Configuration["NCacheConfiguration:CacheName"];
    ncacheOptions. EventKey = builder.Configuration["NCacheConfiguration: EventKey"];
});

var app = builder.Build();

// Map your SignalR hub endpoint directly 
app.MapHub<YourSignalRHub>("/your-hub");

app.Run();

Configuration

ASP.NET Core (appsettings.json):

{
  "NCacheConfiguration": {
    "CacheName": "demoCache",
    "EventKey": "chat",
  }
}

Adjust cache name and other settings as needed for your environment.

Resources

• NCache Integration Docs
• Sample Code on GitHub
• Programmer's Guide

Technical Support

Alachisoft provides various technical support resources.

Visit the Alachisoft Support Center to select a support resource appropriate for your issue. To request additional features or report a documentation discrepancy, contact support@alachisoft.com.

License

Copyright © 2026 Alachisoft. All rights reserved.