================================================================
 Cluster WebUI Offline Setup Guide              April 8th, 2025
================================================================

About this guide

 This guide shows how to install, uninstall and start Cluster
 WebUI Offline for EXPRESSCLUSTER X 5.3 or later.


Preparation

 - Please install Node.js in advance.

 - Please make sure a target product and check Type which
   compatible with the target product with the following matrix.

    -----------------------------------------------+---------
     Target Product                                  Type
    -----------------------------------------------+---------
     EXPRESSCLUSTER X for Windows                    win
     EXPRESSCLUSTER X for Linux                      lin
     EXPRESSCLUSTER X SingleServerSafe for Windows   sss-win
     EXPRESSCLUSTER X SingleServerSafe for Linux     sss-lin
    -----------------------------------------------+---------


Installation

 1. Create a folder which Cluster WebUI Offline will be
    installed.

 2. Save Cluster WebUI Offline module in the folder which is
    created at step 1.

      * Module name: cluster-webui-<type>-<version>.tgz
        (Please refer "Preparation" for type.)

      * Please do not decompress it.

 3. Move to the folder which is created at step 1 and
    execute the following command:

    npm install --no-save cluster-webui-<type>-<version>.tgz

      * Please ignore if the following warning.

          npm WARN enoent ENOENT: no such file or directory,
            open '<install-path>\package.json'
          npm WARN <dirname> No description
          npm WARN <dirname> No repository field.
          npm WARN <dirname> No README data
          npm WARN <dirname> No license field.


Uninstallation

 1. Remove Cluster WebUI installation folder.


Quick start

 1. Start Cluster WebUI Offline.

    Move to Cluster WebUI installation folder and execute
    the following command:

    npx cluster-webui-<type> --port=<port> --locale={ja,en}

      e.g.) npx cluster-webui-win --port=29003 --locale=ja

      * Input Ctrl-C to stop Cluster WebUI Offline.

      * Command options:

        --port=<port>

          Specify port number which is used for Cluster WebUI
          Offline. 29003 is used as default.

        --locale={ja,en}

          Specify language.
          OS local is used as default.
            * If OS locale is not supported,
              en is used as default.

          ja: Japanese, en: English

 2. Access to the following URL with Web Browser.

      http://localhost:<port>/