| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| development:troubleshooting [2019/02/27 13:55] – demiankatz | development:troubleshooting [2020/02/19 14:57] – [Turn on Debug Mode] demiankatz |
|---|
| |
| 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 ===== |
| If you want more information about what VuFind is doing, you can set the debug setting in the [System] section of your config.ini file (generally found in $VUFIND_LOCAL_DIR/config/vufind/config.ini) to true. This will output debug messages as part of the HTML that VuFind generates. In many cases, these will reveal useful information, but be warned: in some cases, the debug messages will be difficult to read, and they may interfere with some of VuFind's AJAX functionality. If you encounter those problems, proceed to the next section.... | If you want more information about what VuFind is doing, you can set the debug setting in the [System] section of your config.ini file (generally found in $VUFIND_LOCAL_DIR/config/vufind/config.ini) to true. This will output debug messages as part of the HTML that VuFind generates. In many cases, these will reveal useful information, but be warned: in some cases, the debug messages will be difficult to read, and they may interfere with some of VuFind's AJAX functionality. If you encounter those problems, proceed to the next section.... |
| |
| | ==== "Debug on the Fly" ==== |
| | |
| | You can also turn on debug mode via a URL parameter, if you have appropriate permissions set up. If you add "debug=true" to the end of any VuFind URL, debug mode will be activated if the current user has the "access.DebugMode" permission granted via the [[configuration:permission_options|permission system]]. This feature was broken in several VuFind releases; see [[https://vufind.org/jira/browse/VUFIND-1382|VUFIND-1382]] for details on affected versions and a fix for the problem. |
| ===== Turn on Logging ===== | ===== Turn on Logging ===== |
| |
