Lando

special sponsors

become a sponsor

# Solr

Solr (opens new window) is highly reliable, scalable and fault tolerant, providing distributed indexing, replication and load-balanced querying, automated failover and recovery, centralized configuration and more. Solr powers the search and navigation features of many of the world's largest internet sites.

You can easily add it to your Lando app by adding an entry to the services top-level config in your Landofile.

# Supported versions

# Legacy versions

You can still run these versions with Lando but for all intents and purposes they should be considered deprecated (e.g. YMMV and do not expect a ton of support if you have an issue).

# Patch versions

Not officially supported!

While we allow users to specify patch versions for this service, they are not officially supported, so if you use one, YMMV. Also note that patch versions are not available for Solr 3.x and 4.x.

To use a patch version, you can do something as shown below:

services:
  myservice:
    type: solr:5.5.5

But make sure you use one of the available patch tags (opens new window) for the underlying image we are using.

# Configuration

Here are the configuration options, set to the default values, for this service. If you are unsure about where this goes or what this means, we highly recommend scanning the services documentation to get a good handle on how the magicks work.

Also note that options, in addition to the build steps and overrides that are available to every service, are shown below:

services:
  myservice:
    type: solr:7
    portforward: false
    core: lando
    config:
      dir: SEE BELOW

# Port forwarding

portforward will allow you to access this service externally by assigning a port directly on your host's localhost. Note that portforward can be set to either true or a specific port but we highly recommend you set it to true unless you have pretty good knowledge of how port assignment works or you have a very compelling reason for needing a locked down port.

portforward: true will prevent inevitable port collisions and provide greater reliability and stability across Lando apps. That said, one downside of portforward: true is that Docker will assign a different port every time you restart your application. You can read more about accessing services externally over here.

tl;dr

Recommended

services:
  myservice:
    type: solr
    portforward: true

Not recommended

services:
  myservice:
    type: solr
    portforward: 8983

# Using a custom core

You can easily set up a different core name with the core config value.

services:
  myservice:
    type: solr
    core: my-core

Solr 5+ only!

The core config value does not work for Solr 3.x or 4.x.

# Using custom solr config

You will almost certainly need to utilize your own custom Solr config. You can do that by telling Lando to inject solr config from a directory inside of your application.

Consider a Drupal 8 application injecting the Solr 7.x config directly from the search_api_solr module as shown in the example below:

A hypothetical project

Note that you can put your configuration files anywhere inside your application directory. We use a config directory but you can call it whatever you want such as .lando in the example below:

./
|-- sites/all/modules/search_api_solr/solr-conf/7.x
   |-- elevate.xml
   |-- mapping-ISOLatin1Accent.txt
   |-- protwords.txt
   |-- schema_extra_fields.xml
   |-- schema_extra_types.xml
   |-- schema.xml
   |-- solrconfig_extra.xml
   |-- solrconfig_index.xml
   |-- solrconfig_spellcheck.xml
   |-- solrconfig.xml
   |-- solrcore.properties
   |-- stopwords.txt
   |-- synonyms.txt
|-- .lando.yml

Landofile's solr config

services:
  myservice:
    type: solr
    config:
      dir: sites/all/modules/search_api_solr/solr-conf/7.x

# Getting information

You can get connection and credential information about your solr instance by running lando info. It may also be worth checking out our accessing services externally guide.

← Tomcat →