]> git.mxchange.org Git - friendica-addons.git/commitdiff
Tobias outlined a rare situation where a site admin may not have an
authorThomas Willingham <founder@kakste.com>
Thu, 5 Apr 2012 19:23:40 +0000 (20:23 +0100)
committerThomas Willingham <founder@kakste.com>
Thu, 5 Apr 2012 19:23:40 +0000 (20:23 +0100)
admin account, and will therefore need to do things in .htconfig.php

So, restore the .htconfig.php method as "If you prefer..."

facebook/README
facebook/README~ [new file with mode: 0755]
impressum/README
impressum/README~ [new file with mode: 0755]
openstreetmap/README
openstreetmap/README~ [new file with mode: 0644]
twitter/README
twitter/README~ [new file with mode: 0755]

index 650ae1e34b3ddcbc74c8b8b673ac0d9fe75ab931..b68ba3da81e0094820adf08a227493bcf74ecc1d 100755 (executable)
@@ -20,6 +20,18 @@ Installing the Friendica/Facebook connector
    c) Click save.
    d) Finally, return to the Facebook settings page, and activate real-time updates.
 
+       i. If you for any reason prefer to use a configuration file instead of the admin panels, 
+           Activate the plugin by including it in .htconfig.php, e.g.
+           
+               $a->config['system']['addon'] = 'plugin1,plugin2,facebook';
+       
+           and set the following values:
+               $a->config['facebook']['appid'] = 'xxxxxxxxxxx';
+               $a->config['facebook']['appsecret'] = 'xxxxxxxxxxxxxxx';
+
+           Replace with the settings Facebook gives you.
+       
+
 3.    To use the Facebook plugin, visit the "connector settings" area of your settings
       page.  Click "Install Facebook Connector".  
 4.    This will ask you to login to Facebook and allow the plugin to do it's stuff.  
diff --git a/facebook/README~ b/facebook/README~
new file mode 100755 (executable)
index 0000000..650ae1e
--- /dev/null
@@ -0,0 +1,40 @@
+Installing the Friendica/Facebook connector
+
+1. Visit https://developers.facebook.com/apps to register an app.
+    a) Click "Create a new app"
+    b) We'd be very happy if you include "Friendica" in the application name
+       to increase name recognition.  
+    c) Edit your app settings on the setup page.  The Friendica icons are present
+       in the images directory and may be uploaded as a Facebook app icon.  Use 
+       images/friendica-16.jpg for the Icon and images/Friendica-128.jpg for the logo.
+    d) In the App Display name enter the name of your app (this should default to the
+       name you chose in part a).
+    e) Enter YourDomain.com in the App Domain field and hit return.
+    f) In "Select how your app connects with Facebook select "Website" and enter the 
+       full URL to your Friendica install including HTTPS and a trailing slash.
+
+2.    Enable the Facebook plugin by clicking on the icon next to it's name on the plugin
+      page of your admin panel.
+   b) return to the Facebook plugin page in your admin panel, and fill in the App-ID
+      and Application Secret settings you got from Facebook.
+   c) Click save.
+   d) Finally, return to the Facebook settings page, and activate real-time updates.
+
+3.    To use the Facebook plugin, visit the "connector settings" area of your settings
+      page.  Click "Install Facebook Connector".  
+4.    This will ask you to login to Facebook and allow the plugin to do it's stuff.  
+      Allow it to do so.
+5.    You're done. To turn it off visit the Plugin Settings page again and
+      'Remove Facebook posting'.
+
+Vidoes and embeds will not be posted if there is no other content. Links 
+and images will be converted to a format suitable for the Facebook API and 
+long posts truncated - with a link to view the full post. 
+
+Facebook contacts will not be able to view private photos, as they are not able to
+authenticate to your site to establish identity. We will address this 
+in a future release.
+
+Info: please make sure that you understand all aspects due to Friendica's 
+default licence which is: MIT License (further info:
+https://github.com/friendica/friendica/blob/master/LICENSE)
index 457729dcc1ba4a4be7350d273412cb74913333bf..bea55db29107697dc58d24cff67e8956111ac6b9 100755 (executable)
@@ -15,4 +15,17 @@ Configuration:
   Simply fill in the fields in the impressium settings page in the plugins area
   of your admin panel.
  
+If you for any reason prefer to use a configuration file instead, you can set the 
+following variables in the .htconfig file
 
+  * $a->config['impressum']['owner']           this is the Name of the Operator
+  * $a->config['impressum']['ownerprofile']    this is an optional Friendica account
+                                               where the above owner name will link to
+  * $a->config['impressum']['email']           a contact email address (optional)
+                                               will be displayed slightly obfuscated
+                                               as name(at)example(dot)com
+
+  * $a->config['impressum']['postal']          should contain a postal address where
+                                               you can be reached at (optional)
+  * $a->config['impressum']['notes']           additional informations that should
+                                               be displayed in the Impressum block
diff --git a/impressum/README~ b/impressum/README~
new file mode 100755 (executable)
index 0000000..457729d
--- /dev/null
@@ -0,0 +1,18 @@
+Impressum Plugin for Friendica
+
+Author: Tobias Diekershoff
+        tobias.diekershoff@gmx.net
+
+License: 3-clause BSD license (same as Friendica)
+
+About
+  This plugin adds an Impressum block to the /friendica page with informations
+  about the page operator/owner and how to contact you in case of any questions.
+
+  In the notes and postal fields you can use HTML tags for formatting.
+
+Configuration:
+  Simply fill in the fields in the impressium settings page in the plugins area
+  of your admin panel.
+
index 5c731fac3c313c080e0956ad5e0f3e9d14ea6a24..beac3a2184ef7534365411f3286795a6755b4457 100644 (file)
@@ -16,6 +16,9 @@ Support the OpenStreetMap community and share the load.
 
 ___ Configuration ___
 
+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 your admin panel.  
 
 You can now add a Tile Server and default zoom level in the plugin settings
@@ -25,3 +28,21 @@ The Time Server URL points to the tile server you want to use. Use the full URL,
 with protocol (http/s) and trailing slash. You can configure the default zoom
 level on the map in the Default Zoom box.  1 will show the whole world and 18 is the highest
 zoom level available.
+
+
+___ Alternative Configuration ___
+
+Open the .htconfig.php file and add "openstreetmap" to the list of activated
+addons.
+
+    $a->config['system']['addon'] = "openstreetmap, ..."
+
+You have to add two configuration variables for the addon:
+
+    $a->config['openstreetmap']['tmsserver'] = 'http://www.openstreetmap.org/';
+    $a->config['openstreetmap']['zoom'] = '18';
+
+The *tmsserver* points to the tile server you want to use. Use the full URL,
+with protocol (http/s) and trailing slash. You can configure the default zoom 
+level on the map with *zoom*. 1 will show the whole world and 18 is the highest 
+zoom level available.
\ No newline at end of file
diff --git a/openstreetmap/README~ b/openstreetmap/README~
new file mode 100644 (file)
index 0000000..5c731fa
--- /dev/null
@@ -0,0 +1,27 @@
+ ____ OpenStreetMap Plugin ____
+by Mike Macgirvin
+   Klaus Weidenbach
+
+This addon allows you to use OpenStreetMap for displaying locations.
+
+___ Requirements ___
+
+To use this plugin you need a tile Server that provides the maps.
+OpenStreetMap data is free for everyone to use. Their tile servers are not.
+Please take a look at their "Tile Usage Policy":
+http://wiki.openstreetmap.org/wiki/Tile_usage_policy
+You can run your own tile server or choose one from their list of public
+tile servers: http://wiki.openstreetmap.org/wiki/TMS
+Support the OpenStreetMap community and share the load.
+
+___ Configuration ___
+
+Activate the plugin from your admin panel.  
+
+You can now add a Tile Server and default zoom level in the plugin settings
+page of your admin panel.
+
+The Time Server URL points to the tile server you want to use. Use the full URL,
+with protocol (http/s) and trailing slash. You can configure the default zoom
+level on the map in the Default Zoom box.  1 will show the whole world and 18 is the highest
+zoom level available.
index ba396d5d8d63913edf9dec8f653eb2032a285bc4..3b8f0e85046ba1bf8a16d7f5d88972677b36363b 100755 (executable)
@@ -48,7 +48,8 @@ ___ Configuration ___
 __ Global Configuration __
 
 If you enabled an administrator account, please use the admin panel to cofigure
-the Twitter relay.
+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 
@@ -58,6 +59,20 @@ When this is done your user can now configure their Twitter connection at
 "Settings -> Plugin 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';
+
+
 __ User Configuration __
 
 When the OAuth consumer informations are correctly placed into the
@@ -73,3 +88,4 @@ on the "Plugin Settings" page displaying two check boxes. One to enable/disable
 the forwarding of *all public* postings to Twitter and one to clear the
 personal configuration from the Twitter credentials.
 
+
diff --git a/twitter/README~ b/twitter/README~
new file mode 100755 (executable)
index 0000000..3b8f0e8
--- /dev/null
@@ -0,0 +1,91 @@
+____ Twitter Plugin ____
+By Tobias Diekershoff
+   tobias.diekershoff(at)gmx.net
+
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!!   This addon is currently under development. If you have any problem     !!
+!!   with it, please contact the Author.                                    !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+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.
+
+There is a similar addon for forwarding public messages to
+"StatusNet":http://status.net [[StatusNet Plugin]].
+
+Online version of this document: http://ur1.ca/35mml
+
+___ Requirements ___
+
+To use this plugin you have to register your Friendica instance as an
+_client application_ for Twitter with _read and write_ access, we do not intend
+to use Twitter for login. The registration can be done at twitter.com/apps
+and you need to have a Twitter account to do so.
+
+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.
+
+___ Where to find ___
+
+In the Friendica git repository /addon/twitter/, 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
+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 cofigure
+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 -> Plugin 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';
+
+
+__ User Configuration __
+
+When the OAuth consumer informations are correctly placed into the
+configuration file and a user visits the "Plugin 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.
+
+If this first step was successful the Twitter configuration will be changed
+on the "Plugin Settings" page displaying two check boxes. One to enable/disable
+the forwarding of *all public* postings to Twitter and one to clear the
+personal configuration from the Twitter credentials.
+
+