Refine README.md to include how to update config

Created on 2 September 2021, almost 3 years ago
Updated 12 February 2024, 5 months ago

The README.md does not include upgrade steps and causes some confusion, especially for beginners on how to update the configuration after updating to a newer version of the module.

Errors encountered after module update:

On Status Report:

 Schema not up to date
There are some configuration elements missing in the Solr server schema {server_machine_name}. This is likely due to using an outdated version of either Drupal or Solr. The recommended version is: {schema_version}. An updated config.zip should be downloaded and deployed to your Solr server.

On Server (view) page:

You are using outdated Solr configuration set. Please follow the instructions described in the README.md file for setting up Solr.

I think it would also be helpful to include any gotchyas related to custom configurations that may need to be re-created on the config files.

πŸ“Œ Task
Status

Active

Version

4.2

Component

Documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States tekNorah

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • πŸ‡©πŸ‡°Denmark ressa Copenhagen
  • πŸ‡ΏπŸ‡¦South Africa wcweb

    Just want to add that I recently upgraded search_api_solr and was prompted to deploy the new config.zip. Two difficuilties I encountered were:

    1. I couldn't find the "Download config.zip" button as seen when you deploy a new server. Eventually I resorted to adding a new search server. However... I found it later under the Operations dropdown menu.

    2. How to deploy config.zip is confusing and I found the simplest way to do it for a self-hosted Solr server, running on Debian, was to simply stop the solr.service and copy the extracted files into /var/solr/data/{core-name}/conf/ dir, after making a backup.

  • πŸ‡ΊπŸ‡ΈUnited States DamienMcKenna NH, USA

    One problem is that the docs specifically mention the "search-api-solr:upload-configset" Drush command, which doesn't exist.

  • πŸ‡³πŸ‡±Netherlands undersound3

    @DamienMcKenna that command lives in the search_api_solr_admin module. Perhaps it was not enabled?

    Perhaps a section can be made in the readme specifically titled "Updating configuration" or "Updating" to let this process stand out more in the docs or the current section "Updating Solr" can be enriched with a text that sumps up all the scenarios when to do update the config (and how to do this)

    For example...

    Updating configuration
    --------------------------------
    You need to update your config in the following scenarios:
    1. When you update the module to a newer version
    2. When you add a language
    2. When you a add a custom Solr Field Type 

    Perhaps we can also mention how to deal with custom changes in relation to updating and version control?
    Let's say I have added some synonyms to synonyms_nl.txt and are saving my custom config in a folder in the repo (e.g. config/solr) to use that later on in the deployment cycle. As far I understand when I run 'drush solr-gsc' I get a fresh copy of synonyms_nl.txt which does not include my custom additions.

  • πŸ‡©πŸ‡ͺGermany mkalkbrenner πŸ‡©πŸ‡ͺ

    You can implement a hook to get your modifications into each newly generated config.
    This way, also the warning on the status report page will disappear.

    Feel free to propose patches to enhance the Readme.

  • πŸ‡¦πŸ‡ΉAustria maxilein

    Hi,

    it is also very confusing in the readme:

    Starting from Search API Solr module version 4.2.1 you don't need to deal with
    configsets manually anymore. Just enable the `search_api_solr_admin` sub-module
    which is part of Search API Solr. Now you create or update your "collections" at
    any time by clicking the "Upload Configset" button on the Search API server
    details page (see installation steps below), or use `drush` to do this with

    The admin module is enabled. But there is no button "Upload Configset" on the server page.

    button Get Config works.
    button Reload Core -> gives access denied
    Is there anything required in the file permissions other than a standard solr install?

  • πŸ‡©πŸ‡ͺGermany mkalkbrenner πŸ‡©πŸ‡ͺ

    The admin module is enabled. But there is no button "Upload Configset" on the server page.

    Is there anything required in the file permissions other than a standard solr install?

    Yes, the Configset API is only available in Solr Cloud. (Read the Solr documentation.)

  • πŸ‡ΊπŸ‡ΈUnited States bobburns

    From number 4 worked for me on Centos7

    2. How to deploy config.zip is confusing and I found the simplest way to do it for a self-hosted Solr server, running on Debian, was to simply stop the solr.service and copy the extracted files into /var/solr/data/{core-name}/conf/ dir, after making a backup.

  • πŸ‡¦πŸ‡ΉAustria maxilein

    I'd like to add how I do it on a local ubuntu.

    make the folders accessiable:
    sudo chown -R {your user}:{your user} /var/solr

    now copy the extracted config to /var/solr/data/{core-name}/conf

    set the permissions back:
    sudo chown -R solr:solr /var/solr

Production build 0.69.0 2024