> ## Documentation Index > Fetch the complete documentation index at: https://developer.upsun.com/llms.txt > Use this file to discover all available pages before exploring further. # Solr (Search service) Apache Solr is a scalable and fault-tolerant search index. Solr search with generic schemas provided, and a custom schema is also supported. See the [Solr documentation](https://lucene.apache.org/solr/6_3_0/index.html) for more information. ## Supported versions You can select the major and minor version. Patch versions are applied periodically for bug fixes and other maintenance updates. By default, you get the latest available patches each time you deploy. If your project has a [maintenance window](https://developer.upsun.com/docs/core-concepts/build-deploy.md#maintenance-window) configured, Upsun Cloud applies patches only during that window. Upsun Cloud may still apply urgent or critical fixes outside of the maintenance window. * 10.0 * 9.9 * 9.6 * 9.4 * 9.2 * 9.1 ## Deprecated versions The following versions are still available in your projects, but they're at their end of life and are no longer receiving security updates from upstream. *No deprecated versions.* To ensure your project remains stable in the future, switch to a [supported version](#supported-versions). ## Retired versions The following versions have been retired and are no longer available. If your project uses a retired version, you must update to a [supported version](#supported-versions). * 9.0 * 8.11 * 8.0 * 7.7 * 7.6 * 6.6 * 6.3 * 4.10 * 3.6 ## Relationship reference For each service [defined via a relationship](#usage-example) to your application, Upsun Cloud automatically generates corresponding environment variables within your application container, in the `$_` format. Here is example information available through the [service environment variables](https://developer.upsun.com/docs/development/variables#service-environment-variables) themselves, or through the [`PLATFORM_RELATIONSHIPS` environment variable](https://developer.upsun.com/docs/development/variables/use-variables#use-provided-variables). > [tab] Service environment variables > > You can obtain the complete list of available service environment variables in your app container by running `upsun ssh env`. > > Note that the information about the relationship can change when an app is redeployed or restarted or the relationship is changed. So your apps should only rely on the [service environment variables](https://developer.upsun.com/docs/development/variables#service-environment-variables) directly rather than hard coding any values. > > SOLR\_USERNAME= > SOLR\_SCHEME=solr > SOLR\_SERVICE=solr > SOLR\_IP=123.456.78.90 > SOLR\_FRAGMENT= > SOLR\_HOSTNAME=azertyuiopqsdfghjklm.solr.service.\_.eu-1.platformsh.site > SOLR\_PORT=8080 > SOLR\_CLUSTER=azertyuiopqsdf-main-afdwftq > SOLR\_HOST=solr.internal > SOLR\_REL=solr > SOLR\_PATH=solr/collection1 > SOLR\_QUERY=\{} > SOLR\_PASSWORD= > SOLR\_EPOCH=0 > SOLR\_TYPE=solr:\{\{version:solr:latest}} > SOLR\_PUBLIC=false > SOLR\_HOST\_MAPPED=false > > [tab] `PLATFORM_RELATIONSHIPS` environment variable > > For some advanced use cases, you can use the [`PLATFORM_RELATIONSHIPS` environment variable](https://developer.upsun.com/docs/development/variables#service-environment-variables). > The structure of the `PLATFORM_RELATIONSHIPS` environment variable can be obtained by running `upsun relationships` in your terminal: > > \{ > "username": null, > "scheme": "solr", > "service": "solr", > "fragment": null, > "ip": "123.456.78.90", > "hostname": "azertyuiopqsdfghjklm.solr.service.\_.eu-1.platformsh.site", > "port": 8080, > "cluster": "azertyuiopqsdf-main-afdwftq", > "host": "solr.internal", > "rel": "solr", > "path": "solr/collection1", > "query": \[], > "password": null, > "type": "solr:\{\{version:solr:latest}}", > "public": false, > "host\_mapped": false > } > > > Here is an example of how to gather [`PLATFORM_RELATIONSHIPS` environment variable](https://developer.upsun.com/docs/development/variables/use-variables#use-provided-variables) information in a [`.environment` file](https://developer.upsun.com/docs/development/variables/set-variables#when-to-use-env-files): > > ```bash .environment theme={null} > # Decode the built-in credentials object variable. > export RELATIONSHIPS_JSON="$(echo "$PLATFORM_RELATIONSHIPS" | base64 --decode)" > > # Set environment variables for individual credentials. > export APP_SOLR_HOST="$(echo "$RELATIONSHIPS_JSON" | jq -r '.solr[0].host')" > ``` ## Usage example ### 1. Configure the service To define the service, use the `solr` type: services: \# The name of the service container. Must be unique within a project. \: type: solr:\ Note that changing the name of the service replaces it with a brand new service and all existing data is lost. Back up your data before changing the service. ### 2. Define the relationship To define the relationship, use the following configuration: > [tab] Using default endpoints > > applications: > \# The name of the app container. Must be unique within a project. > \: > \# Relationships enable access from this app to a given service. > \# The example below shows simplified configuration leveraging a default service > \# (identified from the relationship name) and a default endpoint. > \# See the Application reference for all options for defining relationships and endpoints. > relationships: > \: > > > You can define `SERVICE_NAME` as you like, so long as it's unique between all defined services > and matches in both the application and services configuration. > > The example above leverages [default endpoint](https://developer.upsun.com/docs/configure-apps/image-properties/relationships.md) configuration for relationships. > That is, it uses default endpoints behind the scenes, providing a [relationship](https://developer.upsun.com/docs/configure-apps/image-properties/relationships.md) > (the network address a service is accessible from) that is identical to the *name* of that service. > > Depending on your needs, instead of default endpoint configuration, > you can use [explicit endpoint configuration](https://developer.upsun.com/docs/configure-apps/image-properties/relationships.md). > > With the above definition, the application container (`APP_NAME`) now has access to the service via the relationship `SERVICE_NAME` and its corresponding [service environment variables](https://developer.upsun.com/docs/development/variables#service-environment-variables). > [tab] Using explicit endpoints > > applications: > \# The name of the app container. Must be unique within a project. > \: > \# Relationships enable access from this app to a given service. > \# The example below shows configuration with an explicitly set service name and endpoint. > \# See the Application reference for all options for defining relationships and endpoints. > relationships: > \: > service: \ > endpoint: solr > > > You can define `SERVICE_NAME` and `` as you like, so long as it's unique between all defined services and relationships > and matches in both the application and services configuration. > > The example above leverages [explicit endpoint](https://developer.upsun.com/docs/configure-apps/image-properties/relationships.md) configuration for relationships. > > Depending on your needs, instead of explicit endpoint configuration, > you can use [default endpoint configuration](https://developer.upsun.com/docs/configure-apps/image-properties/relationships.md). > > With the above definition, the application container now has [access to the service](#use-in-app) via the relationship `` and its corresponding [service environment variables](https://developer.upsun.com/docs/development/variables#service-environment-variables). ### Example configuration > [tab] Using default endpoints > > applications: > \# The name of the app container. Must be unique within a project. > myapp: > \# Relationships enable access from this app to a given service. > \# The example below shows simplified configuration leveraging a default service > \# (identified from the relationship name) and a default endpoint. > \# See the Application reference for all options for defining relationships and endpoints. > relationships: > solr: > services: > \# The name of the service container. Must be unique within a project. > solr: > type: solr:\{\{version:solr:latest}} > [tab] Using explicit endpoints > > applications: > \# The name of the app container. Must be unique within a project. > myapp: > \# Relationships enable access from this app to a given service. > \# The example below shows configuration with an explicitly set service name and endpoint. > \# See the Application reference for all options for defining relationships and endpoints. > relationships: > solr: > service: solr > endpoint: solr > services: > \# The name of the service container. Must be unique within a project. > solr: > type: solr:\{\{version:solr:latest}} ### Use in app To use the configured service in your app, add a configuration file similar to the following to your project. > [tab] Using default endpoints > > applications: > \# The name of the app container. Must be unique within a project. > myapp: > \# The location of the application's code. > source: > root: "myapp" > > \[...] > > \# Relationships enable access from this app to a given service. > \# The example below shows simplified configuration leveraging a default service > \# (identified from the relationship name) and a default endpoint. > \# See the Application reference for all options for defining relationships and endpoints. > relationships: > solr: > services: > \# The name of the service container. Must be unique within a project. > solr: > type: solr:\{\{version:solr:latest}} > [tab] Using explicit endpoints > > applications: > \# The name of the app container. Must be unique within a project. > myapp: > \# The location of the application's code. > source: > root: "myapp" > > \[...] > > \# Relationships enable access from this app to a given service. > \# The example below shows configuration with an explicitly set service name and endpoint. > \# See the Application reference for all options for defining relationships and endpoints. > relationships: > solr: > service: solr > endpoint: solr > services: > \# The name of the service container. Must be unique within a project. > solr: > type: solr:\{\{version:solr:latest}} This configuration defines a single application (`myapp`), whose source code exists in the `/myapp` directory.\ `myapp` has access to the `solr` service, via a relationship whose name is [identical to the service name](#2-define-the-relationship) (as per [default endpoint](https://developer.upsun.com/docs/configure-apps/image-properties/relationships.md) configuration for relationships). From this, `myapp` can retrieve access credentials to the service through the [relationship environment variables](#relationship-reference). ```bash myapp/.environment theme={null} # Set environment variables for individual credentials. # For more information, please visit /docs/development/variables#service-environment-variables. export QUEUE_SCHEME="${SOLR_SCHEME}" export QUEUE_USERNAME="${SOLR_USERNAME}" export QUEUE_PASSWORD="${SOLR_PASSWORD}" export QUEUE_HOST="${SOLR_HOST}" export QUEUE_PORT="${SOLR_PORT}" # Set a single RabbitMQ connection string variable for AMQP. export AMQP_URL="${QUEUE_SCHEME}://${QUEUE_USERNAME}:${QUEUE_PASSWORD}@${QUEUE_HOST}:${QUEUE_PORT}/" ``` The above file — `.environment` in the `myapp` directory — is automatically sourced by Upsun Cloud into the runtime environment, so that the variable `SEARCH_URL` can be used within the application to connect to the service. Note that `SEARCH_URL`, and all Upsun Cloud [service environment variables](https://developer.upsun.com/docs/development/variables#service-environment-variables) like `SOLR_HOST`, are environment-dependent. Unlike the build produced for a given commit, they can’t be reused across environments and only allow your app to connect to a single service instance on a single environment. A file very similar to this is generated automatically for your when using the `upsun ify` command to [migrate a codebase to Upsun Cloud](https://developer.upsun.com/docs/get-started.md). ## Solr 4 For Solr 4, Upsun Cloud supports only a single core per server called `collection1`. You must provide your own Solr configuration via a `core_config` key in your `.upsun/config.yaml`: services: \# The name of the service container. Must be unique within a project. solr: type: "solr:4.10" configuration: core\_config: !archive "\" `` points to a directory in the Git repository, in or below the `.upsun/` folder. This directory needs to contain everything that Solr needs to start a core. At the minimum, `solrconfig.xml` and `schema.xml`. For example, place them in `.upsun/solr/conf/` such that the `schema.xml` file is located at `.upsun/solr/conf/schema.xml`. You can then reference that path like this - ```yaml .upsun/config.yaml theme={null} services: # The name of the service container. Must be unique within a project. solr: type: "solr:4.10" configuration: core_config: !archive "solr/conf/" ``` ## Solr 6 and later For Solr 6 and later Upsun Cloud supports multiple cores via different endpoints. Cores and endpoints are defined separately, with endpoints referencing cores. Each core may have its own configuration or share a configuration. It is best illustrated with an example. services: \# The name of the service container. Must be unique within a project. solr: type: solr:\{\{version:solr:latest}} configuration: cores: mainindex: conf\_dir: !archive "core1-conf" extraindex: conf\_dir: !archive "core2-conf" endpoints: main: core: mainindex extra: core: extraindex The above definition defines a single Solr 10.0 server. That server has 2 cores defined: * `mainindex` — the configuration for which is in the `.upsun/core1-conf` directory * `extraindex` — the configuration for which is in the `.upsun/core2-conf` directory. It then defines two endpoints: `main` is connected to the `mainindex` core while `extra` is connected to the `extraindex` core. Two endpoints may be connected to the same core but at this time there would be no reason to do so. Additional options may be defined in the future. Each endpoint is then available in the relationships definition in `.upsun/config.yaml`. For example, to allow an application to talk to both of the cores defined above its configuration should contain the following: applications: \# The name of the app container. Must be unique within a project. myapp: type: "php:\{\{version:php:latest}}" source: root: "myapp" \[...] \# Relationships enable access from this app to a given service. \# The example below shows configuration with explicitly set service names and endpoints. \# See the Application reference for all options for defining relationships and endpoints. relationships: solrsearch1: service: solr endpoint: main solrsearch2: service: solr endpoint: extra services: \# The name of the service container. Must be unique within a project. solr: type: solr:\{\{version:solr:latest}} configuration: cores: mainindex: conf\_dir: !archive "core1-conf" extraindex: conf\_dir: !archive "core2-conf" endpoints: main: core: mainindex extra: core: extraindex That is, the application's environment would include a `solrsearch1` relationship that connects to the `main` endpoint, which is the `mainindex` core, and a `solrsearch2` relationship that connects to the `extra` endpoint, which is the `extraindex` core. The relationships array would then look something like the following: ```json theme={null} { "solrsearch1": [ { "path": "solr/mainindex", "host": "248.0.65.197", "scheme": "solr", "port": 8080 } ], "solrsearch2": [ { "path": "solr/extraindex", "host": "248.0.65.197", "scheme": "solr", "port": 8080 } ] } ``` ### Configsets For even more customizability, it's also possible to define Solr configsets. For example, the following snippet would define one configset, which would be used by all cores. Specific details can then be overridden by individual cores using `core_properties`, which is equivalent to the Solr `core.properties` file. services: \# The name of the service container. Must be unique within a project. solr: type: solr:\{\{version:solr:latest}} configuration: configsets: mainconfig: !archive "configsets/solr8" cores: english\_index: core\_properties: | configSet=mainconfig schema=english/schema.xml arabic\_index: core\_properties: | configSet=mainconfig schema=arabic/schema.xml endpoints: english: core: english\_index arabic: core: arabic\_index In this example, `.upsun/configsets/solr8` contains the configuration definition for multiple cores. There are then two cores created: * `english_index` uses the defined configset, but specifically the `.upsun/configsets/solr8/english/schema.xml` file * `arabic_index` is identical except for using the `.upsun/configsets/solr8/arabic/schema.xml` file. Each of those cores is then exposed as its own endpoint. Note that not all core properties features make sense to specify in the `core_properties`. Some keys, such as `name` and `dataDir`, aren't supported, and may result in a `solrconfig` that fails to work as intended, or at all. ### Default configuration #### Default for version 9+ If you don't specify any configuration, the following default is used: services: \# The name of the service container. Must be unique within a project. solr: type: solr:\{\{version:solr:latest}} configuration: cores: collection1: conf\_dir: !archive "example" endpoints: solr: core: collection1 The example configuration directory is equivalent to the [Solr example configuration set](https://github.com/apache/solr/tree/main/solr/server/solr/configsets/sample_techproducts_configs/conf). This default configuration is designed only for testing. You are strongly recommended to define your own configuration with a custom core and endpoint. #### Default for versions below 9 If you don't specify any configuration, the following default is used: ```yaml .upsun/config.yaml theme={null} services: # The name of the service container. Must be unique within a project. solr: type: solr:8.4 configuration: cores: collection1: {} endpoints: solr: core: collection1 ``` The default configuration is based on an older version of the Drupal 8 Search API Solr module that is no longer in use. You are strongly recommended to define your own configuration with a custom core and endpoint. ### Limitations The recommended maximum size for configuration directories (zipped) is 2MB. These need to be monitored to ensure they don't grow beyond that. If the zipped configuration directories grow beyond this, performance declines and deploys become longer. The directory archives are compressed and string encoded. You could use this bash pipeline ```bash theme={null} echo $(($(tar czf - . | base64 | wc -c )/(1024*1024))) Megabytes ``` inside the directory to get an idea of the archive size. The configuration directory is a collection of configuration data, like a data dictionary, e.g. small collections of key/value sets. The best way to keep the size small is to restrict the directory context to plain configurations. Including binary data like plugin `.jar` files inflates the archive size, and isn't recommended. ## Accessing the Solr server administrative interface Because Solr uses HTTP for both its API and admin interface it's possible to access the admin interface over an SSH tunnel. upsun tunnel:single --relationship \ By default, this opens a tunnel at `127.0.0.1:30000`. You can now open `http://localhost:30000/solr/` in a browser to access the Solr admin interface. Note that you can't create indexes or users this way, but you can browse the existing indexes and manipulate the stored data. ## Available plugins This is the complete list of plugins that are available and loaded by default: | Plugin | Description | 8.11 | 9.x | | - | - | - | - | | [JTS](https://solr.apache.org/guide/8_1/spatial-search.html#jts-and-polygons-flat) | Library for creating and manipulating vector geometry. | \* | \* | | [ICU4J](https://solr.apache.org/guide/8_3/language-analysis.html) | Library providing Unicode and globalization support. | \* | \* | ## Available modules The following is the complete list of supported Solr modules. ### Modules vs plugins In Solr, a **module** is a packaged feature set that can be added to the classpath. A **plugin** is a specific Solr component (for example a request handler, parser, or repository implementation) that may rely on a module. In practice, you often enable modules first, then use plugins provided by those modules in your configset. ### When to enable modules Enable modules only when your configset needs them: * `extraction`: Tika-based document extraction * `langid`: language detection * `ltr`: learning-to-rank components * `clustering`: result clustering features * `sql`: SQL query endpoint support * `analysis-extras`: additional analysis filters and tokenizers Loading only the modules you need reduces startup overhead and avoids unnecessary classpath bloat. ### Example: enable modules in the service configuration Use the `configuration.modules` key in your service definition: ```yaml .upsun/config.yaml theme={null} services: solr: type: solr:9.9 configuration: modules: - analysis-extras - langid - ltr ``` ### Bundled modules (Solr 9.9+) Solr 9.8 made [`` directives in `solrconfig.xml` opt-in](https://solr.apache.org/guide/solr/latest/upgrade-notes/major-changes-in-solr-9.html#solr-9-8), and Solr 10.0 ([SOLR-16781](https://issues.apache.org/jira/browse/SOLR-16781)) removed support for them entirely. As a result, bundled modules shipped under `/opt/solr//modules/` are no longer auto-loaded from `` references in your configset. Instead, list the modules you need in `configuration.modules`. By default, no bundled modules are loaded. Only the modules you explicitly request are added to the classpath. If you're upgrading from Solr 9.6 or earlier and your configset relies on `` directives, add the matching modules to `configuration.modules` when you upgrade: ```yaml .upsun/config.yaml theme={null} services: solr: type: solr:9.9 configuration: modules: - extraction - analysis-extras - langid - ltr ``` The `configuration.modules` field is supported only on Solr 9.9 and later. On Solr 9.6 and earlier, modules continue to load from `` directives in your configset. ### Typical migration issues (9.9+) If you upgraded from an older setup that used `` directives, add the matching modules in `configuration.modules`. | Symptom | Likely missing module | | - | - | | ClassNotFound errors related to Tika extraction | `extraction` | | Language detection handlers/fields fail to initialize | `langid` | | LTR parser/components fail to load | `ltr` | | SQL endpoint/features unavailable | `sql` | ### Validation checklist after enabling modules After deployment, verify the following: * Solr service starts successfully * Core loading completes without classpath errors * The feature tied to the module works (query/index/update path) * Service logs contain no module-related `ClassNotFound`/initialization errors ### Supported modules matrix
ExtensionDescriptionSupported versions
`analysis-extras`Extra analyzers and token filters for advanced text analysis use cases.10.09.9
`analytics`Streaming expressions and advanced analytics functions.10.09.9
`clustering`Result clustering capabilities for grouped search output.10.09.9
`cross-dc`Cross-data-center replication and failover tooling.10.09.9
`cuvs`Vector search acceleration module based on cuVS.10.09.9
`extraction`Tika-based extraction for PDF, Office, and other document formats.10.09.9
`gcs-repository`Repository plugin for backups and snapshots on Google Cloud Storage.10.09.9
`hadoop-auth`Hadoop-compatible authentication integrations.10.09.9
`hdfs`HDFS integration for repository and storage operations.10.09.9
`jaegertracer-configurator`Jaeger tracing configuration helpers.10.09.9
`jwt-auth`JWT authentication support for Solr APIs.10.09.9
`langid`Automatic language identification update processor.10.09.9
`language-models`Language model resources used by NLP-oriented features.10.09.9
`llm`Large language model integration components.10.09.9
`ltr`Learning To Rank query reranking framework.10.09.9
`opentelemetry`OpenTelemetry instrumentation for traces and metrics.10.09.9
`s3-repository`Repository plugin for backups and snapshots on S3-compatible storage.10.09.9
`scripting`Script engine integrations for custom processing.10.09.9
`sql`SQL query parser and SQL request handler support.10.09.9
## Upgrading The Solr data format sometimes changes between versions in incompatible ways. Solr doesn't include a data upgrade mechanism as it is expected that all indexes can be regenerated from stable data if needed. To upgrade (or downgrade) Solr you need to use a new service from scratch. There are two approaches. ### Destructive upgrade In your `.upsun/config.yaml` file, change the version of your Solr service *and* its name. Be sure to also update the reference to the now changed service name in it's corresponding application's `relationship` block. When you push that to Upsun Cloud, the old service is deleted and a new one with the name is created, with no data. You can then have your application re-index data as appropriate. This approach has the downside of temporarily having an empty Solr instance, which your application may or may not handle gracefully, and needing to rebuild your index afterward. Depending on the size of your data that could take a while. ### Transitional upgrade For a transitional approach you temporarily have two Solr services. Add a second Solr service with the new version a new name and give it a new relationship in `.upsun/config.yaml`. You can optionally run in that configuration for a while to allow your application to populate indexes in the new service as well. Once you're ready to cut over, remove the old Solr service and relationship. You may optionally have the new Solr service use the old relationship name if that's easier for your application to handle. Your application is now using the new Solr service. This approach has the benefit of never being without a working Solr instance. On the downside, it requires two running Solr servers temporarily, each of which consumes resources and need adequate disk space. Depending on the size of your data that may be a lot of disk space. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.