Installation Guide for Linux

This section provides details about the installation, prerequisites, and system configuration to install NCache Enterprise on Linux. This guide will also help you set up and configure your environment accordingly.

Prerequisites to Install NCache on Linux Machine

Before you install NCache on your Linux machine, make sure that your machine fulfills the following requirements:

  • Your Linux machine has .NET 6.0 installed.
  • Your Linux machine has PowerShell version 5.1 or any version till 7.3.9.

If your machine does not fulfill the above-mentioned criterion, you can follow these steps to ensure your machine is ready to install NCache.

Manual Installation of Prerequisites for Linux Machine

Prerequisites Installation Through Script for Linux 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.

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 Enterprise 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.

  • In the terminal, go to the directory where the NCache installation script is placed.
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, pick the type of installation you want like Server, Client, or Developer Mode. For example,
sudo ./install -f John -l Smith -e johnsmith@yourdomain.com -c your_company_name -k XXXXXXXXXXXXXXXXX -m server -s yes -i 20.200.20.38 -P password
Note

Make sure that the email address provided is the one used during your registration process with Alachisoft.

  • This will initiate NCache installation, and once it is completed, a message will be displayed saying Installation completed successfully.

NCache .NET Core Installation

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

Server Mode

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

sudo ./install -f John -l Smith -e johnsmith@yourdomain.com -c your_company_name -k XXXXXXXXXXXXXXXXX -m server -s yes -i 20.200.20.38 -P password

Client Mode

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

sudo ./install -f John -l Smith -e johnsmith@yourdomain.com -c your_company_name -k XXXXXXXXXXXXXXXXX -m client
Warning

If you miss any of these fields above, an installation error will occur.

Developer Mode

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

sudo ./install -f John -l Smith -e johnsmith@yourdomain.com -c your_company_name -k XXXXXXXXXXXXXXXXX -m dev
Warning

If you miss any of these fields above, an installation error will occur.

Uninstall NCache from Linux Machine

For uninstallation, go to the ncache-enterprise-<version>-dotnet directory, where all the necessary scripts are placed.

cd ncache-enterprise-<version>-dotnet
  • 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 Java Edition 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 Specifies the installation type. Possible values are:
  • server (Cache Server).
  • client (Cache Client).
  • dev (Developer Mode).
    		•  server (Cache Server)
    -f, --firstname* Your first name. -
    -l, --lastname* Your last name. -
    -c, --company* Your company name. -
    -e, --email* Your email address which is used during registration with Alachisoft. -
    -s, --startcache 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 Password for user 'ncache'. -
    -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

    See Also

    Evaluation Period Management
    License Activation
    License Deactivation
    License Reactivation