Table of Contents
Starting and Stopping Solr
Once VuFind is installed, it will only respond to search requests if its Solr back-end is active (unless, of course, you are relying on a third-party discovery service instead of a local index, in which case you can disregard this page entirely). This page explains how to turn Solr on and off and how to automate the process if you wish.
Starting Solr Manually
To start Solr under Linux, just switch to the directory where you installed the program and run this command:
Note: If this doesn't work, make sure that the vufind.sh script has execute permissions:
chmod +x vufind.sh
Note: If you previously rebooted your system without manually stopping VuFind, the script may mistakenly believe that it is still running. In this case, a manual restart should solve the problem.
Starting with VuFind 1.0RC2, VuFind includes a Windows batch file to run Solr. Just follow these steps:
- At a command prompt, switch to your VuFind directory.
- Type: vufind start
Note that the vufind.bat file which allows this command to work is created automatically as part of the install.bat setup process. If you did not install VuFind using install.bat, the file may be missing. You can re-run the install process to solve the problem.
If you are using an earlier version of VuFind, you will have to start the server manually. From the command line, run:
cd \vufind\solr\jetty\ java -Dsolr.solr.home=c:\vufind\solr -Xmx1G -Xms1G -jar start.jar
Note: The above command assumes you want to dedicate 1 Gig of memory to the Java engine. Change the values as needed (see the Performance page for details). This is especially important on lower end machines that will quickly freeze up during indexing if no memory limit is established.
Stopping Solr Manually
To take the server offline, switch to the VuFind directory and type:
To stop a manually-started Solr instance under Windows, open the command prompt window where the server is running and hit Ctrl-C. This will cause the process to shut down.
If you are running Solr through Jetty as a service, you can stop the server through the Services control in the Administrative Tools area of Control Panel.
Restarting Solr Manually
Restarting Solr under Linux is much the same as starting it. Just switch to the VuFind directory and type:
There is no graceful way to restart a manually-started Solr instance under Windows. Just follow the manual “stop” and “start” procedures described above.
If you are running Solr through Jetty as a service, you can restart the server through the Services control in the Administrative Tools area of Control Panel.
Killing an Unresponsive Solr Process
Solr is usually very stable, especially if you restart it regularly. However, it will occasionally crash, especially if it does not have enough memory available (see the performance page for advice on memory tuning). When this happens, you may have to manually kill the crashed process.
First, use the ps command to get a list of running Java processes:
ps aux | grep java
You will see something like this:
dkatz 1326 0.3 4.3 1273128 173932 ? Sl 08:03 0:03 /usr/lib/jvm/default-java/bin/java -server -Xms1024m -Xmx1024m -XX:+UseParallelGC -XX:NewRatio=5 -Dsolr.solr.home=/usr/local/vufind/solr -Djetty.logs=/usr/local/vufind/solr/jetty/logs -Djetty.home=/usr/local/vufind/solr/jetty -jar /usr/local/vufind/solr/jetty/start.jar /usr/local/vufind/solr/jetty/etc/jetty.xml
The number after your username (“dkatz” in the example above) is the process ID. You can kill the process like this:
sudo kill -9 [process ID number]
If you repeat the ps command, you should no longer see Solr running.
Note that because you didn't stop Solr cleanly, the ./vufind.sh script may be confused the next time you try to start it up, thinking that Solr is already running. In this case, just perform a “./vufind.sh restart” instead of “./vufind.sh start” to get things back to normal.
[I have never experienced a Solr crash under Windows, but I imagine that Windows Task Manager can be used to clear up any problems. Does anyone with experience in this area care to comment? – Demian]
Running Solr Automatically
If you don't want to have to manually start and stop Solr every time you turn on or shut down your server, you can set it up to run automatically.
Linux (init.d) Method
You can set up Solr to run as a daemon. To do so, create a wrapper script in /etc/init.d/vufind:
#!/bin/sh ### BEGIN INIT INFO # Default-Start: 2 3 4 5 # Default-Stop: 0 1 6 # Description: VuFind init script ### END INIT INFO cd /usr/local/vufind ./vufind.sh $*
Note: The information in the INIT INFO block is only required for RedHat-style systems that use the chkconfig utility. You may need to adjust the start and stop runlevels depending on your system configuration.
Note: If your VuFind instance is installed somewhere other than /usr/local/vufind, be sure to adjust the cd line in the script accordingly.
Make sure that the script is executable (sudo may be needed on the command for some platforms):
chmod +x /etc/init.d/vufind
You will then need to add the script to your runlevel configuration (generally found under /etc/rc.d). The exact setup varies from flavor to flavor of Linux, but a bit of online research should help, as should these tools:
On RedHat (including Fedora): chkconfig --add vufind On Debian (including Ubuntu): update-rc.d vufind defaults
If this doesn't seem to work, be sure that VUFIND_HOME and JAVA_HOME are set in the profile of the user running the startup script.
Interacting with Solr After Automation
On some platforms, the “service” command is available to make use of startup scripts. In this case, you will be able to use it for Solr after completing configuration:
service vufind start service vufind stop service vufind restart service vufind check
(“sudo” may need to be prefixed to these commands depending on your Linux flavor and security configuration)
If service is available, it is the preferred way of starting and stopping Solr after automation.
Linux (systemd) Method
Thanks to jriedl for investigating this issue.
Some newer flavors of Linux (such as CentOS 7) use systemd instead of the traditional init.d approach.
To automate Solr with systemd, you should be able to add code similar to this in a new file called /etc/systemd/system/vufind.service:
Description=VuFind Starter After=network.target httpd.service mariadb.service [Service] Type=forking ExecStart=/bin/sh --login -c '/usr/local/vufind2/vufind.sh start' PIDFile=/var/run/vufind.pid User=root ExecStop=/bin/sh --login -c "/usr/local/vufind2/vufind.sh stop" # Java responds to a SIGTERM by returning with exit code 143 which leads to "failed" exit in the systemd-Logs SuccessExitStatus=143 [Install] WantedBy=multi-user.target
Be sure to adjust paths in the code above to match your local system.
You can run
systemctl enable vufind
to automate the start-up of Solr on boot.
Interacting with Solr After Automation
Once configured with systemd, Solr can be managed using the systemctl command.
systemctl [enable, start, stop, status] vufind
Jetty (the wrapper that allows Solr to run) can be set up as a Windows service. First we need to change a couple of config settings, one is required, the others will just help. Assuming an install location of c:\vufind, edit c:\vufind\solr\jetty\bin\jetty-service.conf. Find the lines
wrapper.java.additional.1=-Djetty.home=../ wrapper.java.additional.2=-Djetty.logs=../logs wrapper.java.initmemory=3 wrapper.java.maxmemory=64
And change them to:
wrapper.java.additional.1=-Djetty.home=../ wrapper.java.additional.2=-Djetty.logs=../logs wrapper.java.additional.3=-Dsolr.solr.home=c:\vufind\solr wrapper.java.initmemory=64 wrapper.java.maxmemory=256
You'll notice the first two lines haven't changed (they were just for reference), and the third line is passing Jetty Solr's home location. The last two lines control how much memory the JVM Jetty will be running inside of has access to. The default settings limit the JVM to 64mb, and we're going to need a lot more to comfortably run a Solr index. 256mb is still low for a server, but it's enough to play around on a laptop in comfort.
Now it's time to install the service. Open a command window and run the following:
cd \vufind\solr\jetty\bin Jetty-Service.exe -i jetty-service.conf
NOTE: If you are running Windows Vista the above will still fail with 'access denied' unless you open the command prompt with admin rights. START > Programs > Accessories. Right-click on 'Command Prompt' and choose 'Run as administrator'.
The Jetty service found in VuFind 1.x is no longer compatible with the version of Jetty used in VuFind 2.x. A best practice for running VuFind 2.x's Solr index as a Windows service has not yet been determined. See the VUFIND-589 ticket in JIRA for some helpful links and discussion, and feel free to make suggestions there (or revise this page) if you get things working.
February 2015: Solr was successfully configured as a service on both a Windows 7 test box running under XAMPP and a production Windows 8 R2 server using the following: http://blog.outerthoughts.com/2013/07/setting-up-apache-solr-on-windows-as-a-service/ It is not necessary to reinstall solr; simply point it to your current solr configuration e.g., C:\vufind\solr\jetty. Then skip down to the point in the instructions titled: Service Setup for Availability. This was the successfully modified command, remember to edit the path(s) as necessary and as stated in the online instructions, the following should not have any line breaks, insert spaces instead:
SolrService.exe //IS//SolrService --DisplayName="Solr Service" --Install=C:\vufind\solr\jetty\SolrService.exe --LogPath=C:\vufind\solr\jetty\logs --LogLevel=Debug --StdOutput=auto --StdError=auto --StartMode=java --StopMode=java --Jvm=auto ++JvmOptions=-Djetty.home=C:\vufind\solr\jetty ++JvmOptions=-DSTOP.PORT=8087 ++JvmOptions=-DSTOP.KEY=stopsolr ++JvmOptions=-Djetty.logs=C:\vufind\solr\jetty\logs ++JvmOptions=-Dorg.eclipse.jetty.util.log.SOURCE=true ++JvmOptions=-XX:MaxPermSize=128M --Classpath=C:\vufind\solr\jetty\start.jar --StartClass=org.eclipse.jetty.start.Main ++StartParams=OPTION=ALL ++StartParams=C:\vufind\solr\jetty\etc\jetty.xml --StopClass=org.eclipse.jetty.start.Main ++StopParams=--stop ++JvmOptions=-Dsolr.solr.home=C:\vufind\solr --StartPath=C:\vufind\solr\jetty
Note: the above should be entered as a single command line; it has been broken up here for readability.
Important! If you are running 64bit you'll need to retrieve the prunsrv.exe from the amd64 folder.
Judy Drescher, Molloy College
Taking the User Interface Offline
If you simply stop the Solr server, users attempting to access your VuFind site will encounter error messages. If you are planning an outage, you can take the site more gracefully offline by adjusting the “available” setting in the “[System]” section of your config.ini file.