diff --git a/README.md b/README.md index 94e5494..7f71f80 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -©2011-2014 BITPAY, INC. +©2011-2014 BITPAY, INC. Permission is hereby granted to any person obtaining a copy of this software and associated documentation for use and/or modification in association with @@ -12,25 +12,63 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -Bitcoin payment module using the bitpay.com service. +Bitcoin payment module for Magento Community Edition using the bitpay.com service. + Installation ------------ -Copy these files into your Magento directory. +1. Unzip this archive and copy the files to the location of your Magento CE installation on your web server. For Ubuntu-based servers, the default location for website files is the /var/www folder. Your web hosting provider may use a different location for storing your website files so check with them if the /var/www folder does not exist or your Magento files are in an otherwise unknown location. + +Many web hosting accounts have a graphical, web-based control panel for your server. This is the easiest method for copying the BitPay plugin files to your Magenento CE directory. If your provider has one of these graphical control panels, log into your hosting account and move the files using that tool. However, if that is not an option and you can only access your web server using a shell account via SSH, open a new connection and issue these commands: + +
+bitpay@bitpay:~$ unzip magento-plugin-master.zip +bitpay@bitpay:~$ cd magento-plugin-master +bitpay@bitpay:~$ cp -R ./* /location/of/your/magento/installation/ ++ +Note: You may need to have superuser privileges to copy files to /var/www on Ubuntu-based servers. If you receive “Permission denied” errors when using the cp command above, use sudo before the cp command and specify the superuser password when asked: + +
+bitpay@bitpay:~$ sudo cp -R ./* /location/of/your/magento/installation/ +[sudo] password for (username): ++ +2. Verify the files have been copied correctly by checking your Magento CE installation folder for one or more of them. You can choose to check for any of the files present in the BitPay plugin archive. The file I’m looking for in this example should be in the /var/www/magento/app/code/community/Bitpay/Bitcoins/Model directory along with the Ipn.php file on my Ubuntu server: + +
+bitpay@bitpay:~$ ls -l /var/www/magento/app/code/community/Bitpay/Bitcoins/Model/ +total 24 +-rw-r--r-- 1 root root 3097 Mar 25 14:06 Ipn.php +-rw-r--r-- 1 root root 10786 Mar 25 14:06 PaymentMethod.php +drwxr-xr-x 3 root root 4096 Mar 25 13:54 Resource +drwxr-xr-x 2 root root 4096 Mar 25 13:54 Source ++ +If the files were copied correctly and are present in the directory, you should see the files listed when you issue the ls command. If you do not see any files listed, try the cp command again to retry the copying procedure. However, if you still do not see any files listed or you receive an error copying the files, contact your web hosting support for assistance. + + +Magento CE 1.8.x Installation Tips +---------------------------------- +In some instances for merchants using Magento CE version 1.8.x, the BitPay Bitcoins payment plugin might not appear in the Payment Methods configuration section even though all plugin files have been correctly installed. To resolve this issue, log into your admin control panel and choose the System -> Cache Management configuration screen. Click the check box next to the Configuration cache type and choose the Disable action from the Actions drop-down list box. Click the Submit button to disable this cache. + +Next, click both the Flush Magento Cache and Flush Cache Storage buttons (Clicked "Ok" when the pop-up box is displayed) to remove the stale configuration cache files. + +Finally, log completely out of the administrative control panel and then log back in. The Bitcoins option is now correctly displaying under Payment Methods in the configuration screen. The BitPay plugin parameters are exactly the same on Magento CE 1.8.x as on older Magento CE releases. + Configuration ------------- -NOTE: SSL is required for use of the BitPay plugin for Magento +NOTE: SSL is required for use of the BitPay plugin for Magento CE. 1. Create an API key at bitpay.com by clicking My Account > API Access Keys > Add New API Key. 2. In Admin panel under "System > Configuration > Sales > Payment Methods > Bitcoins": -