git.gnu.io has moved to IP address 209.51.188.249 -- please double check where you are logging in.

Commit a6142056 authored by chimo's avatar chimo

Add plugin READMEs

parent 2c5cba28
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');
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');
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
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
));
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');
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');
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));
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');
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');
......@@ -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
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');
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
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');
The DirectMessage plugin allows users to send Direct Message to other local users
Installation
============
This plugin is enabled by default
Settings
========
none
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');
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');
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'
));
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');
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');
......@@ -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
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');
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');
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');
The Event plugin adds event invitations and RSVPs types of notices.
Installation
============
This plugin is enabled by default
Settings
========
none
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');
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
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');
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');
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');
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');
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');
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');
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');
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');
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');
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
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'));
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');
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');
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)
));
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'