Merge branch 'master' into 1.0.x

[quix0rs-gnu-social.git] / README

diff --git a/README b/README
index 4a8aba104e26849c7c7988f5b7d99e4c03238b7b..6a0633144b8772ad7745f17a5d0add8836dd6646 100644 (file)
--- a/README
+++ b/README
@@ -226,7 +226,6 @@ and the URLs are listed here for your convenience.
 - Facebook library. Used for the Facebook application.
 - PEAR Validate is used for URL and email validation.
 - Console_GetOpt for parsing command-line options.
-- libomb. a library for implementing OpenMicroBlogging 0.1, the
   predecessor to OStatus.
 - HTTP_Request2, a library for making HTTP requests.
 - PEAR Net_URL2 is an HTTP_Request2 dependency.
@@ -484,7 +483,7 @@ On a default installation, your site can broadcast messages using
 XMPP. Users won't be able to post messages using XMPP unless you've
 got the XMPP daemon running.  See 'Queues and daemons' below for how
 to set that up. Also, once you have a sizable number of users, sending
-a lot of SMS, OMB, and XMPP messages whenever someone posts a message
+a lot of SMS, OStatus, and XMPP messages whenever someone posts a message
 can really slow down your site; it may cause posting to timeout.
 
 NOTE: stream_select(), a crucial function for network programming, is
@@ -746,6 +745,12 @@ statusnet.ini (since this is the recommended database name). If you
 have a line in your config.php pointing to the old name, you'll need
 to update it.
 
+NOTE: the 1.0.0 version of StatusNet changed the URLs for all admin
+panels from /admin/* to /panel/*. This now allows the (popular)
+username 'admin', but blocks the considerably less popular username
+'panel'. If you have an existing user named 'panel', you should rename
+them before upgrading.
+
 Notice inboxes
 --------------
 
@@ -882,9 +887,7 @@ sslserver: use an alternate server name for SSL URLs, like
     parameters correctly so that both the SSL server and the
     "normal" server can access the session cookie and
     preferably other cookies as well.
-shorturllength: Length of URL at which URLs in a message exceeding 140
-    characters will be sent to the user's chosen
-    shortening service.
+shorturllength: ignored. See 'url' section below.
 dupelimit: minimum time allowed for one person to say the same thing
     twice. Default 60s. Anything lower is considered a user
     or UI error.
@@ -1107,7 +1110,7 @@ public
 For configuring the public stream.
 
 localonly: If set to true, only messages posted by users of this
-    service (rather than other services, filtered through OMB)
+    service (rather than other services, filtered through OStatus)
     are shown in the public stream. Default true.
 blacklist: An array of IDs of users to hide from the public stream.
     Useful if you have someone making excessive Twitterfeed posts
@@ -1400,13 +1403,25 @@ maxaliases: maximum number of aliases a group can have. Default 3. Set
 desclimit: maximum number of characters to allow in group descriptions.
     null (default) means to use the site-wide text limits. 0
     means no limit.
+addtag: Whether to add a tag for the group nickname for every group post 
+       (pre-1.0.x behaviour). Defaults to false.
 
-oohembed
+oembed
 --------
 
-oEmbed endpoint for multimedia attachments (links in posts).
+oEmbed endpoint for multimedia attachments (links in posts). Will also
+work as 'oohembed' for backwards compatibility.
 
-endpoint: oohembed endpoint using http://oohembed.com/ software.
+endpoint: oohembed endpoint using http://oohembed.com/ software. Defaults to
+         'http://oohembed.com/oohembed/'.
+order: Array of methods to check for OEmbed data. Methods include 'built-in'
+       (use a built-in function to simulate oEmbed for some sites),
+       'well-known' (use well-known public oEmbed endpoints),
+       'discovery' (discover using <link> headers in HTML), 'service' (use
+       a third-party service, like oohembed or embed.ly. Default is
+       array('built-in', 'well-known', 'service', 'discovery'). Note that very
+       few sites implement oEmbed; 'discovery' is going to fail 99% of the
+       time.
 
 search
 ------
@@ -1480,6 +1495,9 @@ Configuration options specific to notices.
 contentlimit: max length of the plain-text content of a notice.
     Default is null, meaning to use the site-wide text limit.
     0 means no limit.
+defaultscope: default scope for notices. If null, the default
+       scope depends on site/private. It's 1 if the site is private,
+       0 otherwise. Set this value to override.
 
 message
 -------
@@ -1556,6 +1574,22 @@ external: external links in notices. One of three values: 'sometimes',
     nofollowed on profile, notice, and favorites page. Default is
     'sometimes'.
 
+url
+---
+
+Everybody loves URL shorteners. These are some options for fine-tuning
+how and when the server shortens URLs.
+
+shortener: URL shortening service to use by default. Users can override
+           individually. 'ur1.ca' by default.
+maxlength: If an URL is strictly longer than this limit, it will be
+           shortened. Note that the URL shortener service may return an
+           URL longer than this limit. Defaults to 25. Users can
+           override. If set to 0, all URLs will be shortened.
+maxnoticelength: If a notice is strictly longer than this limit, all
+           URLs in the notice will be shortened. Users can override.
+           -1 means the text limit for notices.
+
 router
 ------