Merge pull request #325 from annando/1511-updated-readmes
Updated addon descriptions and readme files for several addons.
This commit is contained in:
Tobias Diekershoff
commit
7a45d047c1
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* Name: App.net Connector
|
||||
* Description: app.net postings import and export
|
||||
* Description: Bidirectional (posting and reading) connector for app.net.
|
||||
* Version: 0.2
|
||||
* Author: Michael Vogel <https://pirati.ca/profile/heluecht>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -3,3 +3,6 @@ The addon uses the library from [https://github.com/thewebguy/bufferapp-php](htt
|
|||
Please register an app at [http://bufferapp.com/developers/api](http://bufferapp.com/developers/api)
|
||||
|
||||
Please use (your server address)/buffer/connect as Callback URL.
|
||||
|
||||
After the registration please enter the values for "Client ID" and "Client Secret" in the
|
||||
[administration](admin/plugins/buffer).
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@
|
|||
* Version: 1.3
|
||||
* Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
|
||||
* Author: Tobias Hößl <https://github.com/CatoTH/>
|
||||
* Status: Unsupported
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@
|
|||
* Description: Posts to a Google+ page with the help of Hootsuite
|
||||
* Version: 0.1
|
||||
* Author: Michael Vogel <https://pirati.ca/profile/heluecht>
|
||||
* Status: Unsupported
|
||||
*/
|
||||
|
||||
function gpluspost_install() {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* Name: pump.io Post Connector
|
||||
* Description: Post to pump.io
|
||||
* Description: Bidirectional (posting, relaying and reading) connector for pump.io.
|
||||
* Version: 0.2
|
||||
* Author: Michael Vogel <http://pirati.ca/profile/heluecht>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ function rendertime_page_end(&$a, &$o) {
|
|||
|
||||
$duration = microtime(true)-$a->performance["start"];
|
||||
|
||||
if (is_site_admin() AND ($_GET["mode"] != "minimal"))
|
||||
if (is_site_admin() AND ($_GET["mode"] != "minimal") AND !$a->is_mobile AND !$a->is_tablet)
|
||||
$o = $o.'<div class="renderinfo">'.sprintf(t("Performance: Database: %s, Network: %s, Rendering: %s, Parser: %s, I/O: %s, Other: %s, Total: %s"),
|
||||
round($a->performance["database"], 3),
|
||||
round($a->performance["network"], 3),
|
||||
|
|
|
|||
|
|
@ -1,31 +1,30 @@
|
|||
StatusNet Connector
|
||||
GNU Social Connector
|
||||
===================
|
||||
Main authors Tobias Diekershoff and Michael Vogel.
|
||||
|
||||
With this addon to friendica you can give your user the possibility to post
|
||||
their public messages to any StatusNet instance. The messages will be strapped
|
||||
their rich context and shortened to to the character limit of the StatusNet
|
||||
instance in question if necessary. If shortening of the message was performed a
|
||||
link will be added to the notice pointing to the original message on your
|
||||
server.
|
||||
With this addon to friendica you can give your users the possibility to post their *public* messages to GNU Social
|
||||
and to import their timeline of their legacy GNU Social accounts. The messages will be strapped their rich context
|
||||
and shortened if necessary.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
Due to the distributed nature of the StatusNet network, each user who wishes to
|
||||
forward public messages to a StatusNet account has to get the OAuth credentials
|
||||
Due to the distributed nature of the GNU Social network, each user who wishes to
|
||||
forward public messages to a GNU Social account has to get the OAuth credentials
|
||||
for themselves, which makes this addon a little bit more user unfriendly than
|
||||
the Twitter Plugin is. Nothing too geeky though!
|
||||
|
||||
The inclusion of a shorturl for the original posting in cases when the message
|
||||
was longer than the maximal allowed notice length requires it, that you have
|
||||
PHP5+ and curl on your server.
|
||||
|
||||
Where to find
|
||||
-------------
|
||||
|
||||
In the friendica addon git repository /statusnet/, this directory contains all
|
||||
required PHP files (including the [Twitter OAuth library] [1] by Abraham Williams,
|
||||
MIT licensed and the [Slinky library] [2] by Beau Lebens, BSD license), a CSS file
|
||||
for styling of the user configuration and an image to Sign in with StatusNet.
|
||||
for styling of the user configuration and an image to Sign in with GNU Social.
|
||||
|
||||
[1]:https://github.com/abraham/twitteroauth
|
||||
[2]:http://dentedreality.com.au/projects/slinky
|
||||
|
|
@ -33,51 +32,18 @@ for styling of the user configuration and an image to Sign in with StatusNet.
|
|||
Configuration
|
||||
=============
|
||||
|
||||
Global Configuration
|
||||
--------------------
|
||||
|
||||
**If you have configured an admin account, you can configure this plugin from
|
||||
the admin panel.** First activate it from the plugin section of the panel.
|
||||
Afterwards you will have a separate configuration page for the plugin, where
|
||||
you can provide a set of globally available OAuth credentials for different
|
||||
StatusNet pages which will be available for all users of your server.
|
||||
|
||||
If you don't use the admin panel, you can configure the relay using the
|
||||
.htconfig.php file of your friendica installation. To activate the relay add
|
||||
it's name to the list of activated addons.
|
||||
|
||||
$a->config['system']['addon'] = "statusnet, ..."
|
||||
|
||||
If you want to provide preconfigured StatusNet instances for your user add the
|
||||
credentials for them by adding
|
||||
|
||||
$a->config['statusnet']['sites'] = array (
|
||||
array ('sitename' => 'identi.ca', 'apiurl' => 'https://identi.ca/api/',
|
||||
'consumersecret' => 'OAuth Consumer Secret here', 'consumerkey' => 'OAuth
|
||||
Consumer Key here'),
|
||||
array ('sitename' => 'Some other Server', 'apiurl' =>
|
||||
'http://status.example.com/api/', 'consumersecret' => 'OAuth
|
||||
Consumer Secret here', 'consumerkey' => 'OAuth Consumer Key here')
|
||||
);
|
||||
|
||||
to the config file.
|
||||
|
||||
Regardless of providing global OAuth credentials for your users or not, they
|
||||
can always add their own OAuth-Key and -Secret thus enable the relay for any
|
||||
StatusNet instance they may have an account at.
|
||||
|
||||
User Configuration
|
||||
------------------
|
||||
|
||||
When the addon is activated the user has to acquire three things in order to
|
||||
connect to the StatusNet account of choice.
|
||||
connect to the GNU Social account of choice.
|
||||
|
||||
* the base URL for the StatusNet API, for identi.ca this was https://identi.ca/api/
|
||||
* the base URL for the GNU Social API, for identi.ca this was https://identi.ca/api/
|
||||
* OAuth Consumer key & secret
|
||||
|
||||
To get the OAuth Consumer key pair the user has to (a) ask her Friendica admin
|
||||
if a pair already exists or (b) has to register the Friendica server as a
|
||||
client application on the StatusNet server. This can be done from the account
|
||||
client application on the GNU Social server. This can be done from the account
|
||||
settings under "Connect -> Connections -> Register an OAuth client application
|
||||
-> Register a new application".
|
||||
|
||||
|
|
@ -90,58 +56,16 @@ During the registration of the OAuth client remember the following:
|
|||
|
||||
After the required credentials for the application are stored in the
|
||||
configuration you have to actually connect your friendica account with
|
||||
StatusNet. To do so follow the Sign in with StatusNet button, allow the access
|
||||
GNU Social. To do so follow the Sign in with GNU Social button, allow the access
|
||||
and copy the security code into the plugin configuration. Friendica will then
|
||||
try to acquire the final OAuth credentials from the API, if successful the
|
||||
plugin settings will allow you to select to post your public messages to your
|
||||
StatusNet account.
|
||||
|
||||
Mirroring of Public Postings
|
||||
----------------------------
|
||||
|
||||
To avoid endless loops of public postings that are send to StatusNet and then
|
||||
mirrored back into your friendica stream you have to set the _name of the
|
||||
application you registered there_ of your friendica node is using to post to
|
||||
StatusNet in the .htconfig.php file.
|
||||
|
||||
$a->config['statusnet']['application_name'] = "yourname here";
|
||||
|
||||
Connector Options for the User
|
||||
==============================
|
||||
|
||||
* **Allow posting to StatusNet** If you want your _public postings_ being
|
||||
optionally posted to your associated StatusNet account as well, you need to
|
||||
check this box.
|
||||
* **Send public postings to StatusNet by default** if you want to have _all_
|
||||
your public postings being send to your StatusNet account you need to check
|
||||
this button as well. Otherwise you have to enable the relay of your postings
|
||||
in the ACL dialog (click the lock button) before posting an entry.
|
||||
* **Mirror all posts from statusnet that are no replies or repeated messages**
|
||||
if you want your postings from StatusNet also appear in your friendica
|
||||
postings, check this box. Replies to other people postings, repostings and your own
|
||||
postings that were send from friendica wont be mirrored into your friendica
|
||||
stream.
|
||||
* **Shortening method that optimizes the post** by default friendica checks how
|
||||
many characters your StatusNet instance allows you to use for a posting and
|
||||
if a posting is longer then this amount of characters it will shorten the
|
||||
message posted on StatusNet and add a short link back to the original
|
||||
posting. Optionally you can check this box to have the shortening of the
|
||||
message use an optimization algorithm. _TODO add infos how this is
|
||||
optimized_
|
||||
* **Send linked #-tags and @-names to StatusNet** if you want your #-tags and
|
||||
@-mentions linked to the friendica network, check this box. If you want to
|
||||
have StatusNet handle these things for the relayed end of the posting chain,
|
||||
uncheck it.
|
||||
* **Clear OAuth configuration** if you want to remove the currently associated
|
||||
StatusNet account from your friendica account you have to check this box and
|
||||
then hit the submit button. The saved settings will be deleted and you have
|
||||
to reconfigure the StatusNet connector to be able to relay your public
|
||||
postings to a StatusNet account.
|
||||
GNU Social account.
|
||||
|
||||
License
|
||||
=======
|
||||
|
||||
The _StatusNet Connector_ is licensed under the [3-clause BSD license][3] see the
|
||||
The _GNU Social Connector_ is licensed under the [3-clause BSD license][3] see the
|
||||
LICENSE file in the addons directory.
|
||||
|
||||
[3]: http://opensource.org/licenses/BSD-3-Clause
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* Name: GNU Social Connector
|
||||
* Description: Relay public postings to a connected GNU Social account
|
||||
* Description: Bidirectional (posting, relaying and reading) connector for GNU Social.
|
||||
* Version: 1.0.5
|
||||
* Author: Tobias Diekershoff <https://f.diekershoff.de/profile/tobias>
|
||||
* Author: Michael Vogel <https://pirati.ca/profile/heluecht>
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
Register an application at this address:
|
||||
http://www.tumblr.com/oauth/apps
|
||||
|
||||
use (your server name)addon/tumblr/callback.php as callback URL
|
||||
|
||||
Tumblr-OAuth-Library:
|
||||
https://groups.google.com/d/msg/tumblr-api/g6SeIBWvsnE/gnWqT9jFSlEJ
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
Installation
|
||||
------------
|
||||
|
||||
[Register](http://www.tumblr.com/oauth/apps) an application and use (your server name)/addon/tumblr/callback.php as
|
||||
callback URL
|
||||
|
||||
After the registration please enter the values for "Consumer Key" and "Consumer Secret" in the [administration](admin/plugins/tumblr).
|
||||
|
||||
Notice
|
||||
------
|
||||
This connector is using the Tumblr-OAuth-Library:
|
||||
[https://groups.google.com/d/msg/tumblr-api/g6SeIBWvsnE/gnWqT9jFSlEJ](https://groups.google.com/d/msg/tumblr-api/g6SeIBWvsnE/gnWqT9jFSlEJ)
|
||||
|
|
@ -3,34 +3,18 @@ Twitter Plugin
|
|||
|
||||
Main authors Tobias Diekershoff and Michael Vogel.
|
||||
|
||||
With this addon to friendica you can give your user the possibility to post
|
||||
their *public* messages to Twitter. The messages will be strapped their rich
|
||||
context and shortened to 140 characters length if necessary. If shortening of
|
||||
the message was performed a link will be added to the Tweet pointing to the
|
||||
original message on your server.
|
||||
With this addon to friendica you can give your users the possibility to post their *public* messages to Twitter and
|
||||
to import their timeline. The messages will be strapped their rich context and shortened to 140 characters length if
|
||||
necessary.
|
||||
|
||||
The addon can also mirror a users Tweets into the ~friendica wall.
|
||||
|
||||
There is a similar addon for forwarding public messages to
|
||||
[StatusNet](http://status.net).
|
||||
|
||||
Requirements
|
||||
Installation
|
||||
------------
|
||||
|
||||
To use this plugin you have to register an application for your friendica
|
||||
instance on Twitter with
|
||||
* read and write access
|
||||
* don't set a callback URL
|
||||
* we do not intend to use Twitter for login
|
||||
The registration can be done at twitter.com/apps and you need a Twitter
|
||||
account for doing so.
|
||||
To use this plugin you have to register an [application](https://apps.twitter.com/) for your friendica instance on Twitter. Please leave the field "Callback URL" empty.
|
||||
|
||||
After you registered the application you get an OAuth consumer key / secret
|
||||
pair that identifies your app, you will need them for configuration.
|
||||
|
||||
The inclusion of a shorturl for the original posting in cases when the
|
||||
message was longer than 140 characters requires it, that you have *PHP5+* and
|
||||
*curl* on your server.
|
||||
After the registration please enter the values for "Consumer Key" and "Consumer Secret" in the [administration](admin/plugins/twitter).
|
||||
|
||||
Where to find
|
||||
-------------
|
||||
|
|
@ -44,91 +28,6 @@ Twitter_.
|
|||
[1]: https://github.com/abraham/twitteroauth
|
||||
[2]: http://dentedreality.com.au/projects/slinky/
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Global Configuration
|
||||
--------------------
|
||||
|
||||
If you enabled an administrator account, please use the admin panel to configure
|
||||
the Twitter relay. If you for any reason prefer to use a configuration file instead
|
||||
of the admin panels, please refer to the Alternative Configuration below.
|
||||
|
||||
Activate the plugin from the plugins section of your admin panel. When you have
|
||||
done so, add your consumer key and consumer secret in the settings section of the
|
||||
plugin page.
|
||||
|
||||
When this is done your user can now configure their Twitter connection at
|
||||
"Settings -> Connector Settings" and enable the forwarding of their *public*
|
||||
messages to Twitter.
|
||||
|
||||
Alternative Configuration
|
||||
-------------------------
|
||||
|
||||
To activate this addon add twitter to the list of active addons in your
|
||||
.htconfig.php file
|
||||
|
||||
$a->config['system']['addon'] = "twitter, ..."
|
||||
|
||||
Afterwards you need to add your OAuth consumer key / secret pair to it by
|
||||
adding the following two lines
|
||||
|
||||
$a->config['twitter']['consumerkey'] = 'your consumer KEY here';
|
||||
$a->config['twitter']['consumersecret'] = 'your consumer SECRET here';
|
||||
|
||||
|
||||
Mirroring of Public Postings
|
||||
----------------------------
|
||||
|
||||
To avoid endless loops of public postings that are send to Twitter and then
|
||||
mirrored back into your friendica stream you have to set the _name of the
|
||||
application you registered there_ of your friendica node is using to post to
|
||||
Twitter in the .htconfig.php file.
|
||||
|
||||
$a->config['twitter']['application_name'] = "yourname here";
|
||||
|
||||
Connector Options for the User
|
||||
==============================
|
||||
|
||||
When the OAuth consumer informations are correctly placed into the
|
||||
configuration file and a user visits the "Connector Settings" page they can now
|
||||
connect to Twitter. To do so one has to follow the _Sign in with Twitter_
|
||||
button (the page will be opened in a new browser window/tab) and get a PIN from
|
||||
Twitter. This PIN has to be entered on the settings page. After submitting the
|
||||
PIN the plugin will get OAuth credentials identifying this user from the
|
||||
friendica account.
|
||||
|
||||
After this step was successful the user now has the following config options.
|
||||
|
||||
* **Allow posting to StatusNet** If you want your _public postings_ being
|
||||
optionally posted to your associated Twitter account as well, you need to
|
||||
check this box.
|
||||
* **Send public postings to StatusNet by default** if you want to have _all_
|
||||
your public postings being send to your Twitter account you need to check
|
||||
this button as well. Otherwise you have to enable the relay of your postings
|
||||
in the ACL dialog (click the lock button) before posting an entry.
|
||||
* **Mirror all posts from statusnet that are no replies or repeated messages**
|
||||
if you want your postings from Twitter also appear in your friendica
|
||||
postings, check this box. Replies to other people postings, repostings and your own
|
||||
postings that were send from friendica wont be mirrored into your friendica
|
||||
stream.
|
||||
* **Shortening method that optimizes the post** by default friendica checks how
|
||||
many characters your Twitter instance allows you to use for a posting and
|
||||
if a posting is longer then this amount of characters it will shorten the
|
||||
message posted on Twitter and add a short link back to the original
|
||||
posting. Optionally you can check this box to have the shortening of the
|
||||
message use an optimization algorithm. _TODO add infos how this is
|
||||
optimized_
|
||||
* **Send linked #-tags and @-names to StatusNet** if you want your #-tags and
|
||||
@-mentions linked to the friendica network, check this box. If you want to
|
||||
have Twitter handle these things for the relayed end of the posting chain,
|
||||
uncheck it.
|
||||
* **Clear OAuth configuration** if you want to remove the currently associated
|
||||
Twitter account from your friendica account you have to check this box and
|
||||
then hit the submit button. The saved settings will be deleted and you have
|
||||
to reconfigure the Twitter connector to be able to relay your public
|
||||
postings to a Twitter account.
|
||||
|
||||
License
|
||||
=======
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* Name: Twitter Connector
|
||||
* Description: Relay public postings to a connected Twitter account
|
||||
* Description: Bidirectional (posting, relaying and reading) connector for Twitter.
|
||||
* Version: 1.0.4
|
||||
* Author: Tobias Diekershoff <https://f.diekershoff.de/profile/tobias>
|
||||
* Author: Michael Vogel <https://pirati.ca/profile/heluecht>
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user