Update multiple README.md

- Update geonames, impressum, piwik, public_server, testdrive, twitter
This commit is contained in:
Hypolite Petovan 2018-06-28 09:40:20 -04:00
parent cb4f60c257
commit d96370bfad
6 changed files with 57 additions and 51 deletions

15
geonames/README.md Normal file
View file

@ -0,0 +1,15 @@
Geonames Addon
==============
Authors Mike Macgirvin.
Use Geonames service to resolve nearest populated location for given latitude, longitude.
## Installation
Pre-requisite: Register a username at geonames.org and set in config/local.ini.php
[geonames]
username = your_username
Also visit http://geonames.org/manageaccount and enable access to the free web services.

View file

@ -2,23 +2,17 @@ Impressum Addon for Friendica
============================== ==============================
* Author: Tobias Diekershoff * Author: Tobias Diekershoff
* License: [3-clause BSD](http://opensource.org/licenses/BSD-3-Clause) license * License: [3-clause BSD](http://opensource.org/licenses/BSD-3-Clause) license (see the LICENSE file in the addon directory)
(see the LICENSE file in the addon directory)
About About
----- -----
This addon adds an Impressum (contact) block to the /friendica page with This addon adds an Impressum (contact) block to the /friendica page with informations about the page operator/owner and how to contact you in case of any questions.
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 bbcode tags for formatting, like in In the notes and postal fields you can use bbcode tags for formatting, like in normal friendica postings..
normal friendica postings..
Configuration Configuration
------------- -------------
Simply fill in the fields in the impressium settings page in the addons Simply fill in the fields in the impressium settings page in the addons area of your admin panel. For email adresses the "@" symbol will be obfuscated in the source of the page to make in harder for harvesting tools.
area of your admin panel. For email adresses the "@" symbol will be obfuscated
in the source of the page to make in harder for harvesting tools.
Manual Configuration Manual Configuration
-------------------- --------------------

View file

@ -3,8 +3,7 @@ Piwik Addon
by Tobias Diekershoff and Klaus Weidenbach by Tobias Diekershoff and Klaus Weidenbach
This addon allows you to embed the code necessary for the FLOSS webanalytics This addon allows you to embed the code necessary for the FLOSS webanalytics tool Piwik into the Friendica pages.
tool Piwik into the Friendica pages.
Requirements Requirements
------------ ------------
@ -14,18 +13,14 @@ To use this addon you need a [piwik](http://piwik.org/) installation.
Where to find Where to find
------------- -------------
In the Friendica addon git repository `/piwik/piwik.php` and a CSS file for In the Friendica addon git repository `/piwik/piwik.php` and a CSS file for styling the opt-out notice.
styling the opt-out notice.
Configuration Configuration
------------- -------------
The easiest way to configure this addon is by activating the admin panels of The easiest way to configure this addon is by activating the admin panels of your ~friendica server and then enter the needed details on the config page for the addon.
your ~friendica server and then enter the needed details on the config page
for the addon.
If you don't want to use the admin panel, you can configure the addon through If you don't want to use the admin panel, you can configure the addon through the config/local.ini.php file.
the config/local.ini.php file.
Open the config/local.ini.php file and add "piwik" to the list of activated addons. Open the config/local.ini.php file and add "piwik" to the list of activated addons.
@ -43,28 +38,19 @@ You can change 4 more configuration variables for the addon:
Configuration fields Configuration fields
--------------------- ---------------------
* The *baseurl* points to your Piwik installation. Use the absolute path, * The *baseurl* points to your Piwik installation. Use the absolute path, remember trailing slashes but ignore the protocol (http/s) part of the URL.
remember trailing slashes but ignore the protocol (http/s) part of the URL. * Change the *sideid* parameter to whatever ID you want to use for tracking your Friendica installation.
* Change the *sideid* parameter to whatever ID you want to use for tracking your * The *optout* parameter (true|false) defines whether or not a short notice about the utilization of Piwik will be displayed on every page of your Friendica site (at the bottom of the page with some spacing to the
Friendica installation. other content). Part of the note is a link that allows the visitor to set an _opt-out_ cookie which will prevent visits from that user be tracked by piwik.
* The *optout* parameter (true|false) defines whether or * The *async* parameter (true|false) defines whether or not to use asynchronous tracking so pages load (or appear to load) faster.
not a short notice about the utilization of Piwik will be displayed on every
page of your Friendica site (at the bottom of the page with some spacing to the
other content). Part of the note is a link that allows the visitor to set an
_opt-out_ cookie which will prevent visits from that user be tracked by piwik.
* The *async* parameter (true|false) defines whether or not to use asynchronous
tracking so pages load (or appear to load) faster.
Currently the optional notice states the following: Currently the optional notice states the following:
> This website is tracked using the Piwik analytics tool. If you do not want > This website is tracked using the Piwik analytics tool. If you do not want that your visits are logged this way you can set a cookie to prevent Piwik from tracking further visits of the site (opt-out).
> that your visits are logged this way you can set a cookie to prevent Piwik
> from tracking further visits of the site (opt-out).
License License
======= =======
The _Piwik addon_ is licensed under the [3-clause BSD license][3] see the The _Piwik addon_ is licensed under the [3-clause BSD license][3] see the LICENSE file in the addons directory.
LICENSE file in the addons directory.
[3]: http://opensource.org/licenses/BSD-3-Clause [3]: http://opensource.org/licenses/BSD-3-Clause

View file

@ -2,8 +2,7 @@ Public Server
============= =============
Public Server is a Friendica addon which implements automatic account & post expiration so that a site may be used as a public Public Server is a Friendica addon which implements automatic account & post expiration so that a site may be used as a public test bed with reduced data retention.
test bed with reduced data retention.
This is a modified version of the testdrive addon, DO NOT ACTIVATE AT THE SAME TIME AS THE TESTDRIVE ADDON. This is a modified version of the testdrive addon, DO NOT ACTIVATE AT THE SAME TIME AS THE TESTDRIVE ADDON.
@ -26,5 +25,5 @@ The default values are those used by friendica.eu, change these as desired.
The expiration date is updated when the user logs in. The expiration date is updated when the user logs in.
An email warning will be sent out approximately five days before the expiration occurs. Five days later the account is removed completely. An email warning will be sent out approximately five days before the expiration occurs.
Five days later the account is removed completely.

View file

@ -2,21 +2,21 @@ TestDrive
========= =========
Testdrive is a Friendica addon which implements automatic account expiration so that a site may be used as a public Testdrive is a Friendica addon which implements automatic account expiration so that a site may be used as a public test bed.
test bed.
When an account is created on the site, it is given a hard expiration date of When an account is created on the site, it is given a hard expiration date of
[testdrive] [testdrive]
expiredays = 30 expiredays = 30
Set this in your config/local.ini.php file to allow a 30 day test drive period. By default no expiration period is defined Set this in your config/local.ini.php file to allow a 30 day test drive period.
in case the addon is activated accidentally. By default no expiration period is defined in case the addon is activated accidentally.
There is no opportunity to extend an expired account using this addon.
Expiration is final.
Other addons may be created which charge for service and extend the expiration as long as a balance is maintained.
This addon is purely for creating a limited use test site.
There is no opportunity to extend an expired account using this addon. Expiration is final. Other addons may be created An email warning will be sent out approximately five days before the expiration occurs.
which charge for service and extend the expiration as long as a balance is maintained. This addon is purely for creating Once it occurs logins and many system functions are disabled.
a limited use test site. Five days later the account is removed completely.
An email warning will be sent out approximately five days before the expiration occurs. Once it occurs logins and many
system functions are disabled. Five days later the account is removed completely.

View file

@ -3,16 +3,28 @@ Twitter Addon
Main authors Tobias Diekershoff, Michael Vogel and Hypolite Petovan. Main authors Tobias Diekershoff, Michael Vogel and Hypolite Petovan.
This bi-directional connector addon allows each user to crosspost their Friendica public posts to Twitter, import their This bi-directional connector addon allows each user to crosspost their Friendica public posts to Twitter, import their Twitter timeline, interact with tweets from Friendica, and crosspost to Friendica their public tweets.
Twitter timeline, interact with tweets from Friendica, and crosspost to Friendica their public tweets.
## Installation ## Installation
To use this addon you have to register an [application](https://apps.twitter.com/) for your Friendica instance on Twitter. To use this addon you have to register an [application](https://apps.twitter.com/) for your Friendica instance on Twitter.
Register your Friendica site as "Client" application with "Read & Write" access we do not need "Twitter as login".
Please leave the field "Callback URL" empty. Please leave the field "Callback URL" empty.
When you've registered the app you get the OAuth Consumer key and secret pair for your application/site.
After the registration please enter the values for "Consumer Key" and "Consumer Secret" in the [administration](admin/addons/twitter). After the registration please enter the values for "Consumer Key" and "Consumer Secret" in the [administration](admin/addons/twitter).
## Alternative configuration
Add your key pair to your global config/local.ini.php.
[twitter]
consumerkey = your consumer_key here
consumersecret = your consumer_secret here
To activate the addon itself add it to the [system] addon setting.
After this, users can configure their Twitter account settings from "Settings -> Addon Settings".
## License ## License
The _Twitter Connector_ is licensed under the [3-clause BSD license][2] see the LICENSE file in the addons directory. The _Twitter Connector_ is licensed under the [3-clause BSD license][2] see the LICENSE file in the addons directory.