Deploy Client

An application can connect to NCache by installing the NCache Client on its host machine or by deploying the required NCache client libraries with the application.

Choose the deployment method according to whether the application requires an independently running Client Cache, centralized client management, monitoring, or only the client APIs required to communicate with the cache cluster.

Note

Installing the NCache Client is optional when the application includes the required NCache client packages and provides the information required to establish the initial connection with the cache.

Windows

On Windows, deploy the client by installing the Remote Client option or by packaging the NCache client libraries with the application.

Install Client (Optional)

The NCache Remote Client installation places the NCache client components, services, tools, and configuration files on the application machine.

Install the Remote Client when you require:

  • An OutProc Client Cache.
  • Client monitoring through NCache monitoring tools.
  • Client management through the NCache Management Center.
  • Client/Server licensing.

These capabilities require client-side components beyond the libraries used directly by the application.

OutProc Client Cache

An OutProc Client Cache runs separately from the client application. Multiple application processes on the same machine can use the independently running Client Cache while keeping its lifecycle separate from the application processes.

Use an installed NCache Client when the OutProc Client Cache must be managed and monitored as part of the NCache deployment.

Client Management

An installed client machine can be added as a client node and managed through the NCache Management Center. This provides centralized client-node management and monitoring capabilities.

Use this model when administrators need to manage and monitor client machines independently of application deployment.

Embed with Client Application

For a lightweight deployment, add the required NCache NuGet package to the application and publish its dependencies with the application.

This approach is suitable when:

  • The full NCache Client installation is not required.
  • The application only needs to connect to a remote cache.
  • The application provides the cache name, cache server endpoints, and security credentials where required.
  • Client deployment remains part of the application build and release process.
  • Centralized client-node management is not required.

After the client connects to the cache, applicable client runtime settings are provided by the cache server. These settings include client logging, connection behavior, performance counters, and other supported client configuration.

An SDK-only deployment does not require a local client.ncconf file. Cache-specific client runtime settings are maintained on the cache server and provided to the application after it connects.

Linux VM

On a Linux virtual machine, the application can use an installed NCache Client or include the required NCache client packages directly in its application deployment.

Install Client (Optional)

Install NCache in Client mode when the Linux application machine requires client-side services and management capabilities.

An installed client is suitable when you require:

  • An OutProc Client Cache.
  • Client monitoring.
  • Centralized client-node management.
  • Client/Server licensing.
  • NCache tools that operate from the application machine.

The Linux Client installation places the NCache binaries, tools, and configuration files under the NCache installation directory.

OutProc Client Cache

An OutProc Client Cache runs outside the application process and can be shared by applications running on the same Linux machine.

Use this model when the Client Cache must remain available independently of an individual application process or must be administered as a separate NCache component.

Client Management

Installing the client allows the Linux machine to participate as a managed NCache client node. Administrators can centrally manage the client node and monitor client activity through NCache management tools.

Embed with Client Application

An application hosted on Linux can use NCache without a complete client installation by including the required NCache packages in its published output.

Use this approach when:

  • The application includes all required NCache client assemblies.
  • The application provides the cache name, cache server endpoints, and security credentials where required.
  • The application does not require centralized client-node management.
  • Client deployment is managed through the application build and release process.

After the application connects to the cache, applicable client runtime settings are provided by the cache server. These settings include client logging, connection behavior, performance counters, and other supported client configuration.

An SDK-only deployment does not require a local client.ncconf file. Cache-specific client runtime settings are maintained on the cache server and provided to the application after it connects.

See Also

Windows Installation
Linux Installation
Create Client Cache with NuGet Packages