Advanced Search adapter for Solr (module for Omeka S)

New versions of this module and support for Omeka S version 3.0 and above are available on GitLab, which seems to respect users and privacy better than the previous repository.

Advanced Search adapter for Solr is a module for Omeka S that provides an Advanced Search adapter for Apache Solr, so it is possible to get the power of a full search engine inside Omeka, for the public or in admin: search by relevance (score), instant search, facets, autocompletion, suggestions, etc.

Technically, the module is based on the library Solarium, and it is compatible with any past, current and future versions of Solr. It is well maintained, and it comes with a full api and a full documentation, so it allows to integrate new features simpler, in particular for the indexation and the querying. This library is used in the equivalent modules for most common cms too.

The main advantage of this library is that it doesn’t require the Solr PHP extension installed on the server, so it can be installed simpler as any other module, in particular on any shared web hosting services. Of course, it still requires a Solr server, but it can be provided by another server or by a third party.

Solr can be installed quickly from official solr tarball or from debian packages for Debian 10/11.

Installation

This module uses the modules Advanced Search (version 3.3.6 or above) and Common, that should be installed first.

The module uses an external library, Solarium, so use the release zip to install it, or use and init the source.

See general end user documentation for installing a module.

From the zip

Download the last release [SearchSolr.zip] from the list of releases (the master does not contain the dependency), and uncompress it in the modules directory.

From the source and for development

If the module was installed from the source, rename the name of the folder of the module to SearchSolr, go to the root of the module, and run:

composer install --no-dev

Requirements

Module Advanced Search version 3.5.46 or above.
A running Apache Solr. Compatibility:
- version 3.5.15 of this module has been tested with Solr 5 and Solr 6.
- version 3.5.15.2 of this module has been tested with Solr 6 to Solr 8.
- version 3.5.32.3 of this module has been tested with Solr 8 and above.
- version 3.5.39.4 of this module has been tested with Solr 9 and above.
- version 3.5.47 of this module has been tested with Solr 9 and above.

Quick start

Installation
1. Install Solr (see a Solr tutorial or documentation, or below for Debian).
2. Create a Solr index (= "core") (see below "Solr management"), that is named omeka or whatever you want (use it for the path in point 2.1).
3. Install the module Advanced Search.
4. Install this module Advanced Search adapter for Solr.
In Solr admin
1. A default core default is automatically added, and it is linked to the default install of Solr with the path solr/omeka. It contains a default list of mappings for Dublin Core elements too.
2. Check if this core is working, or configure it correctly (host, port, and path of the Solr instance): the status should be OK.
3. This default core can be customized if needed, for example to force the queries to be a "OR" query (default) or a "AND" query (more common).
In Search admin
1. Create an index
  1. Add a new index with name Default or whatever you want, using the Solr adapter and the default core.
  2. Launch the indexation by clicking on the "reindex" button (two arrows forming a circle).
2. Create a page
  1. Add a page with name Default or whatever you want, a path to access it, for example search or find, the index that was created in the previous step (Default (Solr) here), and a form (Basic). Forms added by modules can manage an advanced input field and/or filters.
  2. In the page configuration, you can enable/disable facet and sort fields by drag-drop. The order of the fields will be the one that will be used for display. Note that some fields seem duplicated, but they aren’t. Some of them allow to prepare search indexes and some other facets or sort indexes. Some of them may be used for all uses. For example, you can use dcterms_type_ss, dcterms_subject_ss, resource_class_s, item_set_dcterms_title_ss, dcterms_creator_ss, dcterms_date_s, dcterms_spatial_ss, dcterms_language_ss and dcterms_rights_ss as facets, and Relevance, dcterms_title_s, dcterms_date_s, and dcterms_creator_s as sort fields. See below more information about [indexation in Solr].
  3. Edit the name of the label that will be used for facets and sort fields in the same page. The string will be automatically translated if it exists in Omeka.
  4. There are options for the default search results. If wanted, the query may be nothing, all, or anything. See the documentation.
In admin or site settings
1. To access to the search form, enable it in the main settings (for the admin board) and in the site settings (for the front-end sites). So the search engine will be available in the specified path: https://example.com/s/my-site/search or https://example.com/admin/search in this example.
2. Optionally, add a custom navigation link to the search page in the navigation settings of the site.
In Solr dashboard
1. In the case the search doesn’t return any results, check the config of the core in the Solr Dashboard and see this issue on omeka.org to set and fill the default field. Or check if there is a field "*" in the schema that is ignored.

The search form should appear. Type some text then submit the form to display the results as grid or as list. The page can be themed.

IMPORTANT

The Search module does not replace the default search page neither the default search engine. So the theme should be updated.

Don’t forget to check Search facets and sort fields of each search page each time that the list of core fields is modified: the fields that don’t exist anymore are removed; the new ones are not added; the renamed ones are updated, but issues may occur in case of duplicate names.

Furthermore, a check should be done when a field has the same name for items and item sets.

Don’t forget to reindex the fields each time the Solr config is updated too.

Indexation in Solr

The default indexation is working fine: everything is indexed as text and most of people use the basic search engine à la Google. In such cases, Solr manages uppercase/lowercase, transliteration, scoring, etc.

Nevertheless, some people want an advanced search where they can request on a specific property, or a group of metadata, with pattern, and even combine them together with various joiners (and, or, not, near…). In that particular case, it will be required to create multiple indexes in details.

Indexation with third party

The module makes possible to store multiple indexes in the same core. This is an advanced feature that is useless in most of the cases. It may be used to share one core between multiple Omeka install or with another tool or another cms. To make it working, you have to fill the field name where the index name will be stored in the config of the core. Of course, the fields should be defined precisely and in coherence with the other tool that access to it.

With Drupal, the default fields to set in the core form are: bs_is_public, ss_resource_name, im_site_id, and index_id. The mapping should be created according to the config inside Drupal, for example: ss_title and tm_body. The sort fields are automatically managed.

Solr install

The packaged release of Solr on Debian is obsolete (3.6.2), so it should be installed via the original sources. If you have a build or a development server, it’s recommended to create a Solr package outside of the server and to install it via dpkg. The process is the same for Red Hat and derivatives.

Install Solr

Solr 9 requires Java 11 (OpenJdk 11), but the last version of java is recommended (OpenJdk 17). See other Solr system requirements. The headless version is enough. The following guide is an abstract of the official guide for production.

cd /tmp
# Check if java is installed with the good version.
java -version
# If not installed, install it (uncomment line below).
#sudo apt install default-jre-headless
# On CentOs:
#sudo dnf install java-17-openjre-headless
# On CentOs, Solr requires lsof:
#sudo dnf install lsof
# If the certificate is obsolete on Apache server, add --no-check-certificate.
# To install another version, just change all next version numbers below.
wget https://dlcdn.apache.org/solr/solr/9.7.0/solr-9.7.0.tgz
# Extract the install script
tar zxvf solr-9.7.0.tgz solr-9.7.0/bin/install_solr_service.sh --strip-components=2
# Launch the install script (by default, Solr is installed in /opt; check other options if needed)
sudo bash ./install_solr_service.sh solr-9.7.0.tgz
# Add a symlink to simplify management (if not automatically created).
#sudo ln -s /opt/solr-9.7.0 /opt/solr
# In some cases, there may be a issue on start due to missing log directory:
#sudo mkdir /opt/solr/server/logs && sudo chown solr:adm /opt/solr/server/logs && sudo systemctl restart solr
# Clean the sources.
rm solr-9.7.0.tgz
rm install_solr_service.sh

If not protected by a firewall or a proxy or a complex environment, you will access to solr admin page at http://example.org:8983/solr. See below to create a ssh tunnel to access it when protected.

Anyway, you don't need to access to the Solr user interface to use it with Omeka.

Integration in the system

Services

Solr may be managed as a system service:

sudo systemctl status solr
sudo systemctl stop solr
sudo systemctl start solr

The result may be more complete with direct commands:

sudo su - solr -c "/opt/solr/bin/solr status"
sudo su - solr -c "/opt/solr/bin/solr stop"
sudo su - solr -c "/opt/solr/bin/solr start"
sudo su - solr -c "/opt/solr/bin/solr restart"

Warning: Solr is a java application, so it is very slow to start, stop and restart on some environments. You may need to wait until five minutes between two commands stop/start/restart.

In case of an issue, you may stop the service or kill it. In that case, you need to kill java too.

Solr is automatically launched and available in your browser at http://localhost:8983.

Solr is available via command line too at /opt/solr/bin/solr. If solr created a group "solr", you may need to add yourself to it (sudo usermod -aG solr myName).

Creation of the service in old versions of Solr or distributions

For some old versions of Solr on some linux distributionsn, the service may not be available after the install. In that case, and only if the service is not available as init or service, you can create the file "/etc/systemd/system/solr.service", that may need to be adapted for the distribution, here for Debian 11 or CentOs 8 (see the solr service gist).

It is usually useless when the file "/etc/init.d/solr" exists, because systemctl manages old services managed as init. Note that the default init doesn't manage restart on failure. The following service sets it at 30 seconds. Furthermore, the logs are simpler with systemd.

Warning: If you choose to use this file, you should remove properly the file used for the solr service in /etc/init.d/ first.

After creating the following file, run sudo systemctl enable solr, then sudo systemctl daemon-reload.

# Save this file as /etc/systemd/system/solr.service as root

# below paths assume solr installed in /opt/solr, SOLR_PID_DIR is /data
# and that all configuration exists in /etc/default/solr.in.sh which is the case if previously installed as an init.d service
# change port in pid file if differs
#
# note that it is configured to auto restart solr if it fails (Restart=on-failure) and that's the motivation indeed :)
# to switch from systemv (init.d) to systemd, do the following after creating this file:
# sudo systemctl daemon-reload
# sudo service solr stop # if already running
# sudo systemctl enable solr
# systemctl start solr
# this was inspired by https://confluence.t5.fi/display/~stefan.roos/2015/04/01/Creating+systemd+unit+(service)+for+Apache+Solr

[Unit]
Description=Apache Solr
ConditionPathExists=/opt/solr
Wants=network-online.target
After=network-online.target
Before=multi-user.target
Conflicts=shutdown.target
StartLimitIntervalSec=60

[Service]
User=solr
Group=solr

Type=forking
ExecStart=/opt/solr/bin/solr start
ExecReload=/opt/solr/bin/solr restart
ExecStop=/opt/solr/bin/solr stop
Restart=on-failure
RestartSec=30

# Optional config.
LimitNOFILE=1048576
LimitNPROC=1048576
# PIDFile=/var/solr/solr-8983.pid
# Environment=SOLR_INCLUDE=/etc/default/solr.in.sh
# Environment=RUNAS=solr
# Environment=SOLR_INSTALL_DIR=/opt/solr

[Install]
WantedBy=multi-user.target

Checks

Warning Avoid to start solr by the cli and by systemctl, else you will find issues, port already used, nodes lost, etc. To check if there is only one server running in standalone mode:

sudo /opt/solr/bin/solr status
sudo systemctl status solr

Even if it seems that solr is stopped, wait at least 5 minutes between command start/restart/stop to let more time to java to stop really. There is a warning, but not in all cases:

Sending stop command to Solr running on port 8983...
waiting up to 180 seconds to allow Jetty process 2917645 to stop gracefully.

You may check if there is a remaining pid file /var/solr/solr-8983.pid, and remove if it is still present while solr is stopped.

Protect access to Solr when needed (Solr 8 and above)

The protection of solr may not be required when there are other security measures. So you may skip all this point.

For documentation before Solr 8, see the readme of this module until version 3.5.31.3.

You may need some more commands to protect install. Check the default port 8983.

The simplest solution is to close this port with your firewall and to use Apache as a reverse proxy to it, so only Apache should be protected.

In any case, you need to use the default user or to add a user to access to the admin board. Search on your not-favorite search engine to add such a protection.

As indicated in Solr Basic Authentication, add the file security.json, with the user roles you want (here the user omeka_admin is added as admin). The directory where to place the file is usually /var/solr/data/, but it may be /opt/solr/server/solr in some cases. The good one ("solr home") is visible when you check the status:

/opt/solr/bin/solr status
# or sometime
systemctl status solr

Because the password is hashed (salt + sha256), it may be simpler to use the example, then to update the admin, then to remove the example user (solr, with password "SolrRocks"):

{
    "authentication":{
        "blockUnknown": true,
        "class":"solr.BasicAuthPlugin",
        "credentials":{
            "solr": "IV0EHq1OnNrj6gvRCwvFwTrZ1+z1oBbnQdiVC3otuq0= Ndd7LKvVBAaZIF0QAVi1ekCfAJXr1GGfLtRUXhgrF8c="
        },
        "realm":"Omeka Solr",
        "forwardCredentials": false
    },
    "authorization":{
        "class":"solr.RuleBasedAuthorizationPlugin",
        "permissions":[
            {
                "name":"security-edit",
                "role":"admin"
            }
        ],
        "user-role":{
            "omeka_admin":"admin",
            "solr":"admin"
        }
    }
}

Warning Don't forget to change rights of this file, then to restart Solr and wait some minutes for java:

# if the directory is "/var/solr/data":
sudo chown -R solr:solr /var/solr/data && sudo chmod -R g+r,o-rw /var/solr/data
# else if the directory is "/opt/solr/server/solr":
#sudo chown -R solr:solr /opt/solr/server/solr && sudo chmod -R g+r,o-rw /opt/solr/server/solr
# If an issue occurs, it may be a previous java session not closed. Check it with:
#sudo /opt/solr/bin/solr status
# And try to stop it:
#sudo /opt/solr/bin/solr stop
# And if solr doesn't stop, you kill it via java:
#pkill -KILL java
sudo systemctl restart solr

To add the hashed password, it is simpler to use the api endpoint, so add the specific admin user like that, and restart the server:

Important: don't forget to remove the next lines from the shell or browser history, because they contain the password. Or add a space before the commmand line to skip it from the history. Anyway, the password should be added in the config of the module, so it is available in the database.

curl --user solr:SolrRocks http://localhost:8983/api/cluster/security/authentication -H 'Content-type:application/json' -d '{"set-user": {"omeka_admin":"My Secret Pass Phrase"}}'
sudo systemctl restart solr

Finally, after some minutes for java, you should remove the default admin "solr" or change its password, and restart the server again:

curl --user 'omeka_admin:My Secret Pass Phrase' http://localhost:8983/api/cluster/security/authentication -H 'Content-type:application/json' -d  '{"delete-user": ["solr"]}'
sudo systemctl restart solr

Of course, the user omeka_admin and the password should be set in the config of the core in the Solr page inside Omeka.

Taking Solr to production

See taking Solr to production.

sudo touch /etc/security/limits.d/200-solr.conf
# On CentOs, you may set params as global, so to use `*` instead of `solr` for each following command:
echo "solr    hard    nofile  65000" | sudo tee -a /etc/security/limits.d/200-solr.conf
echo "solr    hard    nproc   65000" | sudo tee -a /etc/security/limits.d/200-solr.conf
echo "solr    soft    nofile  65000" | sudo tee -a /etc/security/limits.d/200-solr.conf
echo "solr    soft    nproc   65000" | sudo tee -a /etc/security/limits.d/200-solr.conf
sudo systemctl restart solr

Important: It is recommended to protect Solr with a reverse proxy (see below).

Enable ssl (https) when not behind a proxy

If you don't use localhost and if your Solr server is separated from the web server and not in a secure network or not behind a firewall or you want to access it from outside, it is recommended to secure it. See below to hide it behind Apache for a simpler configuration.

The reference guide of Solr explains this point, but the example uses a self-signed certificate, that may be rejected by the web server if it has not the root certificate.

So take a true certificate or create a Let's encrypt one, then enable it in Solr.

# Check the existing certificate and backup it if needed.
ls -lsa /opt/solr/server/etc/*.p12
# Create the p12 certificate with the full chain of the certificate.
sudo openssl pkcs12 -export -out ll -lsa /opt/solr/server/etc/solr-ssl.keystore.p12 -inkey /path/to/my/private/ssl.key -in /path/to/my/ssl.cert -certfile /path/to/the/complete/ssl.full-chain.everything
# Secure the certificate.
sudo chown -R solr:solr /opt/solr/server/etc/*.p12
sudo chmod go-rwX /opt/solr/server/etc/*.p12

Next, enable the ssl inside the main config file "sudo nano /etc/default/solr.in.sh", as specified in the guide. The port may be changed. Solr doesn't seem to recommend 8443 anymore, but 8984. Anyway, it's only a choice. You can keep 8983 too. In all cases, don't forget to open the port in the firewall, for example with firewall-d:

sudo firewall-cmd --permanent --add-port=8984/tcp
sudo firewall-cmd --reload

Finally, stop and restart Solr.

Sometime, the restart is too quick, so you may have to remove all lock files before restart. Check status and logs if needed.

sudo systemctl stop solr
sudo find /opt/solr/server/solr -name 'write.lock' -type f -delete
#sudo find /var/solr/data -name 'write.lock' -type f -delete
sudo systemctl restart solr

Important: the certificate of solr should be updated each time the source certificate expires.

Managing CORS with Solr

When called from the server through the module, CORS don't need to be configured. But when the autosuggestion is configured to use an endpoint directly from the browser, generally for performance reasons, the server should be either behind a reverse proxy, or configured to accept direct requests from ajax.

To add the CORS header to Solr is slightly complicate, so not described here. Anyway, it is not recommended to expose Solr directly to the web without any security measures.

Use Apache as a reverse proxy for Solr

To configure a reverse proxy for Solr with Apache, create this file "/etc/apache2/sites-available/solr.mydomain.conf":

<VirtualHost *:8984>
    ServerName solr.mydomain.com
    ProxyPreserveHost on
    ProxyRequests off

    RewriteEngine On
    RewriteRule ^\/solr(.*)$ $1 [L,R]

    ProxyPass / http://localhost:8983/solr/
    ProxyPassReverse / http://localhost:8983/solr/
</VirtualHost>

Here, Solr should be available through port 8983 without ssl on the server, so the firewall should be configured to close this port and to open 8984. You can complete this virtual host with your ssl config.

Then enable this new config:

sudo a2ensite solr.mydomain
sudo systemctl reload apache2

Upgrade Solr

Before upgrade, you should backup the folder /opt/solr/server/solr or /var/solr and check the backup in all cases, and in particular when the config is not the default one. For Solr itself, with the default install mode, the new version is installed beside the current one, so it is not required to backup the app itself, but you can backup the folder /opt/solr/server/etc if you want.

Note: Solr can only be upgraded one major version by one major version, so to upgrade from version 6 to 8, you first need to upgrade to version 7.

cd /tmp
# Check if java 17 recommended (or 11).
java -version
#sudo apt install default-jre
wget https://archive.apache.org/dist/lucene/solr/9.7.0/solr-9.7.0.tgz
tar zxvf solr-9.7.0.tgz solr-9.7.0/bin/install_solr_service.sh --strip-components=2
# The "-f" means "upgrade". The symlink /opt/solr is automatically updated.
sudo bash ./install_solr_service.sh solr-9.7.0.tgz -f
rm solr-9.7.0.tgz
rm install_solr_service.sh
# See below to upgrade the indexes.

Uninstall Solr

When Solr is installed manually, there is no automatic uninstallation process. The next commands are dangerous, so check the commands above twice before executing, in particular don’t add whitespace after the slashs "/".

sudo systemctl stop solr
sudo update-rc.d -f solr remove
# Equivalent for CentOs:
# sudo chkconfig --del solr
sudo rm /etc/init.d/solr
sudo rm /etc/rc.d/init.d/solr
sudo rm /etc/default/solr.in.sh
sudo rm /etc/security/limits.d/200-solr.conf
sudo rm -r /opt/solr
sudo rm -r /opt/solr-9.7.0
# Only if you want to remove your indexes. WARNING: this will remove your configs too.
# sudo rm -r /var/solr
sudo deluser --remove-home solr
sudo deluser --group solr

The config and the data located in either in /opt/solr/server/solr or in /var/solr/data by default can be removed too.

Solr management

Until Solr version 7, the common way to configure Solr was to use the command line. Since version 8, it's often simpler to use the api endpoint, via a browser or via curl. In fact, the command is now a shortcut to the endpoint and the url is indicated in the results. Of course, it can be done via the ui too.

To access to the ui when the Solr is protected, you can create a tunnel on your computer via ssh:

ssh -N -f [email protected] -L8983:myserver.org:8983

Then you can go to http://localhost:8983 with your browser, that will be redirected to the real server.

Create a config

At least one index ("core") should be created in Solr to be used with Omeka. The simpler is to create one via the UI or via the command line.

Most of the times, when installed manually, there are permissions issues and strange issues during the creation of the core. So if you want to create the core quicker without any issue, use the web interface or see below the "manual way".

Automatic way

The automatic way often creates issues. So see the official full documentation.

Important: don't mix old commands (sudo su - solr -c "/opt/solr/bin/solr) and curl ones. Check first if there are not multiple solr running (with or without sudo, with or without systemctl). See above to check them.

In the following commands, skip the user and password when there is no such a security.

# Via api, with a user:
curl --user 'omeka_admin:MySecretPassPhrase' 'http://localhost:8983/solr/admin/cores?action=CREATE&name=omeka&instanceDir=omeka&schema=data_driven_schema_configs'
# Via command ("old school"):
#sudo su - solr -c "/opt/solr/bin/solr create -c omeka -n data_driven_schema_configs"

Here, the user omeka_admin launches the command solr to create the core omeka, and it will use the default config schema data_driven_schema_configs. This schema simplifies the management of fields, because they are guessed from the data.

Here, the path to set in the config of the core in Omeka S is solr/omeka.

You can check it via the web interface at http://localhost:8983/solr/#/omeka. You can access to the localhost through a ssh tunnel, or use the domain you set in the config.

The config files are saved in /var/solr/data by default.

Possible issues (always restart solr after trying next commands):

The directory /var/solr is not belonging to solr, so run sudo chown -R solr:solr /var/solr.

The resources may be missing, so copy them:

sudo cp -r /opt/solr/server/solr/configsets/_default/conf /opt/solr/server/resources/

There may be remaining files after a failed creation, so run first curl --user 'omeka_admin:MySecretPassPhrase' 'http://localhost:8983/solr/admin/cores?action=UNLOAD&core=omeka&deleteIndex=true&deleteDataDir=true&deleteInstanceDir=true' (or sudo su - solr -c "/opt/solr/bin/solr delete -c omeka")
There may be a remaining lock file after a kill, so check in solr home: sudo rm /var/solr/solr-8983.pid.
Check if it is a service issue: try to run it as a user the sudo -u solr /opt/solr/bin/solr start.
Check if it is a rights issue: try to run it as a user the sudo /opt/solr/bin/solr start -force.
There may be a rights issue, so backup and remove the file "security.json" from the data directory, then create the core with the command above, then restore the file "security.json".

Manual way

If nothing is working (you don't see the core inside the front-end), create the core yourself with these commands, here with a core named omeka (here when the solr home directory is /var/solr):

First, you need to stop or kill all solr and associated java processes.

# The destination directory inside data is the name of the core, here "omeka".
# It should be updated in following command if the name is different.
CORE="omeka"

# Here, for solr home as "/var/solr/data". Change it if it is "/opt/solr/server/solr"
# Clean previous failed installations.
sudo rm -rf /var/solr/data/$CORE

# Either:
# When installed with the tarball or from the official docker images.
sudo cp -r /opt/solr/server/solr/configsets/_default /var/solr/data
# When installed with the debian package.
sudo cp -r /usr/share/solr/server/solr/configsets/_default /var/solr/data

# Rename and create the main file.
sudo mv /var/solr/data/_default /var/solr/data/$CORE

# Fill the core.properties (only the last line is really needed)
sudo touch /var/solr/data/$CORE/core.properties
sudo bash -c "echo '#Written by CorePropertiesLocator' >> /var/solr/data/$CORE/core.properties"
sudo bash -c "echo '#Mon Jan 06 00:00:00 UTC 2025' >> /var/solr/data/$CORE/core.properties"
sudo bash -c "echo 'name=$CORE' >> /var/solr/data/$CORE/core.properties"
sudo chmod ug+rw /var/solr/data/$CORE/core.properties

# Set the permissions
sudo chown -R solr:solr /var/solr

# Restart
sudo systemctl restart solr

# Test (no error output)
curl "http://localhost:8983/solr/$CORE/select?omitHeader=true&wt=json&json.nl=flat&q=%2A%3A%2A&start=0&rows=10"

The file core.properties above should contain the name of the core, that should be the name of the directory:

#Written by CorePropertiesLocator
#Mon Jan 06 00:00:00 UTC 2025
name=omeka

It is possible to create the authentication file security.json manually too.

Querying Solr

You can check if the Solr core is working via the user interface or via such a command:

# When there is no security:
curl 'http://localhost:8983/solr/omeka/select?q=*:*&indent=on&wt=json'
# When there is a user with a password:
curl --user 'omeka_admin:MySecretPassPhrase' 'http://localhost:8983/solr/omeka/select?q=*:*&indent=on&wt=json'

Fixing the issue when there is no result

When there is no default field, Solr may not answer anything. To fix this issue, as indicated in this issue on omeka.org, add the copy field _text_ with source *.

It can be done via the user interface (in the menu Schema). Or you can use this command, as indicated in the reference guide to copy a field:

# Without user/password.
curl -X POST --data-binary '{"add-copy-field":{"source":"*","dest":"_text_" }}' 'http://localhost:8983/solr/omeka/schema'
# Or with a user/password.
curl --user 'omeka_admin:MySecretPassPhrase' -X POST --data-binary '{"add-copy-field":{"source":"*","dest":"_text_" }}' 'http://localhost:8983/solr/omeka/schema'

The response status should be 0. Of course, you need to reindex resources after this modification of the schema.

Upgrade a config

If you choose a data driven schema, you can remove it and create a new one with the same name.

# Warning: These commands are used for data driven indexation **without specific config**. Else, backup your config first.
sudo su - solr -c "/opt/solr/bin/solr delete -c omeka"
sudo su - solr -c "/opt/solr/bin/solr create -c omeka -n data_driven_schema_configs"

If you have a special config, consult the Solr documentation.

After, an upgrade or any change in the config, go back to Omeka to reindex data.

Clean logs of Solr

If you keep the default config of Solr, the logs are stored on the main file system and after some months or years, the file system may be filled. So change the config or add a cron to stop/clean/restart Solr.

sudo /opt/solr/bin/solr stop
sudo rm /opt/solr/server/logs/solr-8983-console.log
sudo /opt/solr/bin/solr start

Migrate a config

If you have a new server and that the version is the same or the previous one, it is possible to copy the old install to the new one. Don't forget to remove the write lock if needed before restarting:

# From the new server (for a core named "omeka"). Use solr home (/opt/solr/server/solr
# or /var/solr/data according to your install).
sudo systemctl stop solr
rsync -va [email protected]:/var/solr/data/omeka /var/solr/data
rm /var/solr/data/omeka/data/index/write.lock
sudo chown -R solr:solr /var/solr
sudo systemctl restart solr

TODO

Warning

Use it at your own risk.

It’s always recommended to backup your files and your databases and to check your archives regularly so you can roll back if needed.

Note: By default, the config of the server Solr is saved in /opt/solr/server/etc and in /etc/default/solr.in.sh; the config of the cores are saved in /opt/solr/server/solr or in /var/solr/data.

Troubleshooting

See online issues on the module issues page on GitHub.

License

This module is published under the CeCILL v2.1 license, compatible with GNU/GPL and approved by FSF and OSI.

This software is governed by the CeCILL license under French law and abiding by the rules of distribution of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL license as circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".

As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software’s author, the holder of the economic rights, and the successive licensors have only limited liability.

In this respect, the user’s attention is drawn to the risks associated with loading, using, modifying and/or developing or reproducing the software by the user in light of its specific status of free software, that may mean that it is complicated to manipulate, and that also therefore means that it is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the software’s suitability as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions as regards security.

The fact that you are presently reading this means that you have had knowledge of the CeCILL license and that you accept its terms.

Copyright

See commits for full list of contributors.

This module is a full replacement of the module Solr, a deprecated fork based on the version 0.4 of the module Solr by BibLibre. This later was built for the digital library Explore of Université Paris Sciences & Lettres. The fork Advanced Search adapter for Solr is built for the digital library Manioc of Université des Antilles et de la Guyane, formerly managed with Greenstone.

Name		Name	Last commit message	Last commit date
Latest commit History 655 Commits
asset		asset
config		config
data		data
language		language
src		src
test		test
view		view
.gitignore		.gitignore
.travis.yml		.travis.yml
LICENSE		LICENSE
Module.php		Module.php
README.md		README.md
build.xml		build.xml
composer.json		composer.json
composer.lock		composer.lock
phpunit.xml		phpunit.xml

License

Daniel-KM/Omeka-S-module-SearchSolr

Folders and files

Latest commit

History

Repository files navigation

Advanced Search adapter for Solr (module for Omeka S)

Installation

Requirements

Quick start

Indexation in Solr

Indexation with third party

Solr install

Install Solr

Integration in the system

Services

Creation of the service in old versions of Solr or distributions

Checks

Protect access to Solr when needed (Solr 8 and above)

Taking Solr to production

Enable ssl (https) when not behind a proxy

Managing CORS with Solr

Use Apache as a reverse proxy for Solr

Upgrade Solr

Uninstall Solr

Solr management

Create a config

Automatic way

Manual way

Querying Solr

Fixing the issue when there is no result

Upgrade a config

Clean logs of Solr

Migrate a config

TODO

Warning

Troubleshooting

License

Copyright

About

Resources

License

Stars

Watchers

Forks

Releases 40

Packages 0

Contributors 5

Languages

Packages