Installation Guide for Linux

The NCache Linux installation is a streamlined process designed for .NET development and production environments. This guide covers automated prerequisite configuration, terminal-based deployment using tar.gz packages, and administrative commands for different operation modes.

Prerequisites for NCache on Linux

Important

Before installing NCache on Linux, make sure that .NET 10 and PowerShell 7.6.2 LTS are installed on the target machine.

NCache provides a custom script that includes the logic to automatically install the prerequisites required to install NCache on your machine. You can download this installation script from Alachisoft. After that, you will need to make the file executable by using the following command. Please note that these prerequisites are only necessary for NCache Enterprise. For NCache Open Source, these are already part of the tar.gz file.

chmod u+x install-ncache-prereqs.sh

After downloading, execute the following command on your Linux machine inside the directory where the script is present to run it:

sudo ./install-ncache-prereqs.sh

Executing this command will ensure the prerequisites are installed on your machine.

NCache Installation for Linux Machine

NCache provides a tar.gz file for installing NCache on your Linux machine through the terminal.

  • In the terminal, extract the tar.gz file through the following command:
tar -zxf <Path to tar.gz file>
Note

After extraction, the installation scripts are placed in the folder named ncache-enterprise for Enterprise and ncache-oss for Open Source.

  • In the terminal, go to the directory that contains the NCache installation script.
cd ncache-enterprise
Note

The sudo command grants you the Admin rights and privileges to run NCache scripts.

  • For detailed installation usage, run the following command in your terminal:
sudo ./install -h
  • Alternatively, choose the installation type, such as Server, Client, or Developer Mode. For example,
sudo ./install -k XXXXXXXXXXXXXXXXX -m server -s yes -i 20.200.20.38 -P pass123
  • This initiates the NCache installation.

NCache .NET Installation

Note
  • NCache is installed in the /opt/ncache folder by default.
  • Once NCache is installed, the NCache Service starts automatically.

Please note that the installation modes discussed below are only for NCache Enterprise.

Server Mode

For NCache server mode installation, run the following command. Notice that -m server indicates Cache Server installation.

sudo ./install -k XXXXXXXXXXXXXXXXX -m server -s yes -i 20.200.20.38 -P pass123
Warning

If you miss any required field for the selected installation mode, an installation error will occur.

Client Mode

Installing NCache Client involves the same steps as Server mode. To differentiate, simply write -m client instead of -m server.

sudo ./install -k XXXXXXXXXXXXXXXXX -m client -P pass123
Warning

If you miss any required field for the selected installation mode, an installation error will occur.

Developer Mode

Installing NCache Developer mode involves the same steps as Client mode. To differentiate, simply write -m dev instead of -m client.

sudo ./install -k XXXXXXXXXXXXXXXXX -m dev -P pass123
Warning

If you miss any required field for the selected installation mode, an installation error will occur.

Uninstall NCache from Linux Machine

For uninstallation, go to the ncache-enterprise directory for Enterprise, where all the necessary scripts are placed. For Open Source, go to the ncache-oss directory.

cd ncache-enterprise
  • In the terminal, execute the following command:
sudo ./uninstall
  • You will be asked a Yes/No question to confirm uninstallation, simply reply with y.

NCache .NET Uninstall

Installer Reference for Linux

The following properties are supported by NCache installation after extracting the tar.gz package:

Note

Properties with * are required properties.

Switch/Properties Purpose Default Value
-k, --installkey* The key you are provided with upon downloading NCache. -
-m, --installmode (not for Open Source) Specifies the installation type. Possible values are: -server (Cache Server).
-client (Cache Client).
-dev (Developer Mode).		 server (Cache Server)
-s, --startcache (not for Open Source) Switch parameter to auto start the demoCache at the end of installation. Possible values are: --s yes start the cache.
--s no do not start the cache.		 Start cache.
-i, --ipaddress IP address that NCache Service binds to. IP of the local machine.
-p, --installpath Installation path. /opt/ncache
-F, --force Force create a destination directory if the provided directory does not exist. -
-P, --password* Specifies the password to use during NCache installation. -
-t, --enableptrace Allows ncache users to take memory dumps of processes running under their ownership. Possible values are: - -t true Allows the createDump tool to read NCache process memory.
--t false Prevents the createDump tool from reading NCache process memory.		 False
Note

If you encounter any issues during installation, please refer to the troubleshooting section.

See Also

Evaluation Period Management
License Management