Differences

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

--- development:troubleshooting [2019/02/27 13:52] – created demiankatz
+++ development:troubleshooting [2019/03/07 13:45] – demiankatz
@@ Line 5: / Line 5: @@
 ===== 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.
 ===== Turn on Debug Mode =====
@@ Line 16: / Line 20: @@
 Logging is not only a useful way to troubleshoot a known problem, but it is also a good way to detect unknown problems -- setting up a log in a production system and monitoring it for unusual activity is strongly recommended.
+===== Use Xdebug =====
+In a situation where you need to closely inspect how code is behaving, you can use PHP's Xdebug extension for full code-level debugging functionality -- step through code, inspect variable values, etc. Several IDEs support Xdebug, and a Google search for "Xdebug" and the tool of your choice should provide the latest instructions on how to set things up. If you are not already using an IDE, see our [[development:recommended_tools|Recommended Tools]] page for some free, open source options.
 ===== Use Your Browser's Debugging Tools =====