How to access the store when it is closed for maintenance for too long
page last edited on 13 June 2017
Sometimes site changes like installing a new module, upgrading your X-Cart core or rebuilding your store site’s cache may not go as smoothly as planned. A syntax error in the code of a new module, a module’s incompatibility with the new X-Cart core after an upgrade or a cache rebuild failure may crash your store’s website, so when you attempt to access it you will continuously see a page saying “The site is temporarily closed for maintenance”:
This article describes what you can do if you face this major problem and get your store up and running.
Table of Contents
- Table of Contents
- Drop and re-create your site’s cache
- Contact your hosting team
- Recover your store using safe mode
Drop and re-create your site’s cache
If you suspect the problem is caused by that your site’s cache rebuild process was not completed properly, you should try clearing your store’s cache and running the cache rebuild process anew.Normally, cache rebuild process takes place when you apply a core upgrade, install a new module, enable/disable an installed module, or manually launch the cache rebuild process by selecting Re-deploy the store in the Cache management section (System settings > Cache management) in your store’s Admin area. If your store stopped functioning after one of those actions, chances are high that is because of problems with your site’s cache. There are quite a number of reasons why cache re-generation may go wrong for your site, one of the most popular being closing the page where the cache rebuild process is being executed. But no matter what caused the problem, you can try to resolve it using one of the following methods:
- Access your store using a link similar to the following:
https://www.example.com/x-cart/admin.php?drop_cache&access_key=XXXXXXXXXXXXXXReplace the portion “https://www.example.com/x-cart/” with the actual address of your store and use your actual Safe Mode access key instead of XXXXXXXXXXXXXX. The Safe Mode access key can be copied from the file
var/data/.safeModeAccessKeyin your X-Cart installation folder or from any of the two reset links that were sent to your site administrator mailbox after X-Cart installation (The message subject reads “Soft and Hard reset links for your store!”; for X-Cart versions 5.1.8 and earlier the subject was ”New safe mode access key has been generated!”). When you use this link, your existing site cache is dropped, and the cache rebuild process is launched automatically.
- Delete the folder var/run and the file var/.rebuildStarted in your X-Cart installation folder and go to your store’s Admin area. X-Cart will detect the absence of cache and will automatically launch the cache rebuild process.
Contact your hosting team
Good hosting companies back up your entire website (databases and files) every day. Excellent ones - even more often.
If your website crashed for any reason, contact your hosting team and ask them to recover your store from backup.
Recover your store using safe mode
It might happen that your hosting provider does not respond to you in time and you have to deal with the situation by yourself. Another possibility is that you are working in development environment and need to find out what exactly crashed your store so you would be able to fix it. In this case you may want to try using safe mode. Safe mode allows you to re-deploy your store with a limited set of modules, which can help you to identify the source of the problem more easily.
To run your store in safe mode, you need to access your store website using a Hard or Soft reset link. The links can be found in your store’s Admin area on the Safe mode page (System settings > Safe mode). They can also be found in an email message that was sent to the administrator mailbox after X-Cart installation (For X-Cart versions 5.1.9 and later, the message subject reads “Soft and Hard reset links for your store!”, for earlier versions - “New safe mode access key has been generated!”).
The format of the reset links is as follows:
- Hard reset:
- Soft reset:
(If you cannot access your Hard and Soft reset links, you can re-create them manually by replacing the part
<shop_domain> with the actual domain of your store and the part
<shop_key> with your actual Safe Mode access key from the file var/data/.safeModeAccessKey).
Clicking on a reset link disables some or all of the modules installed at your store (Detailed information on the action of each link is available in the table below). Then X-Cart 5 tries to recover itself. Once your store is back online, you can try enabling the modules again one by one in order to identify the one causing your site to crash. As soon as you know which module is causing it, you can contact its developer to get it fixed.
|X-Cart versions 5.x-5.2.6||X-Cart versions 5.2.7|
Disables all the custom modules uploaded to the store directly via the "Upload addon" feature
(NOT via the X-Cart Marketplace)
|Disables all the modules except for the ones developed by X-Cart 5 team and Qualiteam|
Disables absolutely all the modules and custom mods, leaving only the core
|Disables all the modules except for the ones developed by X-Cart 5 team|
Any custom modifications uploaded to your store in the form of modules via the "Upload addon" feature are disabled regardless of the reset link type (Hard or Soft) - no matter who the author of the modification is, whether it be X-Cart service departments, X-Cart partners or 3rd party developers.
Starting with X-Cart version 5.2.7, the Safe mode section of your store’s Admin area also provides the so-called “Current state” link. This link corresponds to your store’s latest snapshot. It may be useful if you want to capture the current state of your store and bring your store back to this state later. For example, you can copy this link and store it in a separate file before you try to install a new module. If the installation goes wrong, you will be able to restore your site by visiting this link: your store will be re-deployed with only the modules that were active at the time you copied the link. The format of the Current state link is as follows:
(The link can be easily re-created manually by replacing the part “
<shop_domain>” with the actual domain of your store, the part ”
<shop_key>” with your actual Safe Mode access key from the file
<restore_date> with the date of the snapshot that needs to be restored).
Help make this document better
This guide, as well as the rest of our docs, are open-source and available on GitHub.