Client Configuration Files
NCache client configuration files provide the settings required by client applications and client-side components. These files can define cache server addresses, connection behavior, security credentials, TLS settings, and monitoring options.
The location of these files depends on how the NCache client is deployed:
- With the NCache SDK packages only.
- Through a complete NCache Client installation.
SDK-Only Deployment
When an application uses only the NCache SDK or NuGet packages, the required configuration files are deployed with the application or placed in the directory expected by the selected SDK. This deployment model does not require the complete NCache Client installation and is suitable when:
- The application includes the required NCache client libraries.
- Cache server details are provided through configuration files or client connection options.
- Client-side remote management is not required.
- An OutProc Client Cache is not used.
The application must be able to locate and read the required configuration files when it starts.
NCache Client Installation
When NCache is installed using the Client installation type, the client configuration files are placed in the NCache configuration directory.
| Platform | Configuration Directory |
|---|---|
| Windows | %NCHOME%\config |
| Linux | /opt/ncache/config |
These files can be used by client applications, NCache tools, client-side services, and management components running on the machine.
Client Configuration Files
The following files are commonly used on an NCache client machine:
client.ncconf
The client.ncconf file contains cache connection information used by NCache client applications. It can include:
- Cache server names or IP addresses.
- Client and server communication ports.
- Connection retries.
- Retry intervals.
- Connection and operation timeouts.
- Other cache-specific client connection settings.
The NCache client uses this information to discover and connect to the configured cache servers.
security.ncconf
The security.ncconf file contains client-side security settings used when authentication and authorization are enabled for NCache. It allows the client application or NCache component to use the security information required to connect to a secured cache.
Important
Protect this file from unauthorized access because it can contain security-related configuration.
tls.ncconf
The tls.ncconf file contains the TLS configuration used to secure communication between NCache clients and cache servers. It can define:
- Whether TLS is enabled.
- Server and client certificate names.
- Certificate thumbprints.
- Client-server TLS settings.
- Mutual TLS settings.
- TLS protocol selection.
- PFX certificate information required by supported client platforms.
This file is required on client machines when TLS settings are not supplied through another supported configuration mechanism.
monitoring.ncconf
The monitoring.ncconf file contains settings used by NCache monitoring components on the client machine. These settings support the collection and reporting of client-side monitoring information.
