A number of people have been having some difficulty installing my extension manually, and so they should, they are not designed to be installed manually but rather through Magento Connect. This will be a short and sweet guide to installing my Magento extension through FTP or SSH. This could probably be applied to installing any extension manually, so if you just need help knowing where to put extension files, read on.
Those that follow this blog (all 3 of you) will know that I’ve been unable to upload my latest release to Magento Connect and have been offering it for download through my site directly in the meantime. Quite a number of you have been able to install it without a hitch, but the confusing nature of the extension layout is blocking some people from being able to use the extension. Let’s hope this guide helps.
Preparation
The first thing to do is download the extension, you can get it over at my blog post about the new email logging features. For the purposes of this little how to guide, let’s assume you put the file in your home directory.
Installing a Magento Extension by SSH
On a Unix or Mac computer, start your Terminal of choice, on windows I think you’ll have to use WinSCP (someone want to correct me on that?) and navigate to your home directory, where you diligently saved the extension release file.
Run this command to upload the file to your server home directory (in this example I’m using version 1.1.1, adjust accordingly):
|
scp Aschroder_SMTPPro-1.1.1.tgz username@server:
|
Once the file is on the server then jump on there yourself to install the extension:
|
ssh username@server
|
Now unarchive the extension, I suggest doing this in a temporary directory, to keep everything tidy
|
mkdir ext-temp
mv Aschroder_SMTPPro-1.1.1.tgz ext-temp
cd ext-temp
tar xzf Aschroder_SMTPPro-1.1.1.tgz
|
Now is a good time to check your handy work:
|
aschroder:ext-temp ashley$ ls
Aschroder_SMTPPro-1.1.1 package.xml
Aschroder_SMTPPro-1.1.1.tgz
aschroder:ext-temp ashley$ ls Aschroder_SMTPPro-1.1.1
Aschroder adminhtml modules
|
Looks good eh? Ok now to put those folders where they are supposed to be. For this part I’m going to assume you have a public_html directory in your home directory, and that is the root of your Magento installation. If that is crazy talk to you, an SSH install may not be the best option.
|
mv Aschroder_SMTPPro-1.1.1/Aschroder/ ~/public_html/app/code/community/
mv Aschroder_SMTPPro-1.1.1/modules/Aschroder_SMTPPro.xml ~/public_html/app/etc/modules/This could debate-ably be put in base, not default as of Magento 1.4 - I'm open to opinion on that.
PS: Lines that start with a hash symbol are comments, you just read them
mv Aschroder_SMTPPro-1.1.1/adminhtml/default/default/template/smtppro ~/public_html/app/design/adminhtml/default/default/template/
|
So that puts all the files where they need to be, now you just have to clear your Magento cache and you’re done. You made it.
If you are OCD on files hanging around your server, you’ll want to get rid of the temporary files once everything is working:
|
cd ..
rm -r ext-temp
|
Installing a Magento Extension by FTP
The FTP route is much more graphical, so I’ll try to draw this as a picture using Mac finder, hopefully that will make it clear. You’ll want to do this using your favorite FTP client.
Extract the package, possibly in a temporary directory:
These are the files you’ll see inside the Aschroder_SMTPPro-1.1.1 directory:
Your target Magento install should look like this:
Put the Aschroder directory into the app/code/community:
Put the modules/Aschroder_SMTPPro.xml file into app/etc/modules/:
Put the smtppro template folder into the default adminhtml template folder:
And then you should be done. Refresh your Magento cache and you’ll be complete. Happy emailing. Let me know how you get on.