Apache Ignite.NET Documentation

The Apache Ignite .NET Developer Hub

Welcome to the Apache Ignite .NET developer hub. You'll find comprehensive guides and documentation to help you start working with Apache Ignite.NET as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

ASP.NET Session State Caching

ASP.NET session state caching is designed to allow you to store user session data in different sources. By default, session state values and information are stored in memory within the ASP.NET process.

Ignite.NET implements a session state store provider that stores session data in the Ignite cache which distributes session state across multiple servers in order to provide high availability and fault tolerance.

Development and debugging

During development and debugging, IIS will dynamically detect code changes when you build and run your web application. This, however, does not restart the embedded Ignite instance and can cause exceptions and undesired behavior. Make sure to restart IIS manually when using the Ignite output cache.


Binary distribution: add a reference to Apache.Ignite.AspNet.dll
NuGet: Install-Package Apache.Ignite.AspNet


To enable Ignite-based session state storage, modify the web.config file as follows:

  <sessionState mode="Custom" customProvider="IgniteSessionStateProvider">
      <add name="IgniteSessionStateProvider"
           type="Apache.Ignite.AspNet.IgniteSessionStateStoreProvider, Apache.Ignite.AspNet"
           cacheName="aspNetSessionCache" />

name and type attributes are required, others are optional.



web.config section name defined in configSections. See Configuration: web.config for more details. This configuration will be used to start Ignite if it is not started yet.


Should only be used when multiple web applications share the same Ignite session state cache. Assign different ID strings to avoid session data conflicts between applications. It is recommended to use a separate cache for each application via cacheName attribute.


Session state provider calls Ignition.TryGetIgnite with this grid name to check whether Ignite is already started.


Session state cache name. Default is ASPNET_SESSION_STATE.

For more details on starting Ignite within an ASP.NET application, refer to ASP.NET Output Caching.

See ASP.NET Deployment for web deployment specifics related to IGNITE_HOME.

ASP.NET Session State Caching

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.