Fixed [#2241161] - notice on the hybridauth url to managed file rule action
[project/hybridauth.git] / README.txt
1
2 Welcome to HybridAuth for Drupal
3
4 Installation:
5 -------------
6 Install as any other module: 
7 http://drupal.org/documentation/install/modules-themes
8
9 This module needs third-party library to work with authentication providers - 
10 HybridAuth.
11 Download it at http://hybridauth.sourceforge.net/download.html and unpack into 
12 'sites/all/libraries/hybridauth' directory.
13 HybridAuth library requires php-curl extension.
14
15 If you need additional providers support like Mail.ru - then you need to 
16 download additional providers package and then copy needed additional providers 
17 to the library.
18 For instance, to get Mail.ru provider working you need to copy 
19 'hybridauth-mailru/Providers/Mailru.php' to 
20 'hybridauth/Hybrid/Providers/Mailru.php' and you are good to go.
21 After that you just need to configure your application ID, private and secret 
22 keys at module configuration pages.
23
24 After installation please go through the configuration settings and grant your 
25 users permission to use HybridAuth:
26 - anonymous users - to login using HybridAuth widget
27 - authenticated users - to add more HybridAuth identities to the account
28
29 Dependencies:
30 -------------
31 - Ctools module (http://drupal.org/project/ctools) - it is used for an overlay 
32 and to manage icon pack plugins.
33
34 Icon packs:
35 -----------
36 Yes, you can now easily have your own icon packs as Ctools plugins.
37
38 To make it happen you need to implement hook_ctools_plugin_directory() in your 
39 custom mymodule.module:
40 <code>
41 /**
42  * Implements hook_ctools_plugin_directory().
43  */
44 function mymodule_ctools_plugin_directory($module, $type) {
45   if ($module == 'hybridauth' && $type == 'icon_pack') {
46     return 'plugins/icon_pack';
47   }
48 }
49 </code>
50
51 And then place your icon pack plugins into 'plugins/icon_pack/iconpackname".
52 This directory should contain 2 or 3 files - plugin definition and css/js files:
53 plugins/icon_pack/iconpackname/iconpackname.inc
54 <code>
55 /**
56  * Plugin declaration.
57  */
58 $plugin = array(
59   'title' => t('Mymodule icon pack'),
60   // Specify css file name to include.
61   'css' => 'iconpackname.css',
62   // Specify 'js' key if js file needs to be included.
63   'js' => 'iconpackname.js',
64 );
65 </code>
66
67 Take a look at this module icon packs in "plugins/icon_pack" and you will 
68 figure it out.
69
70 Themes can also define their icon packs - instead of implementing 
71 hook_ctools_plugin_directory() you should just add this line to the theme .info 
72 file:
73 <code>
74 plugins[hybridauth][icon_pack] = plugins/icon_pack
75 </code>
76
77 Recommended additions:
78 ----------------------
79 It is recommended to have the following modules:
80 - Token (http://drupal.org/project/token) - to get a browsable list of 
81 available tokens on administration pages.
82 - Rules (http://drupal.org/project/rules) - to map HybridAuth data to user 
83 profile fields and other great stuff. See this issue for a working example - 
84 http://drupal.org/node/1808456
85 - Real name (http://drupal.org/project/realname) - as it caches display names 
86 and improves performance of your site.
87
88 Troubleshooting:
89 ----------------
90 If you have an issue with any provider not working - please check provider 
91 documentation at http://hybridauth.sourceforge.net/userguide.html - just click 
92 on the provider name and read the instructions related to registering your 
93 application at the provider's site and configuring this application settings.
94
95 If nothing helps - welcome to the issue queue at 
96 http://drupal.org/project/issues/hybridauth.