Merge branch 'master' of git@gitorious.org:statusnet/mainline

[quix0rs-gnu-social.git] / README

diff --git a/README b/README
index 6e39890cbff9fb0ebb6286cdaceee3f417f88a59..da278f7412a980df0865b8492a644addb74fc64d 100644 (file)
--- a/README
+++ b/README
@@ -2,8 +2,8 @@
 README
 ------
 
 README
 ------
 

-StatusNet 0.9.0 ("Stand") Release Candidate 2
-22 Dec 2009
+StatusNet 0.9.0 ("Stand") Beta 4
+27 Jan 2010

 
 This is the README file for StatusNet (formerly Laconica), the Open
 Source microblogging platform. It includes installation instructions,
 
 This is the README file for StatusNet (formerly Laconica), the Open
 Source microblogging platform. It includes installation instructions,


@@ -167,6 +167,37 @@ Notable changes this version:
 - Add support for "repeats" (similar to Twitter's "retweets").
 - Support for repeats in Twitter API.
 - Better notification of direct messages.
 - Add support for "repeats" (similar to Twitter's "retweets").
 - Support for repeats in Twitter API.
 - Better notification of direct messages.

+- New plugin to add "powered by StatusNet" to logo.
+- Returnto works for private sites.
+- Localisation updates, including new Persian translation.
+- CAS authentication plugin
+- Get rid of DB_DataObject native cache (big memory leaker)
+- setconfig.php script to set configuration variables
+- Blacklist plugin, to blacklist URLs and nicknames
+- Users can set flag whether they want to share location
+  both in notice form (for one notice) and profile settings
+  (any notice)
+- notice inboxes moved from normalized notice_inbox table to
+  denormalized inbox table
+- Automatic compression of Memcache
+- Memory caching pluginized
+- Memcache, XCache, APC and Diskcache plugins
+- A script to update user locations
+- cache empty query results
+- A sample plugin to show best plugin practices
+- CacheLog plugin to debug cache accesses
+- Require users to login to view attachments on private sites
+- Plugin to use Mollom spam detection service
+- Plugin for RSSCloud
+- Add an array of default plugins
+- A version action to give credit to contributors and plugin
+  developers
+- Daemon to read IMAP mailbox instead of using a mailbox script
+- Pass session information between SSL and non-SSL server
+  when SSL set to 'sometimes'
+- Major refactoring of queue handlers to manage very
+  large hosting site (like status.net)
+- SubscriptionThrottle plugin to prevent subscription spamming

 
 Prerequisites
 =============
 
 Prerequisites
 =============


@@ -566,26 +597,19 @@ server is probably a good idea for high-volume sites.
    needs as a parameter the install path; if you run it from the
    StatusNet dir, "." should suffice.
 
    needs as a parameter the install path; if you run it from the
    StatusNet dir, "." should suffice.
 

-This will run eight (for now) queue handlers:
+This will run the queue handlers:

 
 

+* queuedaemon.php - polls for queued items for inbox processing and
+  pushing out to OMB, SMS, XMPP, etc.

 * xmppdaemon.php - listens for new XMPP messages from users and stores
 * xmppdaemon.php - listens for new XMPP messages from users and stores

-  them as notices in the database.
-* jabberqueuehandler.php - sends queued notices in the database to
-  registered users who should receive them.
-* publicqueuehandler.php - sends queued notices in the database to
-  public feed listeners.
-* ombqueuehandler.php - sends queued notices to OpenMicroBlogging
-  recipients on foreign servers.
-* smsqueuehandler.php - sends queued notices to SMS-over-email addresses
-  of registered users.
-* xmppconfirmhandler.php - sends confirmation messages to registered
-  users.
-
-Note that these queue daemons are pretty raw, and need your care. In
-particular, they leak memory, and you may want to restart them on a
-regular (daily or so) basis with a cron job. Also, if they lose
-the connection to the XMPP server for too long, they'll simply die. It
-may be a good idea to use a daemon-monitoring service, like 'monit',
+  them as notices in the database; also pulls queued XMPP output from
+  queuedaemon.php to push out to clients.
+
+These two daemons will automatically restart in most cases of failure
+including memory leaks (if a memory_limit is set), but may still die
+or behave oddly if they lose connections to the XMPP or queue servers.
+
+It may be a good idea to use a daemon-monitoring service, like 'monit',

 to check their status and keep them running.
 
 All the daemons write their process IDs (pids) to /var/run/ by
 to check their status and keep them running.
 
 All the daemons write their process IDs (pids) to /var/run/ by


@@ -595,7 +619,7 @@ daemons.
 Since version 0.8.0, it's now possible to use a STOMP server instead of
 our kind of hacky home-grown DB-based queue solution. See the "queues"
 config section below for how to configure to use STOMP. As of this
 Since version 0.8.0, it's now possible to use a STOMP server instead of
 our kind of hacky home-grown DB-based queue solution. See the "queues"
 config section below for how to configure to use STOMP. As of this

-writing, the software has been tested with ActiveMQ (
+writing, the software has been tested with ActiveMQ.

 
 Sitemaps
 --------
 
 Sitemaps
 --------


@@ -681,10 +705,12 @@ subdirectory to add a new language to your system. You'll need to
 compile the ".po" files into ".mo" files, however.
 
 Contributions of translation information to StatusNet are very easy:
 compile the ".po" files into ".mo" files, however.
 
 Contributions of translation information to StatusNet are very easy:

-you can use the Web interface at http://status.net/pootle/ to add one
+you can use the Web interface at TranslateWiki.net to add one

 or a few or lots of new translations -- or even new languages. You can
 also download more up-to-date .po files there, if you so desire.
 
 or a few or lots of new translations -- or even new languages. You can
 also download more up-to-date .po files there, if you so desire.
 

+For info on helping with translations, see http://status.net/wiki/Translations
+

 Backups
 -------
 
 Backups
 -------
 


@@ -710,11 +736,21 @@ private site, but users of the private site may be able to subscribe
 to users on a remote site. (Or not... it's not well tested.) The
 "proper behaviour" hasn't been defined here, so handle with care.
 
 to users on a remote site. (Or not... it's not well tested.) The
 "proper behaviour" hasn't been defined here, so handle with care.
 

-If fancy URLs is enabled, access to file attachments can also be
-restricted to logged-in users only. Uncomment the appropriate rewrite
-rule in .htaccess or your server's httpd.conf. (This most likely will
-not work if you are using a virtual server for attachments, so consider
-the performance/security tradeoff.)
+Access to file attachments can also be restricted to logged-in users only.
+1. Add a directory outside the web root where your file uploads will be
+   stored. Usually a command like this will work:
+
+           mkdir /var/www/mublog-files
+
+2. Make the file uploads directory writeable by the web server. An
+   insecure way to do this is:
+
+           chmod a+x /var/www/mublog-files
+
+3. Tell StatusNet to use this directory for file uploads. Add a line
+   like this to your config.php:
+
+           $config['attachments']['dir'] = '/var/www/mublog-files';

 
 Upgrading
 =========
 
 Upgrading
 =========


@@ -1025,6 +1061,12 @@ Creative Commons Attribution 3.0 license, which is probably the right
 choice for any public site. Note that some other servers will not
 accept notices if you apply a stricter license than this.
 
 choice for any public site. Note that some other servers will not
 accept notices if you apply a stricter license than this.
 

+type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
+      (default copyright), or 'private' (for private and confidential
+      information).
+owner: for 'allrightsreserved' or 'private', an assigned copyright
+       holder (for example, an employer for a private site). If
+       not specified, will be attributed to 'contributors'.

 url: URL of the license, used for links.
 title: Title for the license, like 'Creative Commons Attribution 3.0'.
 image: A button shown on each page for the license.
 url: URL of the license, used for links.
 title: Title for the license, like 'Creative Commons Attribution 3.0'.
 image: A button shown on each page for the license.


@@ -1445,6 +1487,15 @@ disabled: whether to enable this command. If enabled, users who send
          should enable it only after you've convinced yourself that
          it is safe. Default is 'false'.
 
          should enable it only after you've convinced yourself that
          it is safe. Default is 'false'.
 

+singleuser
+----------
+
+If an installation has only one user, this can simplify a lot of the
+interface. It also makes the user's profile the root URL.
+
+enabled: Whether to run in "single user mode". Default false.
+nickname: nickname of the single user.
+

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


@@ -1612,6 +1663,7 @@ if anyone's been overlooked in error.
 * Craig Andrews
 * mEDI
 * Brett Taylor
 * Craig Andrews
 * mEDI
 * Brett Taylor

+* Brigitte Schuster

 
 Thanks also to the developers of our upstream library code and to the
 thousands of people who have tried out Identi.ca, installed StatusNet,
 
 Thanks also to the developers of our upstream library code and to the
 thousands of people who have tried out Identi.ca, installed StatusNet,