GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

Add plugin READMEs

Browse Source
This commit is contained in:
Chimo 2016-01-22 16:01:24 +00:00
parent 2c5cba28b6
commit a614205663
87 changed files with 1468 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
plugins/ActivitySpam/README Executable file
View File

@ -0,0 +1,23 @@
The ActivitySpam plugin is a spam filter for GNU social.
It needs to connect to a activityspam server.
You can run one yourself: https://github.com/e14n/activityspam
Or use a public instance ( ex: https://spamicity.info/ )
Installation
============
add "addPlugin('ActivitySpam');"
to the bottom of your config.php
Settings
========
server: URL to the activityspam server
consumerkey: The "key" provided by the activityspam server after you've registered and configured an account.
secret: The "secret" provided by the activityspam server after you've registered and configured an account
Example
=======
$config['activityspam']['server'] = 'https://spamicity.info/';
$config['activityspam']['consumerkey'] = 'CONSUMER_KEY';
$config['activityspam']['secret'] = 'SECRET';
addPlugin('ActivitySpam');

14
plugins/AnonymousFave/README Executable file
View File

@ -0,0 +1,14 @@
The Anonymous Fave plugin allows anonymous (not logged in) users to favorite notices
Installation
============
add "addPlugin('AnonymousFave');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('AnonymousFave');

11
plugins/AntiBrute/README Executable file
View File

@ -0,0 +1,11 @@
The AntiBrute plugin implements a time delay between successive failed login
attempts to slow down brute force attacks ( https://en.wikipedia.org/wiki/Brute-force_attack#Countermeasures ).
Installation
============
This plugin is enabled by default
Settings
========
none

18
plugins/ApiLogger/README Executable file
View File

@ -0,0 +1,18 @@
The ApiLogger plugin allows random sampling of API requests.
Installation
============
add "addPlugin('ApiLogger');"
to the bottom of your config.php
Settings
========
frequency: How often to sample (number between 0.0 and 1.0 representing
percentage -- e.g.: 0.1 will check about 10% of hits). Default 1.0
Example
=======
addPlugin('ApiLogger', array(
'frequency' => 1.0
));

14
plugins/Awesomeness/README Executable file
View File

@ -0,0 +1,14 @@
Fun sample plugin: tweaks input data and adds a 'Cornify' ( http://www.cornify.com ) widget to sidebar.
Installation
============
add "addPlugin('Awesomeness');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('Awesomeness');

17
plugins/Blacklist/README Executable file
View File

@ -0,0 +1,17 @@
Plugin to prevent use of nicknames or URLs on a blacklist
Installation
============
add "addPlugin('Blacklist');"
to the bottom of your config.php
Settings
========
nicknames: Array of nicknames to blacklist
urls: Array of URLs to blacklist
Example
=======
$config['blacklist']['nicknames'] = array('bad_nickname', 'worse_nickname');
$config['blacklist']['urls'] = array('http://example.org', 'http://example.net');
addPlugin('Blacklist');

14
plugins/BlankAd/README Executable file
View File

@ -0,0 +1,14 @@
Plugin for testing ad layout
This plugin uses the UAPPlugin framework to output ad content. However,
its ad content is just images with one red pixel stretched to the
right size. It's mostly useful for debugging theme layout.
To use this plugin, set the parameter for the ad size you want to use
to true (or anything non-null).
Example
=======
To make a leaderboard:
addPlugin('BlankAd', array('leaderboard' => true));

22
plugins/BlogspamNet/README Executable file
View File

@ -0,0 +1,22 @@
Plugin to check submitted notices with blogspam.net
When new notices are saved, we check their text with blogspam.net (or
a compatible service).
Blogspam.net is supposed to catch blog comment spam. Some of its tests
(min/max size, bayesian match) gave a lot of false positives so those
tests are turned off by default.
Installation
============
add "addPlugin('BlogspamNet');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('BlogspamNet');

23
plugins/CacheLog/README Executable file
View File

@ -0,0 +1,23 @@
Log cache access
Adds "Cache MISS, Cache HIT, set cache value, delete cache value" etc.
information to the log file.
Note: entries are logged at the LOG_INFO level.
Installation
============
add "addPlugin('CacheLog');"
to the bottom of your config.php
Settings
========
none
Example
=======
Note that since most caching plugins return false for StartCache*
methods, you should add this plugin before them, i.e.
addPlugin('CacheLog');
addPlugin('XCache');

4
plugins/ClientSideShorten/README
View File

@ -3,5 +3,5 @@ shorten URLs as they entered, and before the notice is submitted.
Installation
============
Add "addPlugin('ClientSideShorten');" to the bottom of your config.php
That's it!
This plugin is enabled by default

15
plugins/ConversationTree/README Executable file
View File

@ -0,0 +1,15 @@
The ConversationTree plugin displays conversation replies in a hierarchical
manner like StatusNet pre-v1.0 used to.
Installation
============
add "addPlugin('ConversationTree');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('ConversationTree');

12
plugins/Cronish/README Executable file
View File

@ -0,0 +1,12 @@
The Cronish plugin executes events on a near-minutely/hour/day/week basis.
Intervals are approximate and will vary depending on how busy
the instance is.
Installation
============
This plugin is enabled by default
Settings
========
none

17
plugins/Diaspora/README Executable file
View File

@ -0,0 +1,17 @@
The Diaspora plugin allows GNU social users to subscribe to Diaspora feeds
Note: The feeds are read-only at the moment. That is, replying to an entry
coming from Diaspora will not propagate to Diaspora.
Installation
============
add "addPlugin('Diaspora');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('Diaspora');

10
plugins/DirectMessage/README Executable file
View File

@ -0,0 +1,10 @@
The DirectMessage plugin allows users to send Direct Message to other local users
Installation
============
This plugin is enabled by default
Settings
========
none

15
plugins/DirectionDetector/README Executable file
View File

@ -0,0 +1,15 @@
The DirectionDetector plugin detects notices with RTL content and displays them
in the correct direction.
Installation
============
add "addPlugin('DirectionDetector');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('DirectionDetector');

15
plugins/Directory/README Executable file
View File

@ -0,0 +1,15 @@
The Directory plugin adds a user directory (list)
Installation
============
This plugin is enabled by default except on single-user instances, in which
case, it can be enabled by adding "addPlugin('Directory');" to the bottom of
your config.php
Settings
========
none
Example
=======
addPlugin('Directory');

17
plugins/DiskCache/README Executable file
View File

@ -0,0 +1,17 @@
The DiskCache plugin implements cache interface with disk files.
Installation
============
add "addPlugin('DiskCache');"
to the bottom of your config.php
Settings
========
root: Directory where to save cache data. Default /tmp
Example
=======
addPlugin('DiskCache', array(
'root' => '/tmp'
));

24
plugins/DomainStatusNetwork/README Executable file
View File

@ -0,0 +1,24 @@
The DomainStatusNetwork plugin adds tools to map one status_network to one
email domain in a multi-site installation.
Relates to "status_network":
* /scripts/setup.cfg.sample
* /scripts/setup_status_network.sh
* /scripts/settag.php
* /scripts/delete_status_network.sh
* /scripts/move_status_network.sh
Installation
============
add "addPlugin('DomainStatusNetwork');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('DomainStatusNetwork');

16
plugins/DomainWhitelist/README Executable file
View File

@ -0,0 +1,16 @@
The DomainWhitelist plugin restricts the email addresses in a domain to a
select whitelist.
Installation
============
add "addPlugin('DomainWhitelist');"
to the bottom of your config.php
Settings
========
whitelist: An array of whitelisted domains
Example
=======
$config['email']['whitelist'] = array('example.org', 'example.net');
addPlugin('DomainWhitelist');

7
plugins/EmailAuthentication/README
View File

@ -5,4 +5,9 @@ nickname and the provided password is checked.
Installation
============
add "addPlugin('emailAuthentication');" to the bottom of your config.php.
This plugin is enabled by default
Settings
========
none

25
plugins/EmailRegistration/README Executable file
View File

@ -0,0 +1,25 @@
The EmailRegistration plugin allows user registration with just an email
address.
When users register, the part before '@' in their email address will become
their nickname/username (normalized). In case of collisions, a auto-increment
number will be added to the username.
For example, if someone registers with "user@example.org", their username
will be "user". If someone else registers with "user@example.net", their
username will be user1, and so on.
Installation
============
add "addPlugin('EmailRegistration');"
to the bottom of your config.php
Note: This plugin is enabled by default on private instances.
Settings
========
none
Example
=======
addPlugin('EmailRegistration');

21
plugins/EmailReminder/README Executable file
View File

@ -0,0 +1,21 @@
The EmailReminder plugin sends email reminders about various things
It will send reminder emails to email addresses that have been invited
but haven't registered yet.
It will also send reminders to email addresses that have registered but
haven't verified their email address yet.
Installation
============
add "addPlugin('EmailReminder');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('EmailReminder');

22
plugins/EmailSummary/README Executable file
View File

@ -0,0 +1,22 @@
The EmailSummary plugin sends an email summary of the inbox to users in the
network.
After enabling the plugin, users will have an option to enable/disable the
feature in their "Email Settings" section.
You can run ./script/sendemailsummary.php to send emails (options are
documented in the file). You can run this script automatically via your OS's
cron mechanism to send emails regularly.
Installation
============
add "addPlugin('EmailSummary');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('EmailSummary');

10
plugins/Event/README Normal file
View File

@ -0,0 +1,10 @@
The Event plugin adds event invitations and RSVPs types of notices.
Installation
============
This plugin is enabled by default
Settings
========
none

23
plugins/ExtendedProfile/README Normal file
View File

@ -0,0 +1,23 @@
The ExtendedProfile plugin adds additional profile fields such as:
* Phone
* IM
* Website
* Work experience
* Education
Installation
============
add "addPlugin('ExtendedProfile');"
to the bottom of your config.php
Note: This plugin is enabled by default on private instances.
Settings
========
none
Example
=======
addPlugin('ExtendedProfile');

11
plugins/Favorite/README Normal file
View File

@ -0,0 +1,11 @@
The Favorite plugin adds the ability to mark a notice as a "favorite"
(i.e. "like").
Installation
============
This plugin is enabled by default
Settings
========
none

16
plugins/FeedPoller/README Normal file
View File

@ -0,0 +1,16 @@
The FeedPoller plugin allows users to subscribe to non-PuSH-enabled feeds
by regularly polling the source for new content.
Installation
============
add "addPlugin('FeedPoller');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('FeedPoller');

16
plugins/FollowEveryone/README Normal file
View File

@ -0,0 +1,16 @@
The FollowEveryone plugin makes it so that when a new user registers, all
existing users follow them automatically.
Installation
============
add "addPlugin('FollowEveryone');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('FollowEveryone');

16
plugins/ForceGroup/README Normal file
View File

@ -0,0 +1,16 @@
The ForceGroup plugin allows forced group memberships and forces all notices
to appear in groups that users were forced in.
Installation
============
add "addPlugin('ForceGroup');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('ForceGroup');

0
plugins/GNUsocialPhoto/README Normal file
View File

0
plugins/GNUsocialPhotos/README Normal file
View File

0
plugins/GNUsocialVideo/README Normal file
View File

19
plugins/GeoURL/README Normal file
View File

@ -0,0 +1,19 @@
The GeoURL plugin add extra <meta> headers for certain pages that geourl.org
understands and pings geourl.org when those pages are created.
Note: The third-party service that this plugin depends on (geourl.org) seems to
be dead.
Installation
============
add "addPlugin('GeoURL');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('GeoURL');

19
plugins/Geonames/README Normal file
View File

@ -0,0 +1,19 @@
The Geonames plugin uses geonames.org to get human-readable names for locations
based on user-provided lat/long pairs.
The human-readable names appear after notices that have a lat/long location
attached to them.
Installation
============
add "addPlugin('Geonames');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('Geonames');

15
plugins/GroupFavorited/README Normal file
View File

@ -0,0 +1,15 @@
The GroupFavorited plugin adds a menu item for popular notices in groups.
Installation
============
add "addPlugin('GroupFavorited');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('GroupFavorited');

15
plugins/GroupPrivateMessage/README Normal file
View File

@ -0,0 +1,15 @@
The GroupPrivateMessage plugin allows users to send private messages to a group.
Installation
============
add "addPlugin('GroupPrivateMessage');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('GroupPrivateMessage');

21
plugins/ImageMagick/README Normal file
View File

@ -0,0 +1,21 @@
The ImageMagick plugin handles more kinds of image formats for thumbnails,
thanks to ImageMagick.
Note: This plugin depends on php5-imagick
Installation
============
add "addPlugin('ImageMagick');"
to the bottom of your config.php
Settings
========
animated: Whether to resize animated GIFs.
Note: We are not infinitely fast, so resizing animated GIFs is _not_ recommended.
Example
=======
$config['thumbnail']['animated'] = true;
addPlugin('ImageMagick');

23
plugins/InProcessCache/README Normal file
View File

@ -0,0 +1,23 @@
The InProcessCache plugin adds an extra level of in-process caching to any
regular cache system like APC, XCache, or Memcache.
Installation
============
add "addPlugin('InProcessCache');"
to the bottom of your config.php
Settings
========
stats: Whether to dump statistics (cache size, etc) in the log file.
Note: entries are logged at the LOG_INFO level.
Example
=======
Note: since most caching plugins return false for StartCache* methods, you
should add this plugin before them, i.e.
$config['inprocess']['stats'] = true;
addPlugin('InProcessCache');
addPlugin('XCache');

14
plugins/LRDD/README Normal file
View File

@ -0,0 +1,14 @@
The LRDD plugin implements Link-based Resource Descriptor Discovery
based on RFC6415, Web Host Metadata, i.e. the predecessor to WebFinger resource
discovery.
See: http://tools.ietf.org/html/rfc6415
Installation
============
This plugin is enabled by default
Settings
========
none

17
plugins/LilUrl/README Normal file
View File

@ -0,0 +1,17 @@
The LilUrl plugin shortens URLs via a lilURL instance.
See: http://lilurl.sourceforge.net/
Installation
============
add "addPlugin('LilUrl', array('serviceUrl' => 'http://example.org'));"
to the bottom of your config.php
Settings
========
serviceUrl: The URL to the LilUrl instance.
Example
=======
addPlugin('LilUrl', array('serviceUrl' => 'http://example.org'));

24
plugins/LinkPreview/README
View File

@ -1 +1,23 @@
Depends on the oEmbed plugin (Oembed)
The LinkPreview plugin adds a UI for previewing thumbnails from links.
Note: This plugin depends on the "Oembed" plugin.
Installation
============
add "addPlugin('LinkPreview');"
to the bottom of your config.php
Settings
========
process_links: Whether to process links or not
thumbwidth: The width of the link preview
thumbheight: The height of the link preview
Example
=======
addPlugin('Oembed'); // Dependency
$config['attachments']['process_links'] = true;
$config['attachments']['thumbwidth'] = 42;
$config['attachments']['thumbheight'] = 42;
addPlugin('LinkPreview');

19
plugins/Linkback/README Normal file
View File

@ -0,0 +1,19 @@
The Linkback plugin performs linkbacks (pingbacks, trackbacks, webmentions) for
notices containing links.
See:
* https://en.wikipedia.org/wiki/Linkback
Installation
============
add "addPlugin('Linkback');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('Linkback');

20
plugins/LogFilter/README Normal file
View File

@ -0,0 +1,20 @@
The LogFilter plugin provides server-side setting to filter log output by type or keyword.
Installation
============
add "addPlugin('LogFilter');"
to the bottom of your config.php
Settings
========
none
Example
=======
Disable all debug messages and those containing 'About to push':
addPlugin('LogFilter', array(
'priority' => array(LOG_DEBUG => false),
'regex' => array('/About to push/' => false)
));

21
plugins/Mapstraction/README Normal file
View File

@ -0,0 +1,21 @@
The Mapstraction plugin provides map visualization of location data.
Show maps of users' and friends' notices with http://www.mapstraction.com/.
Installation
============
add "addPlugin('Mapstraction');"
to the bottom of your config.php
Settings
========
provider: Name of the service providing maps ('cloudmade', 'google', 'microsoft', 'openlayers', 'yahoo')
apikey: provider API key (or 'appid'), if required
Example
=======
addPlugin('Mapstraction', array(
'provider' => 'openlayers',
'apikey' => 'API_KEY'
));

28
plugins/Memcache/README Normal file
View File

@ -0,0 +1,28 @@
The Memcache plugin implements cache interface for memcache.
See: http://memcached.org/
Installation
============
add "addPlugin('Memcache');"
to the bottom of your config.php
Settings
========
servers: Array of memcache servers addresses
defaultExpiry: How long before cache expires (in seconds)
compressThreshold: Items over this size threshold are eligible for compression (in bytes)
compressMinSaving: If the compression would save more than this ratio, items are eligible for compression
Note: To be compressed, an item must be both over the size threshold AND save
more than the minimum ratio.
Example
=======
addPlugin('Memcache', array(
'servers' => array('127.0.0.1;11211'),
'compressThreshold' => 20480,
'compressMinSaving' => 0.2,
'defaultExpiry' => 86400 // 24h
));

21
plugins/Memcached/README Normal file
View File

@ -0,0 +1,21 @@
The Memcached plugin implements cache interface for memcached.
See: http://memcached.org/
Installation
============
add "addPlugin('Memcached');"
to the bottom of your config.php
Settings
========
servers: Array of memcached servers addresses
defaultExpiry: How long before cache expires (in seconds)
Example
=======
addPlugin('Memcached', array(
'servers' => array('127.0.0.1;11211'),
'defaultExpiry' => 86400 // 24h
));

15
plugins/MentionURL/README Normal file
View File

@ -0,0 +1,15 @@
The MentionURL plugin allows mentioning arbitrary URLs.
Installation
============
add "addPlugin('MentionURL');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('MentionURL');

10
plugins/Mobile/README Normal file
View File

@ -0,0 +1,10 @@
Superclass for WAP 2.0 support
Installation
============
N/A
Settings
========
none

20
plugins/MobileProfile/README Normal file
View File

@ -0,0 +1,20 @@
The MobileProfile plugin implements XHTML MobileProfile output for supporting
user agents.
See: https://en.wikipedia.org/wiki/XHTML_Mobile_Profile
Installation
============
add "addPlugin('MobileProfile');"
to the bottom of your config.php
Note: This plugin is enabled by default on private and single-user instances.
Settings
========
none
Example
=======
addPlugin('MobileProfile');

16
plugins/ModHelper/README Normal file
View File

@ -0,0 +1,16 @@
The ModHelperPlugin plugin lets users who have been manually marked as
"modhelper"s silence accounts.
Installation
============
add "addPlugin('ModHelperPlugin');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('ModHelperPlugin');

15
plugins/ModLog/README Normal file
View File

@ -0,0 +1,15 @@
The ModLog plugin shows the moderation history for a profile in the sidebar.
Installation
============
add "addPlugin('ModLog');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('ModLog');

15
plugins/ModPlus/README Normal file
View File

@ -0,0 +1,15 @@
The ModPlus plugin shows UI extension for profile moderation actions.
Installation
============
add "addPlugin('ModPlus');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('ModPlus');

17
plugins/NoticeTitle/README Normal file
View File

@ -0,0 +1,17 @@
The NoticeTitle plugin allows users to add titles to notices.
Installation
============
add "addPlugin('NoticeTitle');"
to the bottom of your config.php
Settings
========
restricted: Whether this option is restriced to users with the "richedit" role.
Example
=======
addPlugin('NoticeTitle', array(
'restricted' => false
));

30
plugins/Oembed/README
View File

@ -1 +1,29 @@
It's really called oEmbed.
The Oembed plugin for using and representing oEmbed data.
See: http://www.oembed.com/
Installation
============
This plugin is enabled by default
Settings
========
width: Maximum width of the thumbnail in pixels.
height: Maximum height of the thumbnail in pixels.
show_html: Whether to show HTML oEmbed data.
domain_whitelist: Array of regular expressions. Always escape your dots and end your strings.
check_whitelist: Whether to check the domain_whitelist.
Example
=======
$config['thumbnail']['width'] = 42;
$config['thumbnail']['height'] = 42;
$config['attachments']['show_html'] = true;
addPlugin('Oembed', array(
'domain_whitelist' => array(
'^i\d*\.ytimg\.com$' => 'YouTube',
'^i\d*\.vimeocdn\.com$' => 'Vimeo'
),
'check_whitelist' => true
));

16
plugins/OfflineBackup/README Normal file
View File

@ -0,0 +1,16 @@
The OfflineBackup plugin backups user data in offline queue and email when
ready.
Installation
============
add "addPlugin('OfflineBackup');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('OfflineBackup');

15
plugins/OpenExternalLinkTarget/README Normal file
View File

@ -0,0 +1,15 @@
The OpenExternalLinkTarget plugin opens external links in a new window or tab.
Installation
============
add "addPlugin('OpenExternalLinkTarget');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('OpenExternalLinkTarget');

21
plugins/OpenID/README Normal file
View File

@ -0,0 +1,21 @@
The OpenID plugin allows users to use OpenID to login.
See: http://openid.net/
Installation
============
This plugin is enabled by default
Settings
========
openidonly: Whether we only allow logins through OpenID.
trusted_provider: URL to the OpenID provider.
append_username: Whether to append the username at the end of the OpenID URL
Example
=======
$config['site']['openidonly'] = true;
$config['openid']['trusted_provider'] = "http://example.org";
$config['openid']['append_username'] = true;
addPlugin('OpenID');

26
plugins/OpenX/README Normal file
View File

@ -0,0 +1,26 @@
The OpenX plugin enables support for OpenX Ad Server.
See: http://www.openx.org/
Installation
============
add "addPlugin('OpenX');"
to the bottom of your config.php
Settings
========
mediumRectangle:
rectangle:
leaderboard:
wideSkyscraper:
adScript:
Example
=======
$config['openx']['mediumRectangle'] = '';
$config['openx']['rectangle'] = '';
$config['openx']['leaderboard'] = '';
$config['openx']['wideSkyscraper'] = '';
$config['openx']['adScript'] = '';
addPlugin('OpenX');

37
plugins/Orbited/README Normal file
View File

@ -0,0 +1,37 @@
The Orbited plugin enables "real time" updates using Orbited + STOMP
See:
* https://pypi.python.org/pypi/orbited
* https://en.wikipedia.org/wiki/Streaming_Text_Oriented_Messaging_Protocol
Installation
============
add "addPlugin('Orbited');"
to the bottom of your config.php
Settings
========
webserver:
webport:
channelbase:
stompserver:
stompport:
username:
password:
webuser:
webpass:
Example
=======
addPlugin('Orbited', array(
'webserver' => '',
'webport' => '',
'channelbase' => '',
'stompserver' => '',
'stompport' => '',
'username' => '',
'password' => '',
'webuser' => '',
'webpass' => ''
));

23
plugins/PiwikAnalytics/README Normal file
View File

@ -0,0 +1,23 @@
The PiwikAnalytics plugin adds JavaScript that sends various traffic details
to a Piwik server to track web access.
See:
* http://piwik.org/
Installation
============
add "addPlugin('PiwikAnalytics');"
to the bottom of your config.php
Settings
========
piwikroot: The root installation URL of the Piwik instance WITHOUT the protocol
piwikId: The ID provided by the Pwiki instance.
Example
=======
addPlugin('PiwikAnalytics', array(
'piwikroot' => 'example.org/piwik/',
'piwikId' => 'PIWIK_ID'
));

18
plugins/PostDebug/README Normal file
View File

@ -0,0 +1,18 @@
The PostDebug plugin records detailed data on POSTs requests.
Installation
============
add "addPlugin('PostDebug');"
to the bottom of your config.php
Settings
========
dir: The directory where the log file will be saved
Example
=======
addPlugin('PostDebug', array(
'dir' => '/tmp'
));

18
plugins/PtitUrl/README Normal file
View File

@ -0,0 +1,18 @@
The PtitUrl plugin shortens URLS via a PtitUrl URL-shortener service
Installation
============
add "addPlugin('PtitUrl');"
to the bottom of your config.php
Settings
========
serviceUrl: The URL to the PtitUrl instance
Example
=======
addPlugin('PtitUrl', array(
'serviceUrl' => 'http://example.org'
));

10
plugins/QnA/README Normal file
View File

@ -0,0 +1,10 @@
The QnA plugin enables Questions and Answers type of notices
Installation
============
This plugin is enabled by default
Settings
========
none

24
plugins/RegisterThrottle/README Normal file
View File

@ -0,0 +1,24 @@
The RegisterThrottle plugin throttles registration by IP address
Installation
============
This plugin is enabled by default on public instances, otherwise it can be
enabled by adding "addPlugin('RegisterThrottle');" to the bottom of your
config.php
Settings
========
regLimits: Array of time spans in seconds to limits. Default is 3 registrations per hour, 5 per day, 10 per week.
silenced: Disallow registration if a silenced user has registered from this IP address
Example
=======
addPlugin('RegisterThrottle', array(
'regLimits' => array(
604800 => 10, // per week
86400 => 5, // per day
3600 => 3 // per hour
),
'silenced' => true
));

17
plugins/SQLProfile/README Normal file
View File

@ -0,0 +1,17 @@
The SQLProfile plugin watches for poorly indexed DB queries.
Installation
============
add "addPlugin('SQLProfile');"
to the bottom of your config.php
Settings
========
none
Note: entries are logged at the LOG_DEBUG level.
Example
=======
addPlugin('SQLProfile');

18
plugins/SQLStats/README Normal file
View File

@ -0,0 +1,18 @@
The SQLStats plugin logs statistics on performed SQL queries.
Installation
============
add "addPlugin('SQLStats');"
to the bottom of your config.php
Settings
========
verbose: whether to be verbose or not
Note: entries are logged at the LOG_INFO level.
Example
=======
$config['sqlstats']['verbose'] = false;
addPlugin('SQLStats');

19
plugins/Sample/README Normal file
View File

@ -0,0 +1,19 @@
The Sample plugin shows best practices for development of GNU social plugins.
It adds a "Hello" menu item to the default menu and tracks how many times it
has greeted each user.
Installation
============
add "addPlugin('Sample');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('Sample');

10
plugins/SearchSub/README Normal file
View File

@ -0,0 +1,10 @@
The SearchSub plugin allows following all messages with a given search.
Installation
============
This plugin is enabled by default
Settings
========
none

10
plugins/Share/README Normal file
View File

@ -0,0 +1,10 @@
The Share plugin implements "Shares" (repeats) type of notices
Installation
============
This plugin is enabled by default
Settings
========
none

23
plugins/ShareNotice/README Normal file
View File

@ -0,0 +1,23 @@
The ShareNotice plugin allows sharing of notices to Twitter, Facebook and other
platforms.
Installation
============
add "addPlugin('ShareNotice');"
to the bottom of your config.php
Settings
========
targets: Array of platforms allowed to share to
Example
=======
addPlugin('ShareNotice', array(
'targets' => array(
array('Twitter'),
array('Facebook'),
array('StatusNet', array('baseurl' => 'http://example.org'))
)
));

10
plugins/SimpleCaptcha/README Normal file
View File

@ -0,0 +1,10 @@
A simple captcha to get rid of spambots.
Installation
============
This plugin is enabled by default
Settings
========
none

18
plugins/SimpleUrl/README Normal file
View File

@ -0,0 +1,18 @@
The SimpleUrl plugin shortens URLS via a SimpleUrl URL-shortener service
Installation
============
add "addPlugin('SimpleUrl');"
to the bottom of your config.php
Settings
========
serviceUrl: The URL to the SimpleUrl instance
Example
=======
addPlugin('SimpleUrl', array(
'serviceUrl' => 'http://example.org'
));

16
plugins/SiteNoticeInSidebar/README Normal file
View File

@ -0,0 +1,16 @@
The SiteNoticeInSidebar plugin puts the site notice in the sidebar.
Installation
============
add "addPlugin('SiteNoticeInSidebar');"
to the bottom of your config.php
Settings
========
notice: The text to use in the site notice
Example
=======
$config['site']['notice'] = 'Site notice content';
addPlugin('SiteNoticeInSidebar');

20
plugins/Sitemap/README Normal file
View File

@ -0,0 +1,20 @@
The Sitemap plugin creates a dynamic sitemap for Bing, Yahoo! and Google
Installation
============
add "addPlugin('Sitemap');"
to the bottom of your config.php
Settings
========
googlekey: The key provided by Google
yahookey: The key provided by Yahoo!
bingkey: The key provided by Bing
Example
=======
$config['sitemap']['googlekey'] = 'GOOGLE_KEY';
$config['sitemap']['yahookey'] = 'YAHOO_KEY';
$config['sitemap']['bingkey'] = 'BING_KEY';
addPlugin('Sitemap');

30
plugins/SlicedFavorites/README Normal file
View File

@ -0,0 +1,30 @@
The SlicedFavorites plugin shows timelines of popular notices for defined
subsets of users.
Installation
============
add "addPlugin('SlicedFavorites');"
to the bottom of your config.php
Settings
========
slices: Array of subsets
Example
=======
addPlugin('SlicedFavorites', array(
'slices' => array(
// show only pop's notices on /favorited
'default' => array('include' => array('pop')),
// show only son's notices on /favorited/blog
'blog' => array('include' => array('son')),
// show all favorited notices except pop's and son's on /favorited/submitted
'submitted' => array('exclude' => array('pop', 'son')),
// show all favorited notices on /favorited/everybody
'everybody' => array(),
)
));

6
plugins/SphinxSearch/README
View File

@ -8,9 +8,9 @@ Configuration
In StatusNet's configuration, you can adjust the following settings
under 'sphinx':
enabled: Set to true to enable. Default false.
server: a string with the hostname of the sphinx server.
port: an integer with the port number of the sphinx server.
enabled: Set to true to enable. Default true.
server: a string with the hostname of the sphinx server. Default localhost
port: an integer with the port number of the sphinx server. Default 3312
Requirements

22
plugins/StoreRemoteMedia/README Normal file
View File

@ -0,0 +1,22 @@
The StoreRemoteMedia plugin downloads remotely attached files to local server.
Installation
============
add "addPlugin('StoreRemoteMedia');"
to the bottom of your config.php
Settings
========
domain_whitelist: Array of regular expressions. Always escape your dots and end your strings.
check_whitelist: Whether to check the domain_whitelist.
Example
=======
addPlugin('StoreRemoteMedia', array(
'domain_whitelist' => array(
'^i\d*\.ytimg\.com$' => 'YouTube',
'^i\d*\.vimeocdn\.com$' => 'Vimeo'
),
'check_whitelist' => true
));

15
plugins/SubMirror/README Normal file
View File

@ -0,0 +1,15 @@
The SubMirror plugin pull PuSH-enabled feeds into your timeline.
Installation
============
add "addPlugin('SubMirror');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('SubMirror');

26
plugins/SubscriptionThrottle/README Normal file
View File

@ -0,0 +1,26 @@
The SubscriptionThrottle plugin limits how fast users can subscribe to groups
and other users.
Installation
============
add "addPlugin('SubscriptionThrottle');"
to the bottom of your config.php
Settings
========
subLimits: Array of time spans in seconds to limit subscriptions to users.
groupLimits: Array of time spans in seconds to limit subscriptions to groups.
Example
=======
addPlugin('SubscriptionThrottle', array(
'subLimits' => array(
86400 => 100, // 100 subs per day
3600 => 50; // 50 subs per hour
),
'groupLimits' => array(
86400 => 50, // 50 subs per day
3600 => 25; // 25 subs per hour
)
));

17
plugins/TabFocus/README Normal file
View File

@ -0,0 +1,17 @@
The TabFocus plugin changes the notice form behavior so that, while in the text
area, pressing the tab key focuses the "Send" button, matching the behavior of
Twitter.
Installation
============
add "addPlugin('TabFocus');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('TabFocus');

10
plugins/TagSub/README Normal file
View File

@ -0,0 +1,10 @@
The TagSub plugin allows following all messages with a given tag.
Installation
============
This plugin is enabled by default
Settings
========
none

18
plugins/TightUrl/README Normal file
View File

@ -0,0 +1,18 @@
The TightUrl plugin shortens URLS via a TightUrl URL-shortener service
Installation
============
add "addPlugin('TightUrl');"
to the bottom of your config.php
Settings
========
serviceUrl: The URL to the TightUrl instance
Example
=======
addPlugin('TightUrl', array(
'serviceUrl' => 'http://example.org'
));

18
plugins/UserFlag/README Normal file
View File

@ -0,0 +1,18 @@
The UserFlag plugin allows flagging of profiles for review and reviewing
flagged profiles.
Installation
============
add "addPlugin('UserFlag');"
to the bottom of your config.php
Settings
========
flagOnBlock: Whether to automatically flag a profile when a user blocks it.
Example
=======
addPlugin('UserFlag', array(
'flagOnBlock' => true
));

17
plugins/UserLimit/README Normal file
View File

@ -0,0 +1,17 @@
The UserLimit plugin limits the number of users who can register.
Installation
============
add "addPlugin('UserLimit');"
to the bottom of your config.php
Settings
========
maxUsers: The number of maximum users allowed.
Example
=======
addPlugin('UserLimit', array(
'maxUsers' => 42
));

19
plugins/VideoThumbnails/README Normal file
View File

@ -0,0 +1,19 @@
The VideoThumbnails plugin enables video thumbnail preview support.
Installation
============
add "addPlugin('VideoThumbnails');"
to the bottom of your config.php
Note: This plugin depends on
* avconv
* php5-gd
Settings
========
none
Example
=======
addPlugin('VideoThumbnails');

10
plugins/WebFinger/README Normal file
View File

@ -0,0 +1,10 @@
The WebFinger plugin adds WebFinger lookup to GNU Social
Installation
============
This plugin is enabled by default except on private instances
Settings
========
none

17
plugins/WikiHashtags/REAME Normal file
View File

@ -0,0 +1,17 @@
The WikiHashtags plugin shows WikiHashtags content in the sidebar
See: http://hashtags.wikia.com/wiki/WikiHashtags
Installation
============
add "addPlugin('WikiHashtags');"
to the bottom of your config.php
Settings
========
none
Example
=======
addPlugin('WikiHashtags');