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 for applications that include the required client packages and configuration files.

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 access to client configuration and monitoring capabilities.

Use this model when administrators need to manage 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 the package dependencies with it. This approach is suitable when:

  • The full NCache Client installation is not required.
  • The application only needs to connect to a remote cache.
  • Client connection settings are supplied through configuration files or APIs.
  • Client deployment must remain part of the application build and release process.
  • Centralized client management is not required.

Place the client configuration files in the application directory or the output location in which the NCache package expects them.

For an SDK-only Windows deployment, the typical location is:

<Application Directory>\

When the NCache Remote Client is installed, the files are stored in:

%NCHOME%\config

Linux VM

On a Linux virtual machine, the application can use an installed NCache Client or include the required NCache packages and configuration files in its own 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 maintain client-related settings and monitor client activity without relying entirely on files deployed with the application.

Embed with Client Application

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

Use this approach when:

  • The application includes all required NCache assemblies.
  • Cache server addresses are supplied through client.ncconf or connection options.
  • The application does not require centralized client management.
  • Client configuration is maintained through the application deployment pipeline.

For an SDK-only Linux deployment, keep the configuration files in the application directory:

<Application Directory>/

When the NCache Client is installed, the files are stored in:

/opt/ncache/config

The standard installed-client configuration directories are %NCHOME%\config on Windows and /opt/ncache/config on Linux.

See Also

Windows Installation
Linux Installation
Create Client Cache with NuGet Packages