The Clerk.io Toolbox Script has been developed to make it easy to install the Clerk.io extension in your Magento webshop, without using Magento Connect.
The Toolbox Script will be run directly from a terminal. We suggest these:
- Apple: iTerm, you will have to download it from the Internet;
- Windows: Command Prompt, it is already installed in your computer.
The script also creates a backup of the Magento folder so it can be restored if something goes wrong.
What do I need?
In order to install it, you need SSH or SFTP access to your webshop, including your Username, Password and Domain.
1. Navigating to the Magento folder
1.1 Start by logging in to your Magento server through a terminal, by using your Username and Domain like this:
1.2 You will be prompted to type in the password for your User (the terminal will not give you any feedback while typing the password, but its registering it anyway).
1.3 Navigate to the root folder of Magento. Often you can do this by writing:
This will give you a list of folders, to help you find the right one:
In the list of folders look for the right folder, in this case it would be magento1. At this point what you need to do is to get in the folder, you can do so by writing:
NAME_FOLDER is substituted by the real name of the folder.
2. Installing extension
2.1. When you are in your Root Folder, you need to download the Toolbox Script with this line:
sudo wget https://raw.githubusercontent.com/clerkio/clerk-magento/master/clerk_toolbox_magento.sh
2.2. Afterwards, type this line to see a list of the available options within the Toolbox:
2.3. Since you want to install the extension, you will use
-i along with the latest
version number of the extension. Type this line where x.x.x is the version you want to install:
sudo sh clerk_toolbox_magento.sh -i x.x.x
2.4. You will now be prompted to type in your password. After doing this, the script will backup your Magento1 folder and start installing the extension:
2.5. Done! Now the extension is installed, and you can configure it in your Magento1 backend.
The Toolbox also lets you uninstall the extension. You can do it with this line:
sudo sh clerk_toolbox_magento.sh -u
In some cases, if files have been corrupted or are missing, you can do a force uninstall like this:
sudo sh clerk_toolbox_magento.sh -u --force
In case something goes wrong in your webshop, you can always restore it through the backup that is made when installing the extension.
Use this line to do that:
sudo sh clerk_toolbox_magento.sh -r
When installing the extension, the script will always create a backup first, but you can also create backup separately with this line:
sudo sh clerk_toolbox_magento.sh -b