X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=plugins%2FTwitterBridge%2FREADME;h=4f1f15c377b3eaac7d1df50a82a833f784be2690;hb=06aa05aa48d4108909e4c25e267587f7bc90189f;hp=a386989b7a555f27f830ac67617e5d8ba04dc2ad;hpb=27a49361eb8fd4dc661283214003a71de34201e8;p=quix0rs-gnu-social.git diff --git a/plugins/TwitterBridge/README b/plugins/TwitterBridge/README index a386989b7a..4f1f15c377 100644 --- a/plugins/TwitterBridge/README +++ b/plugins/TwitterBridge/README @@ -1,3 +1,6 @@ +Twitter Bridge Plugin +===================== + This Twitter "bridge" plugin allows you to integrate your StatusNet instance with Twitter. Installing it will allow your users to: @@ -11,13 +14,12 @@ Installation ------------ OAuth 1.0a (http://oauth.net) is used to to access protected resources -on Twitter (as opposed to HTTP Basic Auth)*. To use Twitter bridging -you will need to register your instance of StatusNet as an application -on Twitter (http://twitter.com/apps). During the application -registration process your application will be assigned a "consumer" key -and secret, which the plugin will use to make OAuth requests to Twitter. -You can either pass the consumer key and secret in when you enable the -plugin, or set it using the Twitter administration panel. +on Twitter. To use Twitter bridging you will need to register your +instance of StatusNet as an application on Twitter (http://twitter.com/apps). +During the application registration process your application will be assigned +a "consumer" key and secret, which the plugin will use to make OAuth requests +to Twitter. You can either pass the consumer key and secret in when you +enable the plugin, or set it using the Twitter administration panel. When registering your application with Twitter set the type to "Browser" and your Callback URL to: @@ -39,37 +41,30 @@ To enable the plugin, add the following to your config.php: ) ); -* Note: The plugin will still push notices to Twitter for users who - have previously set up the Twitter bridge using their Twitter name and - password under an older version of StatusNet, but all new Twitter - bridge connections will use OAuth. +or if you want to set the variables from the website's administration panel: -Admin panel ------------ + addPlugin('TwitterBridge'); -As of StatusNet 0.9.0 there is a new administration panel that allows -you to configure Twitter bridge settings within StatusNet itself, -instead of having to specify them manually in your config.php. To enable -the administration panel, you will need to add it to the list of active -administration panels. You can do this via your config.php. E.g.: +After saving your configuration file, please run 'php scripts/upgrade.php' +and also restart the background daemons if they are active on your instance. - $config['admin']['panels'][] = 'twitter'; +Administration panel +-------------------- -And to access it, you'll need to use a user with the "administrator" -role (see: scripts/userrole.php). +To access the administration panel, you'll need to use a user with the +"administrator" role (see: scripts/userrole.php). Sign in with Twitter -------------------- -As of 0.9.0 you StatusNet optionally allows users to register and -authenticate using their Twitter credentials via the "Sign in with -Twitter" pattern described here: +GNU social optionally allows users to register and authenticate using their +Twitter credentials via the "Sign in with Twitter" pattern described here: - http://apiwiki.twitter.com/Sign-in-with-Twitter + https://dev.twitter.com/web/sign-in The option is _on_ by default when you install the plugin, but it can -disabled via the Twitter bridge admin panel, or by adding the following -line to your config.php: +disabled via the Twitter bridge administration panel, or by adding the +following line to your config.php: $config['twitter']['signin'] = false; @@ -119,9 +114,9 @@ set up Twitter bridging. It's not strictly necessary to run this queue handler, and sites that haven't enabled queuing are still able to push notices to Twitter, but -for larger sites and sites that wish to improve performance, this script +for larger sites and sites that wish to improve performance the script allows notices to be sent "offline" via a separate process. StatusNet will automatically use the TwitterQueueHandler if you have -enabled the queuing system. See the "Queues and daemons" section of the -main README file for more information about how to do that. +enabled the queuing subsystem. See the "Queues and daemons" section of +the main README file for more information about how to do that.