1. Before Installation
Below you can find installation instructions for all versions from 1.1.3 up to 1.3. Please keep in mind that this module
WILL NOT work with Magento versions older than 1.1. Also, versions prior to 1.1.3 might cause problems as they were not tested. If you have one of those, you can contact us for assistance (check the details below).
2. Updating Magento
First, you need to apply a few changes to your source code. This is due to some minor bugs in Magento, all of which have been already reported and hopefully will be fixed in the upcoming versions. If you have access to command shell on your server, the best way to do it is by using patch command – otherwise you will have to upload changed files manually using FTP client (see section 2.2).
2.1. Update using patch file
For Magento versions 1.1.3 and 1.1.4 download file
telesign-1.1.3.patch
and for versions 1.1.5 and above (including 1.1.8 and 1.3)
telesign-1.1.5.patch.
Enter your Magento directory, copy the patch there and type from your shell:
patch -p1 -d ./ < telesign-[enter version here].patch
It is a good idea to keep the file on your machine, as whenever you wish to go back to the original version (for example when upgrading your Magento installation) you can use the command below:
patch -R -p1 -d ./ < telesign-[enter version here].patch
This will revert any changes done to original files.
2.2. Update using FTP Client
In case your ISP does not provide you with shell access or you are not familiar with it, you can also update your Magento by uploading changed files manually. First, download the package specific for your version:
Extract the archive on your local machine – inside you should see one directory called
app. Upload it directly to your Magento directory (there should be a catalog with that name already). Two files will be overridden – make sure you agree in case a confirmation window appears.
3. Installing module
It is recommended to install the module using
Magento Connect platform. Direct link to our module is
here.
Due to extensive changes our module required, we have decided to release source package for you to upload it manually using your favorite FTP Client. First, make sure to download the package below:
The following packages are a bit out of date. Please download the newest module using
Magento Connect.
After extracting you should see three directories inside:
app,
lib,
skin. Although the same catalogs exist in your Magento directory, no files will be overridden so you can upload it without worrying about backup.
4. Configuration Options
Now, log in into Administrator Control Panel as usual, then go to System -> Configuration tab. In the general section you should see TeleSign box with several options explained below.
- Enabled – determines whether the module is enabled or not (will verify telephone upon registration and changing addresses)
- Two Phase Admin Login - "Yes" will force TeleSign verification during logging into Administrator Control Panel
- Two Phase User Login - "Yes" will force TeleSign verification during normal user login process
- Verification Methods - Here you can select which contact methods users might choose from (Note: the administrator is always verified using call method)
- Pin Length – the number of digits in PIN that the user receives
- Customer & Authorization ID - access credentials; those can be obtained from
www.telesign.com
5. Setting up Administrators
If you have chosen to enable Two Phase Admin Login, you will have to set up administrator telephone numbers. To do so, you need to go to System -> Permissions -> Users tab in the Administrator Panel. There you should see two additional fields when editing a user - Phone and Prefix. Make sure to enter a valid country prefix (digits only, without the plus sign) and phone number (digits only, without spaces or dashes) – otherwise your account might end up being inaccessible.
If you do not have access to user's permissions, you can still change the phone number for your own account in System -> My Account tab.
Note: If an administrator doesn't have his phone number set, he will be able to log in without verification.
6. Translations
If you wish to translate the module to your own language, you can do it by editing
app/code/locale/en_US/Dnc_TeleSign.csv just as any other Magento's language file.
7. Customizing templates
In case you are using your own template different from the default Magento one, you will have to adjust template files for it. In the module package, go to
app/design/frontend/default/default/template/telesign/ dir. There is also one template file in
adminhtml directory, but that one is shown to administrators only.
8. Problems
If you ever end up with your Administrator account being inaccessible (which might happen when you save a wrong telephone number or when your TeleSign credentials become invalid), you will have to disable the module manually by running the following SQL query:
UPDATE `core_config_data` SET `value` = '0' WHERE `path` = 'general/telesign/two_phase_admin';
Note: you might need to adjust table name (core_config_data) with table prefix you used during installation process.
9. Help
If you encounter any problems during installation or have any questions regarding TeleSign module, you can contact me at:
tomw@telesign.com
