You are here

Installing and configuring Alfresco Search and Insight Engine without mutual TLS using the distribution zip

Use this information to install Alfresco Search and Insight Engine on the same machine as Alfresco Content Services without mutual TLS.
Mutual TLS is used for authentication between the Repository and Alfresco Search and Insight Engine. Without mutual TLS, internal APIs on both sides will be exposed without any form of authentication, giving full access to the repository data. In such a setup, you need to make sure that external access to these APIs is blocked, for example, with a front-end reverse proxy. See Adding a reverse proxy for more.
This task assumes you have:
  • Installed Alfresco Content Services 6.0 or above, see Supported Platforms and Languages.
  • Set the following properties in the <TOMCAT_HOME>/shared/classes/alfresco-global.properties file:
    index.subsystem.name=solr6
    solr.secureComms=none
    solr.port=8983
Important: Alfresco strongly recommends you use firewalls and other infrastructure means to ensure the Alfresco Search and Insight Engine server is not accessible from anything other than trusted hosts and/or users, and only on the ports needed for Alfresco Search and Insight Engine.
  1. Browse to the Alfresco Support Portal and download alfresco-insight-engine-distribution-1.4.x.zip.
  2. Extract the Alfresco Search and Insight Engine distribution.

    By default, the contents of alfresco-insight-engine-distribution-1.4.x.zip are decompressed in a root folder as /alfresco-insight-engine. See Alfresco Search and Insight Engine directory structure for more details.

  3. Configure HTTP.
    1. Open solrhome/templates/rerank/conf/solrcore.properties.
    2. Replace alfresco.secureComms=https with:

      alfresco.secureComms=none

      This ensures that the Solr cores are created in plain HTTP mode.

      Alternatively, you can add this configuration in the system properties (using -D) when starting Solr. For example, add the following to the startup parameters in step 7:

      -Dalfresco.secureComms=none

    See Core templates for a brief description of the out-of-the-box Solr core templates.

  4. If you use several languages across your organization, you must enable cross-language search support in all fields. To do this add the following to the alfresco-insight-engine/solrhome/conf/shared.properties file:

    alfresco.cross.locale.datatype.0={http://www.alfresco.org/model/dictionary/1.0}text
    alfresco.cross.locale.datatype.1={http://www.alfresco.org/model/dictionary/1.0}content
    alfresco.cross.locale.datatype.2={http://www.alfresco.org/model/dictionary/1.0}mltext
  5. (Optional) Suggestion is disabled by default. To enable suggestion update the alfresco-insight-engine/solrhome/conf/shared.properties file.

    alfresco.suggestable.property.0={http://www.alfresco.org/model/content/1.0}name
    alfresco.suggestable.property.1={http://www.alfresco.org/model/content/1.0}title 
    alfresco.suggestable.property.2={http://www.alfresco.org/model/content/1.0}description 
    alfresco.suggestable.property.3={http://www.alfresco.org/model/content/1.0}content
    Note: The spell check functionality does not work with Alfresco Search and Insight Engine when suggestion is enabled.
  6. (Optional) If you want to install Alfresco Search and Insight Engine on a separate machine, set the SOLR_SOLR_HOST and SOLR_ALFRESCO_HOST environment variables before starting Alfresco Search and Insight Engine, for more see Alfresco Search and Insight Engine externalized configuration.

    (Windows) update the alfresco-insight-engine/solr.in.cmd file:

    set SOLR_SOLR_HOST=localhost
    set SOLR_ALFRESCO_HOST=localhost

    (Linux) update the alfresco-insight-engine/solr.in.sh file:

    SOLR_SOLR_HOST=localhost
    SOLR_ALFRESCO_HOST=localhost
  7. To start Alfresco Search and Insight Engine with all the default settings, use the following command:

    ./solr/bin/solr start -a "-Dcreate.alfresco.defaults=alfresco,archive"

    This command automatically creates the alfresco and the archive cores.

    The command line parameter, -a passes additional JVM parameters, for example, system properties using -D.

    Note: The -Dcreate.alfresco.defaults=alfresco,archive command automatically creates the alfresco and archive cores. Therefore, you should only start Alfresco Search and Insight Engine with -Dcreate.alfresco.defaults=alfresco,archive the first time you are running Alfresco Search and Insight Engine.
    Note: You should run this application as a dedicated user. For example, you can create a Solr user.
    Note: To ensure that Alfresco Search and Insight Engine connects using IPv6 protocol instead of IPv4, add -Djava.net.preferIPv6Addresses=true to the startup parameters.

    Once Alfresco Search and Insight Engine is up and running, you should see a message similar to the following:

    Waiting up to 180 seconds to see Solr running on port 8983 [\]  
    Started Solr server on port 8983 (pid=24289). Happy searching!
    To stop the currently running Alfresco Search and Insight Engine instance, use:
    ./solr/bin/solr stop

    The logs are stored in the alfresco-insight-engine/logs/solr.log file, by default. This can be configured in solr.in.sh (for Linux) or solr.in.cmd (for Windows) using SOLR_LOGS_DIR.

    You have successfully created an alfresco core and an archive core. To verify, in a browser, navigate to the Solr URL, http://localhost:8983/solr. In the Solr Admin UI, select the core selector drop-down list and verify that both the alfresco and archive cores are present.

    Allow a few minutes for Alfresco Search and Insight Engine to start indexing.

  8. Go to Admin Console > Repository Services > Search Service and verify that:
    1. You see the Solr 6 option in the Search Service In Use list.
    2. Under Main (Workspace) Store Tracking Status, the Approx Transactions to Index is 0.

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.