You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

1. Install Software

First ensure all the Prerequisites are meet. Then you can download the Enterprise Search from Download & Execute. 

2. Configure the Server

Change the DOMAIN_NAME and SERVER_PORT variables as required, then change the Elasticsearch properties to meet your instance.

By default the server will always prefer the port set as the environment variable over the one in the config, if the environment variable is not set, the fallback is the one in the config.

config/server/env/all.js
const DOMAIN_NAME = 'localhost'
const SERVER_PORT = process.env.PORT || 3000

module.exports = {
    domain: DOMAIN_NAME,
    app: {
        title: 'Enterprise Search',
        description: 'Enterprise Search',
        keywords: 'Enterprise Search, Independent'
    },
    port: SERVER_PORT,
    .
    .
    .
    elastic: {
        schema: 'http',
        host: 'localhost',
        port: 9200,
        indexName: 'esui'
    }
}

The server configuration is multi environment. So in the folder config/server/env you will find the following files: all.js, local.js, development.js and production.js. Each file will contain the configuration for that specific environment. 

3. Run the NodeJS Server

To start the server just execute in the console 

npm run start

The server by default will start in development mode, using the development environment configuration. To start the server in other modes (local, development or production) you must set the NODE_ENV environment variable, depending on the console, like this:

  • Powershell: $env:NODE_ENV="local"
  • CMD: set NODE_ENV="local"
  • Shell: export NODE_ENV="local"

The same applies for the port:

  • Powershell: $env:PORT=8080
  • CMD: set PORT=8080
  • Shell: export PORT=8080

The server will have the API for the endpoint as well as the user interface


Enterprise Search will start loading its components, you can start using it as soon as you see a message in the console similar to this one (can be slightly different):

**************************************************************************************
  _____       _                       _          ____                      _
 | ____|_ __ | |_ ___ _ __ _ __  _ __(_)___  ___/ ___|  ___  __ _ _ __ ___| |__
 |  _| | '_ \| __/ _ \ '__| '_ \| '__| / __|/ _ \___ \ / _ \/ _` | '__/ __| '_ \
 | |___| | | | ||  __/ |  | |_) | |  | \__ \  __/___) |  __/ (_| | | | (__| | | |
 |_____|_| |_|\__\___|_|  | .__/|_|  |_|___/\___|____/ \___|\__,_|_|  \___|_| |_|
                          |_|

 Mode: development
 PID: 3024
 Protocol: http
 Port: 3000
 Authentication: none
 NodeJS: 14.15.1

**************************************************************************************

Be sure Elasticsearch is already running when attempting to start Enterprise Search

  • No labels