Merge branch '0.9.x' into json-activities

[quix0rs-gnu-social.git] / README

diff --git a/README b/README
index 6872634b88835f89ff599de749ca075601c24d23..c27182395c2d11adedccf76e86ac4e05fbf9db57 100644 (file)
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ README
 ------
 
 StatusNet 0.9.6 "Man on the Moon"
 ------
 
 StatusNet 0.9.6 "Man on the Moon"

-25 October 2010 - RELEASE CANDIDATE
+29 October 2010

 
 This is the README file for StatusNet, the Open Source microblogging
 platform. It includes installation instructions, descriptions of
 
 This is the README file for StatusNet, the Open Source microblogging
 platform. It includes installation instructions, descriptions of


@@ -122,6 +122,16 @@ Notable changes this version:
 - Header metadata on notice pages to aid in manual reposting on Facebook
 - Lots of little fixes...
 
 - Header metadata on notice pages to aid in manual reposting on Facebook
 - Lots of little fixes...
 

+Changes from 0.9.6 release candidate 1:
+- fix for broken group pages when logged out
+- fix for stuck ping queue entries when bad profile
+- fix for bogus single-user nickname config entry error
+- i18n updates
+- nofollow updates
+- SSL-only mode secure cookie fix
+- experimental ApiLogger plugin for usage data gathering
+- experimental follow-everyone plugin
+

 A full changelog is available at http://status.net/wiki/StatusNet_0.9.6.
 
 Prerequisites
 A full changelog is available at http://status.net/wiki/StatusNet_0.9.6.
 
 Prerequisites


@@ -210,14 +220,12 @@ and the URLs are listed here for your convenience.
   version may render your StatusNet site unable to send or receive XMPP
   messages.
 - Facebook library. Used for the Facebook application.
   version may render your StatusNet site unable to send or receive XMPP
   messages.
 - Facebook library. Used for the Facebook application.

-- PEAR Services_oEmbed. Used for some multimedia integration.
-- PEAR HTTP_Request is an oEmbed dependency.
-- PEAR Validate is an oEmbed dependency.
-- PEAR Net_URL2 is an oEmbed dependency.
+- 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.
 - 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.

 
 A design goal of StatusNet is that the basic Web functionality should
 work on even the most restrictive commercial hosting services.
 
 A design goal of StatusNet is that the basic Web functionality should
 work on even the most restrictive commercial hosting services.


@@ -1268,6 +1276,12 @@ Profile management.
 
 biolimit: max character length of bio; 0 means no limit; null means to use
     the site text limit default.
 
 biolimit: max character length of bio; 0 means no limit; null means to use
     the site text limit default.

+backup: whether users can backup their own profiles. Defaults to true.
+restore: whether users can restore their profiles from backup files. Defaults
+        to true.
+delete: whether users can delete their own accounts. Defaults to false.
+move: whether users can move their accounts to another server. Defaults
+      to true.  

 
 newuser
 -------
 
 newuser
 -------


@@ -1530,6 +1544,52 @@ external: external links in notices. One of three values: 'sometimes',
     nofollowed on profile, notice, and favorites page. Default is
     'sometimes'.
 
     nofollowed on profile, notice, and favorites page. Default is
     'sometimes'.
 

+router
+------
+
+We use a router class for mapping URLs to code. This section controls
+how that router works.
+
+cache: whether to cache the router in memcache (or another caching
+    mechanism). Defaults to true, but may be set to false for
+    developers (who might be actively adding pages, so won't want the
+    router cached) or others who see strange behavior. You're unlikely
+    to need this unless you're a developer.
+
+http
+----
+
+Settings for the HTTP client.
+
+ssl_cafile: location of the CA file for SSL. If not set, won't verify
+           SSL peers. Default unset.
+curl: Use cURL <http://curl.haxx.se/> for doing HTTP calls. You must
+      have the PHP curl extension installed for this to work.
+proxy_host: Host to use for proxying HTTP requests. If unset, doesn't
+           do any HTTP proxy stuff. Default unset.
+proxy_port: Port to use to connect to HTTP proxy host. Default null.
+proxy_user: Username to use for authenticating to the HTTP proxy. Default null.
+proxy_password: Password to use for authenticating to the HTTP proxy. Default null.
+proxy_auth_scheme: Scheme to use for authenticating to the HTTP proxy. Default null.
+
+plugins
+-------
+
+default: associative array mapping plugin name to array of arguments. To disable
+        a default plugin, unset its value in this array.
+locale_path: path for finding plugin locale files. In the plugin's directory
+            by default.
+server: Server to find static files for a plugin when the page is plain old HTTP.
+       Defaults to site/server (same as pages). Use this to move plugin CSS and
+       JS files to a CDN.
+sslserver: Server to find static files for a plugin when the page is HTTPS. Defaults
+          to site/server (same as pages). Use this to move plugin CSS and JS files
+          to a CDN.
+path: Path to the plugin files. defaults to site/path + '/plugins/'. Expects that
+      each plugin will have a subdirectory at plugins/NameOfPlugin. Change this
+      if you're using a CDN.
+sslpath: Path to use on the SSL server. Same as plugins/path.
+

 Plugins
 =======
 
 Plugins
 =======