Installing and configuring Search Services with mutual TLS

See Search Services directory structure for more details.

If you are using a Windows-based platform, update the alfresco-search-services/solr.in.cmd file:

set SOLR_PORT=8983

If you are using a Linux-based platform, update the alfresco-search-services/solr.in.sh file:

SOLR_PORT=8983

1. Generate secure keys specific to your Alfresco installation.

   For more information, see Generating secure keys overview.

2. Create a new keystore directory at alfresco-search-services/solrhome.
3. In the production environment, copy your custom keystore and truststore to the alfresco-search-services/solrhome/keystore directory.
4. Update the SSL-related system properties.

   If you are using a Windows-based platform, update the alfresco-search-services/solr.in.cmd file:

   set SOLR_SSL_KEY_STORE=<SOLR_HOME>\keystore\ssl.repo.client.keystore
   set SOLR_SSL_KEY_STORE_PASSWORD=password
   set SOLR_SSL_TRUST_STORE=<SOLR_HOME>\keystore\ssl.repo.client.truststore
   set SOLR_SSL_TRUST_STORE_PASSWORD=password
   set SOLR_SSL_NEED_CLIENT_AUTH=true
   set SOLR_SSL_WANT_CLIENT_AUTH=false

   If you are using a Linux-based platform, update the alfresco-search-services/solr.in.sh file:

   SOLR_SSL_KEY_STORE=<SOLR_HOME>/keystore/ssl.repo.client.keystore
   SOLR_SSL_KEY_STORE_PASSWORD=password
   SOLR_SSL_TRUST_STORE=<SOLR_HOME>/keystore/ssl.repo.client.truststore
   SOLR_SSL_TRUST_STORE_PASSWORD=password 
   SOLR_SSL_NEED_CLIENT_AUTH=true 
   SOLR_SSL_WANT_CLIENT_AUTH=false

   In the above examples, replace <SOLR_HOME> with alfresco-search-services/solrhome, and set your keystore and truststore passwords.

• If you use several languages across your organization, you must enable cross-language search support in all fields, by adding the following:

  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 

1. Set the environment variable, SOLR_SOLR_HOST, in the following file.

   (Windows):

   alfresco-search-services/solr.in.cmd

   (Linux):

   alfresco-search-services/solr.in.sh

2. Set the values of environment variables, such as SOLR_ALFRESCO_HOST, in the following file.

   (Windows):

   alfresco-search-services/solr.in.cmd

   (Linux):

   alfresco-search-services/solr.in.sh

   See Search Services externalized configuration.

• Suggestion is disabled by default for Search Services. If you want to enable suggestion, add the following:

  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

• Before creating the alfresco and archive cores:
  • Set alfresco.secureComms=https in alfresco-search-services/solrhome/templates/rerank/conf/solrcore.properties.
  • Copy the custom keystores to the alfresco-search-services/solrhome/templates/rerank/conf directory.

    ssl.repo.client.keystore
    ssl.repo.client.truststore
    ssl-keystore-passwords.properties
    ssl-truststore-passwords.properties

• If the alfresco and archive cores already exist, ensure that alfresco.secureComms is set to https for both the cores. For example:
  • alfresco-search-services/solrhome/alfresco/conf/solrcore.properties
  • alfresco-search-services/solrhome/archive/conf/solrcore.properties

cd alfresco-search-services
./solr/bin/solr start -a "-Djavax.net.ssl.keyStoreType=JCEKS -Djavax.net.ssl.trustStoreType=JCEKS -Dsolr.ssl.checkPeerName=false -Dcreate.alfresco.defaults=alfresco,archive"

The default port used is 8983.

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

Once Search Services is up and running, you should see a message like:

Waiting up to 180 seconds to see Solr running on port 8983 [\]  
Started Solr server on port 8983 (pid=24289). Happy searching!

./solr/bin/solr stop

The logs are stored in the alfresco-search-services/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, https://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 in the list.

Allow a few minutes for Search Services to start indexing.