Add plugin READMEs

plugins/ActivitySpam/README

@@ -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');

plugins/AnonymousFave/README

@@ -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');

plugins/AntiBrute/README

@@ -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
+

plugins/ApiLogger/README

@@ -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
+));
+

plugins/Awesomeness/README

@@ -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');

plugins/Blacklist/README

@@ -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');

plugins/BlankAd/README

@@ -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));

plugins/BlogspamNet/README

@@ -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');
+

plugins/CacheLog/README

@@ -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');

plugins/ClientSideShorten/README

@@ -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
+This plugin is enabled by default
-That's it!
+

plugins/ConversationTree/README

@@ -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');

plugins/Cronish/README

@@ -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

plugins/Diaspora/README

@@ -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');

plugins/DirectMessage/README

@@ -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
+

plugins/DirectionDetector/README

@@ -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');

plugins/Directory/README

@@ -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');

plugins/DiskCache/README

@@ -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'
+));
+

plugins/DomainStatusNetwork/README

@@ -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');
+

plugins/DomainWhitelist/README

@@ -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');

plugins/EmailAuthentication/README

@@ -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
+

plugins/EmailRegistration/README

@@ -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');

plugins/EmailReminder/README

@@ -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');
+

plugins/EmailSummary/README

@@ -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');

plugins/Event/README

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

plugins/ExtendedProfile/README

@@ -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');
+

plugins/Favorite/README

@@ -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
+

plugins/FeedPoller/README

@@ -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');
+

plugins/FollowEveryone/README

@@ -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');
+

plugins/ForceGroup/README

@@ -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');
+

plugins/GeoURL/README

@@ -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');
+

plugins/Geonames/README

@@ -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');
+

plugins/GroupFavorited/README

@@ -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');
+

plugins/GroupPrivateMessage/README

@@ -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');
+

plugins/ImageMagick/README

@@ -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');
+

plugins/InProcessCache/README

@@ -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');
+

plugins/LRDD/README

@@ -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
+

plugins/LilUrl/README

@@ -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'));
+

plugins/LinkPreview/README

@@ -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');
+

plugins/Linkback/README

@@ -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');
+

plugins/LogFilter/README

@@ -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)
+));
+

plugins/Mapstraction/README

@@ -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'
+));
+

plugins/Memcache/README

@@ -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
+));
+

plugins/Memcached/README

@@ -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
+));
+

plugins/MentionURL/README

@@ -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');
+

plugins/Mobile/README

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

plugins/MobileProfile/README

@@ -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');
+

plugins/ModHelper/README

@@ -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');
+

plugins/ModLog/README

@@ -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');
+

plugins/ModPlus/README

@@ -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');
+

plugins/NoticeTitle/README

@@ -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
+));
+

plugins/Oembed/README

@@ -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
+));
+

plugins/OfflineBackup/README

@@ -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');
+

plugins/OpenExternalLinkTarget/README

@@ -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');
+

plugins/OpenID/README

@@ -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');
+

plugins/OpenX/README

@@ -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');
+

plugins/Orbited/README

@@ -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' => ''
+));
+

plugins/PiwikAnalytics/README

@@ -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'
+));
+

plugins/PostDebug/README

@@ -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'
+));
+

plugins/PtitUrl/README

@@ -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'
+));
+

plugins/QnA/README

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

plugins/RegisterThrottle/README

@@ -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
+));
+

plugins/SQLProfile/README

@@ -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');
+

plugins/SQLStats/README

@@ -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');
+

plugins/Sample/README

@@ -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');
+

plugins/SearchSub/README

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

plugins/Share/README

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

plugins/ShareNotice/README

@@ -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'))
+    )
+));
+

plugins/SimpleCaptcha/README

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

plugins/SimpleUrl/README

@@ -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'
+));
+

plugins/SiteNoticeInSidebar/README

@@ -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');
+

plugins/Sitemap/README

@@ -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');
+

plugins/SlicedFavorites/README

@@ -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(),
+    )
+));
+

plugins/SphinxSearch/README

@@ -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.
+enabled: Set to true to enable. Default true.
-server: a string with the hostname of the sphinx server.
+server: a string with the hostname of the sphinx server. Default localhost
-port: an integer with the port number of the sphinx server.
+port: an integer with the port number of the sphinx server. Default 3312
 
 
 Requirements

plugins/StoreRemoteMedia/README

@@ -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
+));
+

plugins/SubMirror/README

@@ -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');
+

plugins/SubscriptionThrottle/README

@@ -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
+    )
+));
+

plugins/TabFocus/README

@@ -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');
+

plugins/TagSub/README

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

plugins/TightUrl/README

@@ -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'
+));
+

plugins/UserFlag/README

@@ -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
+));
+

plugins/UserLimit/README

@@ -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
+));
+

plugins/VideoThumbnails/README

@@ -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');
+

plugins/WebFinger/README

@@ -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
+

plugins/WikiHashtags/REAME

@@ -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');
+