NCache.AspNetCore.OutputCaching 5.3.7

NCache Output Cache Provider for ASP.NET Core

NCache Output Cache Provider for ASP.NET Core applications. This package lets you use NCache as the backing store for ASP.NET Core Output Caching, allowing cached HTTP responses to be shared across multiple application instances instead of being stored in memory on individual servers.

Installation

Install-Package NCache.AspNetCore.OutputCaching

or, using the .NET CLI:

dotnet add package NCache.AspNetCore.OutputCaching

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

• ASP.NET Core (.NET 8) and (.NET 10) 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

1. Register ASP.NET Core Output Caching:

builder.Services.AddOutputCache();

2. Register the NCache Output Cache provider using either:

   • Configuration — bind settings from appsettings.json.
   • Programmatic Configuration — configure the options directly in code (see Configuration section below).

3. Enable Output Cache middleware:

app.UseOutputCache();

4. Mark endpoints as cacheable using ASP.NET Core's standard [OutputCache] attribute or .CacheOutput() extension methods.

Configuration

Using appsettings.json:

{
  "NCacheOutputCache": {
    "CacheName": "demoCache",
    "ServerList": [
      {
        "Ip": "20.200.20.29"
      }
    ],
    "EnabledLogs": true,
    "EnableDetailLogs": true,
    "ConnectionString": "User Id=cache_user;Password=cache_pass;Data Source=localhost:1521/XEPDB1;"
  }
}

Register the provider:

builder.Services.AddOutputCache();

builder.Services.AddNCacheOutputCacheProvider(
    builder.Configuration.GetSection("NCacheOutputCache"));

Or configure programmatically:

builder.Services.AddOutputCache();

builder.Services.AddNCacheOutputCacheProvider(options =>
{
    options.CacheName = "demoCache";

    options.ServerList = new List<NCacheOutputCacheOptions.ServerConfig>
        {
            new NCacheOutputCacheOptions.ServerConfig
            {
                Ip = "20.200.20.29"
            }
        };

    options.EnabledLogs = true;
    options.EnableDetailLogs = true;
    options.ConnectionString = "User Id=cache_user;Password=cache_pass;Data Source=localhost:1521/XEPDB1;";
});

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

Note

AddOutputCache() is still required. AddNCacheOutputCacheProvider() replaces only the backing store used by ASP.NET Core Output Caching.

Resources

• NCache Integration Docs
• Microsoft Outputcache Documentation
• 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.