]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/BitlyUrl/README
Merge remote-tracking branch 'upstream/master' into social-master
[quix0rs-gnu-social.git] / plugins / BitlyUrl / README
1 bit.ly URL shortening requires the login name and API key for a bit.ly account.
2 Register for an account or set up your API key here:
3
4   http://bit.ly/a/your_api_key
5
6 Administrators can configure a login and API key to use through the admin panels
7 on the site; these credentials will then be used for all users.
8
9 (In the future, options will be added for individual users to override the keys
10 with their own login for URLs they post.)
11
12 If the login and API key are left empty in the admin panel, then bit.ly will be
13 disabled and hidden from the list of available URL shorteners unless a global
14 default was provided in the plugin configuration.
15
16
17 To enable bit.ly with no default credentials, simply slip into your config.php:
18
19   addPlugin('BitlyUrl');
20
21 To provide default credentials, add them as parameters:
22
23   addPlugin('BitlyUrl', array(
24       'login' => 'myname',
25       'apiKey' => '############################'
26   ));
27
28 These settings will not be individually exposed to the admin panels, but the
29 panel will indicate whether or not the global default settings are available;
30 this makes it suitable as a global default for multi-site hosting, where admins
31 on individual sites can change to use their own settings.
32
33
34 If you're using a bit.ly pro account with a custom domain etc, it should all
35 "just work" as long as you use the correct login name and API key for your
36 account.
37