h2. Basics of LucidWorks Enterprise Components
LucidWorks Enterprise is comprised of four main components that can each be run on a single server, or deployed on separate servers if desired:
* LWE Core (Solr & REST API)
* Admin UI
* Search UI
* Alerts (UI & REST API)
LWE Core must run on its own port, but the other components can be run on the same port, on their own distinct ports, or be completely disabled and unused. In the example below, LWE Core is running on the same machine as the Admin UI and the Alerts Components, while the Search UI is being run on a separate machine.
!lwe-components.jpg|border=1!
h3. Default Installation URLs
This guide will refer to example URLs that will reference the default installation URLs for each component. These defaults are:
|| Component || Default URL ||
| LWE Core | [http://127.0.0.1:8888] |
| Admin UI | [http://127.0.0.1:8989] |
| Search UI | [http://127.0.0.1:8989/search] |
| Alerts | [http://127.0.0.1:8989/alerts] |
These URLs are used by the installer for two purposes:
# When the various components communicate with each other, or link to one another, they specify what URL will be used.
# If the "Enable" check box is selected for a component when using the installer, then that component will be run locally, using the port specified in the URL.
{note:title=Using Different Ports}
If LucidWorks Enterprise components have been installed on different ports, the URLs to those components must be complete addresses as they are in the above example. For example, if the Search UI has been installed on port 7777, the URL to use would be [http://localhost:7777/search]. Only the Admin UI is available at the root level, meaning that trying to access the Search UI at [http://localhost:7777/] would not work.
{note}
h2. Running Components on Different Ports on the Same Server
To run components on different ports of the same server, the installer must be run multiple times, with each installation located in a different installation path. (ie: a distinct "LWE Home")
For example, consider a use case where we want to:
* Run the LWE Core Component on port 8888
* Run the Admin UI Component on port 8989
* Run the Search UI Component on port 9033
* Disable the Alerts Component
In this scenario, we need two installations, and our installation steps would be something like the following...
* Installation #1
*# Launch the [installer|Installation#Running the Installer in Graphical Mode] and follow the steps until the component selection screen
*# Accept the default URLs for LWE Core at [http://127.0.0.1:8888] and the Admin UI at [http://127.0.0.1:8989]
*# Deselect the "Enable" check boxes for the Search UI and Alerts Components so they will not be run as part of this installation
*# Change the URL for the Search UI to [http://127.0.0.1:9033/search] \- even thought it will not be run as part of this installation, this URL will be used by the Admin UI when linking to the Search UI
*# Delete the URL for the Alerts Component so that the text box is blank - this will ensure that the Admin UI and Search UI do not attempt to link to the Alerts UI
*# Advance to the Next screen, and select a path for this installation
*# Finish the installation
* Installation #2
*# Launch the installer again, and advance to the component selection screen
*# Deselect the "Enable" check boxes for the LWE Core and Admin UI Components so they will not be run as part of this installation, but leave the URLs in place so that the Search UI knows how to communicate with them
*# Change the URL for the Search UI to [http://127.0.0.1:9033]
*# Deselect the "Enable" check box for the Alerts Component and delete the corresponding URL so that the text box is blank
*# Advance to the Next screen, and select a new path for this installation that is distinct from Installation #1
Please note:
* Starting and stopping server processes will need to occur in both installations; there is no single start/stop script that will work across multiple installations.
* The master.conf files in both installations will continue to refer to components that were not installed; care must be taken not to enable a component in the wrong installation.
* The [Click Scoring Relevance Framework] runs as part of the LWE-Core, and requires that {{click.log}} (generated by the Search UI) be available in the {{logs/}} directory. If LWE-Core and the Search UI are enabled in different installations, an external process must be responsible for copying that file into the {{logs/}} directory of the LWE-Core installation.
h2. Running Components on Different Servers
To run components on discrete servers, follow the same process used to install components on different ports of the same server. The only new step is to update the hostname/ip portion of the URL for each component during installation to identify which server should be used when components communicate with each other, or link to one another.
LucidWorks Enterprise is comprised of four main components that can each be run on a single server, or deployed on separate servers if desired:
* LWE Core (Solr & REST API)
* Admin UI
* Search UI
* Alerts (UI & REST API)
LWE Core must run on its own port, but the other components can be run on the same port, on their own distinct ports, or be completely disabled and unused. In the example below, LWE Core is running on the same machine as the Admin UI and the Alerts Components, while the Search UI is being run on a separate machine.
!lwe-components.jpg|border=1!
h3. Default Installation URLs
This guide will refer to example URLs that will reference the default installation URLs for each component. These defaults are:
|| Component || Default URL ||
| LWE Core | [http://127.0.0.1:8888] |
| Admin UI | [http://127.0.0.1:8989] |
| Search UI | [http://127.0.0.1:8989/search] |
| Alerts | [http://127.0.0.1:8989/alerts] |
These URLs are used by the installer for two purposes:
# When the various components communicate with each other, or link to one another, they specify what URL will be used.
# If the "Enable" check box is selected for a component when using the installer, then that component will be run locally, using the port specified in the URL.
{note:title=Using Different Ports}
If LucidWorks Enterprise components have been installed on different ports, the URLs to those components must be complete addresses as they are in the above example. For example, if the Search UI has been installed on port 7777, the URL to use would be [http://localhost:7777/search]. Only the Admin UI is available at the root level, meaning that trying to access the Search UI at [http://localhost:7777/] would not work.
{note}
h2. Running Components on Different Ports on the Same Server
To run components on different ports of the same server, the installer must be run multiple times, with each installation located in a different installation path. (ie: a distinct "LWE Home")
For example, consider a use case where we want to:
* Run the LWE Core Component on port 8888
* Run the Admin UI Component on port 8989
* Run the Search UI Component on port 9033
* Disable the Alerts Component
In this scenario, we need two installations, and our installation steps would be something like the following...
* Installation #1
*# Launch the [installer|Installation#Running the Installer in Graphical Mode] and follow the steps until the component selection screen
*# Accept the default URLs for LWE Core at [http://127.0.0.1:8888] and the Admin UI at [http://127.0.0.1:8989]
*# Deselect the "Enable" check boxes for the Search UI and Alerts Components so they will not be run as part of this installation
*# Change the URL for the Search UI to [http://127.0.0.1:9033/search] \- even thought it will not be run as part of this installation, this URL will be used by the Admin UI when linking to the Search UI
*# Delete the URL for the Alerts Component so that the text box is blank - this will ensure that the Admin UI and Search UI do not attempt to link to the Alerts UI
*# Advance to the Next screen, and select a path for this installation
*# Finish the installation
* Installation #2
*# Launch the installer again, and advance to the component selection screen
*# Deselect the "Enable" check boxes for the LWE Core and Admin UI Components so they will not be run as part of this installation, but leave the URLs in place so that the Search UI knows how to communicate with them
*# Change the URL for the Search UI to [http://127.0.0.1:9033]
*# Deselect the "Enable" check box for the Alerts Component and delete the corresponding URL so that the text box is blank
*# Advance to the Next screen, and select a new path for this installation that is distinct from Installation #1
Please note:
* Starting and stopping server processes will need to occur in both installations; there is no single start/stop script that will work across multiple installations.
* The master.conf files in both installations will continue to refer to components that were not installed; care must be taken not to enable a component in the wrong installation.
* The [Click Scoring Relevance Framework] runs as part of the LWE-Core, and requires that {{click.log}} (generated by the Search UI) be available in the {{logs/}} directory. If LWE-Core and the Search UI are enabled in different installations, an external process must be responsible for copying that file into the {{logs/}} directory of the LWE-Core installation.
h2. Running Components on Different Servers
To run components on discrete servers, follow the same process used to install components on different ports of the same server. The only new step is to update the hostname/ip portion of the URL for each component during installation to identify which server should be used when components communicate with each other, or link to one another.