How to Activate the Debug or Developer mode in Shopware store

The Most Popular Extension Builder for Magento 2

With a big catalog of 224+ extensions for your online store

Find extensions

It’s necessary for every development project or e-commerce site to do thorough testing. And every developer understands how important it is to debug the Shopware store when the need comes. Debugging your ecommerce shop may be done in a variety of ways, from logging the whole process to debugging during the runtime.

In the tutorial today, we will guide you through the How to activate debug and developer mode in Shopware store and some helpful plugins you can use during configuration. Keep reading to find out more!

Table of contents

• Shopware Debugging Overview
• How to activate the Debug or Developer mode in Shopware?
  • Step 1: Open a .env file
  • Step 2: Change the source code
  • Step 3: Empty the cache
  • Step 4: Check the location of your log files
  • Step 5: Shopware independent log files (if necessary)
  • Step 6: See the results
• Top 3 plugins for debugging in Shopware
  • Set up test server/staging environment
  • Shopware 6 developer mode
  • Test Environment
• Conclusion

Shopware Debugging Overview

It is common for shopware to generate generic error messages while it is in production mode, which does not necessarily indicate the root cause of a problem. Debug or development mode must be selected in order to obtain more in-depth error messages.

It is via debugging that you might locate an issue in your Magento e-commerce business. It will also help you fix bugs/errors/anomalies in computer software.

How to activate the Debug or Developer mode in Shopware?

Fortunately, the debugging process in Shopware will only take you a few minutes to complete. We have divided this guide into small basic steps along with explanations so that you can thoroughly understand each of them and compare the final result. No more beating around the bush, let’s get started!

Step 1: Open a .env file

Shopware’s general configuration file allows you to modify the mode. The Shopware main directory contains the “.env” file on the webserver. In case you cannot find the folder in the root directory, click ctrl + h to quickly search for it:

It is important to bear in mind that files whose filename starts with ”.” are hidden by default, and may need to be seen by a program option depending on the directory call.

Step 2: Change the source code

Now, scroll down until you see this line:

APP_ENV=prod

All you have to do is make modifications to such source code, from “=prod” to “=dev” just like what we did here:

APP_ENV=dev

At this point, you are working on the developer mode, feel free to test or change anything on your website so that it fixes the current issue.

Step 3: Empty the cache

After changing the source code, it is recommended that you need to clear the cache. The command may be used from the console to do this:

php bin/console cache:clear

Step 4: Check the location of your log files

In the /var/log/ directory, you’ll find Shopware’s log files. Production mode in the.env file restricts the prod.log to just major problems.

When the developer/debug mode is selected, the dev.log is used to store the log entries. This mode should only be used for focused debugging in order to prevent a significant increase in the size of the log file.

Step 5: Shopware independent log files (if necessary)

Additional log files, such as the server’s access logs or the PHP log files, may be necessary or beneficial in addition to the Shopware-provided logs. Because the locations of these log files might change depending on the setup of the server, contact your hosting for information on their position.

Step 6: See the results

Once everything is done, you can notice that all of the errors appearing on your website have been debugged. You can turn off the developer mode by modifying the source code back to the original one.

Top 3 plugins for debugging in Shopware

In the previous tutorial, we have guided you on how to turn on the developer and debugging mode in Shopware. However, it may take you quite a while to debug those errors on your own and find the root cause.

For this reason, we have gathered a list of top 3 plugins for Shopware debugging to help you with fixing problems. You can read the features, customer reviews to pick out the best one for your online business.

Set up test server/staging environment

Having a test server is a need for a well-run Shopware store. Extensions and new plugins may only be tested in this manner, and it’s completely risk-free. Templates may be introduced at any moment without affecting the shop’s productivity or generating nasty notifications. However, with the help of the Set up test server/staging environment plugin, it is possible to set up and manage an unlimited number of test environments. Directory protection and maintenance mode may be readily implemented on the test server.

Outstanding features:

• Transfer test environment access data, including an online file editor, to the service provider.
• Automatically create a test environment using a CRON task
• Take a look at the same files in both the test and live environments.
• It is possible to entirely obscure data.
• Easy omission of directories of your choosing

Shopware 6 developer mode

In Shopware 6 developer mode plugin you can activate the debug mode to receive error warnings and much more on the frontend. The Symfony Toolbar at the bottom of the screen in the backend is active as soon as the plugin is installed.

You save a lot of time as a developer since you don’t have to clear the cache when a plugin is enabled. The store is situated in the dev folder rather than the prov. Moreover, the Symfony Profiler also illustrates the log messages, query metrics, rendered templates or the routing and so much more. Install to find out now!

Test Environment

It doesn’t matter whether you need to install new updates, plugins, or make changes to your theme; things have to be done at some point. All it takes is one flaw, a moment’s carelessness, or incompatibility to put the whole firm out of business. The Test Environment plugin has been created to ensure that the pulse remains in the right place. Your shop’s atmosphere is reflected in it, and it serves as a form of pre-surgery testing ground.

Advantages:

• Working on themes, plugins, and updates without risking
• There is no need for hurriedly recording backups.
• Time-saving troubleshooting process.
• There will be no damage done to any of your clients.

Conclusion

In a nutshell, it is inevitable that you will run into some unwanted errors while operating your online store. We hope that our article today on How to activate the Debug and Developer mode in Shopware has helped you to test and fix those problems. In this way, enhancing customer experience will no longer be a difficult task.