Modules Config

Modules configuration file contains information regarding all registered modules. This config file is installed with NCache and is placed at %NCHOME%/log-files (Windows) or \opt\ncache\log-files (Linux). Parameters updated from this file will be shown in the Web Manager and populated in the config.ncconf after the configuration has been applied to the cache. Similarly, the parameters against the added modules are also loaded from the modules.ncconf file.

modules.ncconf is explained below:

<configuration>
  <caching-modules>
    <module name="lucene-net-4.8" title="Full Text Search Index" Description="Full Text Search Index or Lucene Indexing Module is a distributed solution for Lucene.Net. This feature is only supported for Partitioned-Replica and Partitioned topologies. Enabling this feature will allow you to use Distributed Lucene API for Text-Searching." assembly-name="Alachisoft.NCache.Lucene.CachingModule.dll" class-name="Alachisoft.NCache.LuceneCachingModule.LuceneCachingModule" full-name="Alachisoft.NCache.Lucene.CachingModule.dll">
      <parameters>
        <parameter name="IndexPath" value="[NCacheInstallDirectory]\bin\modules\data\lucene" Description="By default, index directories are generated at [NCacheInstallDirectory]\bin\modules\data\lucene. If you want these indexes to be generated at a different location, please specify a valid path in following input box. Please make sure that this path exists on all cache server(s) and no other index writer is locking the directory."/>
      </parameters>
    </module>
  </caching-modules>
</configuration>

Under the <module> tag, you have:

name: is the module identifier. The module will be identified by whatever name you provide here. This name needs to be unique.

title: is the name of the module that needs to be registered against a cache. Once registered, you will find this module as a tab in the Web Manager.

Description: lets you add any information regarding the registered module. This description will be visible in the Web Manager.

assembly-name: is the name of the specified module's assembly.

class-name: is the class of the caching module.

full-name: is the full name of the module's assembly.

Under the <parameter> tag, you have:

name: is a parameter tag to show that you will be providing the Index Path.

value: is the value of the parameter name mentioned earlier. In this case, this tag takes the path where index directories need to be generated.

Description: lets you add any information regarding the parameters added. This description will be visible in the Web Manager.

Modules Config

See Also