Installation
From ZenMagick Wiki
There may be additional installation instructions included in the release notes. Please make sure to read those before installing.
Contents |
Download
The most recent version of ZenMagick may be found via the Downloading ZenMagick page.
ZenMagick releases are based on specific zen-cart versions, so make sure to download the appropriate version. (As a general rule, the latest zen-cart version should be used)
Installation
Copy/Upload Files
Unpack the downloaded archive into your zen-cart installation folder.
Upgrade from a previous version
It is recommended to remove everything from the zenmagick folder, except for your theme directory and local.php file before installing a new version. This helps to avoid having obsolete files staying around.
The ZenMagick installation screen will check for obsolete files and offer to remove them if any are found. However, this process does not cover all files and in particular won't work in case of function/class name conflicts.
Note: Zenmagick does not contain patched versions of zen-cart files. The only file in danger of getting overwritten is .htaccess. In fact, it's not an original zen-cart file, but there are other zen-cart mods that require/include one.
In those cases, .htaccess files have to be merged manually.
Updating admin
ZenMagick contains files that need to be added to the zen-cart admin directory. If you have renamed your admin directory as recommened by zen-cart (obscurity rather than security), you have two options:
- Move the contents of the ZenMagick admin folder manually into your renamed admin directory
- Extract the release locally, rename the extracted admin folder, zip everything up again and use the new zip file for installation.
Configuration
ZenMagick Patches
Even though ZenMagick does not contain modified zen-cart files, it requires changes to zen-cart files in order to work properly. ZenMagick contains a set of Patches to automatically perform those modifications.
If you are installing ZenMagick for the first time, those patches will be automatically run the next time you login to zen-cart admin. If successful, you should see a new main menu item ZenMagick with a number of items underneath.
There are a number of reasons why the patches might not work as expected. If that is the case you may not see the ZenMagick menu, but only a menu item ZenMagick Installation under the Tools menu. Selecting that you will see ZenMagick's installation options and error messages detailing why the patches did not work.
Please check the section about Troubleshooting if you can't get things to work. You may also consult the forums for similar topics or ask for help.
Required zen-cart configuration settings
- When using ZenMagick themes, the missing page check must be disabled using zen-cart admin (Configuration -> My Store: 'Missing Page Check').
Uninstall
There are separate information available about how to Uninstalling ZenMagick.
Plugins
Plugins are installed by unpacking the plugin .zip into the zenmagick/plugins folder.
Once the plugin files are in place, the new plugin will show up in the plugin admin page (ZenMagick -> Plugin Manager) where plugins can be installed/removed and configured similar to zen-cart modules.
