About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:troubleshooting

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
development:troubleshooting [2019/02/27 13:55] demiankatzdevelopment:troubleshooting [2019/05/03 11:52] – [Check the Apache Error Log] demiankatz
Line 2: Line 2:
  
 When VuFind doesn't behave as expected, there are several things you can do to gain more information about what is going wrong. When VuFind doesn't behave as expected, there are several things you can do to gain more information about what is going wrong.
 +
 +===== Check Error Logs =====
 +
 +If you are not seeing on-screen errors, it is possible that they are being captured by the Apache error log (often found in /var/log/apache2/error.log, /var/log/httpd/error.log, or a similar path). Checking the end of this log (or watching it with the "tail -f" command) may reveal useful information.
 +
 +Some operating systems use [[https://php-fpm.org/|PHP-FPM]] to run PHP, and the PHP-FPM error log is another place to check in this case. It is often found at /var/log/php-fpm/www-error.log (or something similar).
  
 ===== Turn on Development Mode ===== ===== Turn on Development Mode =====
  
-VuFind's Apache configuration includes an environment variable called VUFIND_ENV which tells the software what kind of environment it is running in -- development or production. By default, this is set to production, which activates performance-oriented caching and disabled detailed error messages for greater security. If you switch this setting to development mode (by editing $VUFIND_LOCAL_DIR/httpd-vufind.conf, uncommenting the appropriate VUFIND_ENV line, and restarting Apache), cache-related problems will automatically go away, and all on-screen error messages will be presented in much greater detail for debugging purposes.+VuFind's Apache configuration includes an environment variable called VUFIND_ENV which tells the software what kind of environment it is running in -- development or production. By default, this is set to production, which activates performance-oriented caching and disabled detailed error messages for greater security. If you switch this setting to development mode (by editing $VUFIND_LOCAL_DIR/httpd-vufind.conf, uncommenting the appropriate VUFIND_ENV line, and restarting Apache), most cache-related problems will automatically go away, and all on-screen error messages will be presented in much greater detail for debugging purposes
 + 
 +===== Clear the Cache ===== 
 + 
 +When in doubt, empty the contents of $VUFIND_LOCAL_DIR/cache -- this can solve several common problems, such as changes to language files not appearing immediately. 
 + 
 +===== Check Permission / Security Settings ===== 
 + 
 +If Apache is not allowed to read or write certain directories (particularly the cache), VuFind may have problems. The $VUFIND_LOCAL_DIR/cache directory (and all of its subdirectories except "cli") should be writable by the user running Apache (often named www-data or apache, depending on your operating system). The $VUFIND_LOCAL_DIR/cache/cli directory (and all of its subdirectories) should be writable by the user running command-line utilities. Also make sure that SELinux is not interfering with VuFind's operations; see the [[installation:fedora|Fedora Installation Instructions]] for more details on SELinux.
  
 ===== Turn on Debug Mode ===== ===== Turn on Debug Mode =====
development/troubleshooting.txt · Last modified: 2024/02/23 11:36 by demiankatz