]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - README
Apply upstream fix to MSN library for darkip
[quix0rs-gnu-social.git] / README
diff --git a/README b/README
index d972bf5676fdb0cb7c52e4f31f9cc93347aea14e..74ef138a2a32f6302c50f43ae1b0193e5b703bb3 100644 (file)
--- a/README
+++ b/README
@@ -2,8 +2,8 @@
 README
 ------
 
-StatusNet 0.9.6 "Man on the Moon"
-29 October 2010
+StatusNet 0.9.7 "World Leader Pretend"
+17 March 2011
 
 This is the README file for StatusNet, the Open Source microblogging
 platform. It includes installation instructions, descriptions of
@@ -96,43 +96,47 @@ for additional terms.
 New this version
 ================
 
-This is a security, bug and feature release since version 0.9.5 released on
-10 September 2010.
+This is a security, bug and feature release since version 0.9.6 released on
+23 October 2010.
 
-For best compatibility with client software and site federation, and a lot of
-bug fixes, it is highly recommended that all public sites upgrade to the new
-version.
+For best compatibility with client software and site federation, and a
+lot of bug fixes, it is highly recommended that all public sites
+upgrade to the new version. Upgrades require new database indexes for
+best performance; see Upgrade below.
 
 Notable changes this version:
 
-- Site moderators can now delete groups.
-- New themes: clean, shiny, mnml, victorian
-- New YammerImport plugin allows site admins to import non-private profiles and
-  message from an authenticated Yammer site.
-- New experimental plugins: AnonFavorites, SlicedFavorites, GroupFavorited,
-  ForceGroup, ShareNotice
-- OAuth upgraded to 1.0a
-- Localization updates now include plugins, thanks to translatewiki.net!
-- SSL link generation should be more consistent; alternate SSL URLs can be
-  set in the admin UI for more parts of the system.
-- Experimental backupuser.php, restoreuser.php command-line scripts to
-  dump/restore a user's complete activity stream. Can be used to transfer
-  accounts manually between sites, or to save a backup before deleting.
-- Unicode fixes for OStatus notices
-- 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.
+- GroupPrivateMessage plugin lets users send private messages
+  to a group. (Similar to "private groups" on Yammer.)
+- Support for Twitter streaming API in Twitter bridge plugin
+- Support for a new Activity Streams-based API using AtomPub, allowing
+  richer API data. See http://status.net/wiki/AtomPub for details.
+- Unified Facebook plugin, replacing previous Facebook application
+  and Facebook Connect plugin.
+- A plugin to send out a daily summary email to network users.
+- In-line thumbnails of some attachments (video, images) and oEmbed objects.
+- Local copies of remote profiles to let moderators manage OStatus users.
+- Upgrade upstream JS, minify everything.
+- Allow pushing plugin JS, CSS, and static files to a CDN.
+- Configurable nickname rules.
+- Better support for bit.ly URL shortener.
+- InProcessCache plugin for additional caching on top of memcached.
+- Support for Activity Streams JSON feeds on many streams.
+- User-initiated backup and restore of account data in Activity Streams
+  format.
+- Bookmark plugin for making del.icio.us-like social bookmarking sites,
+  including del.icio.us backup file import. Supports OStatus.
+- SQLProfile plugin to tune SQL queries.
+- Better sorting on timelines to support restored or imported data.
+- Hundreds of translations from http://translatewiki.net/
+- Hundreds of performance tunings, bug fixes, and UI improvements.
+- Remove deprecated data from Activity Streams Atom output, to the
+  extent possible.
+- NewMenu plugin for new layout of menu items.
+- Experimental support for moving an account from one server to
+  another, using new AtomPub API.
+
+A full changelog is available at http://status.net/wiki/StatusNet_0.9.7.
 
 Prerequisites
 =============
@@ -243,9 +247,9 @@ especially if you've previously installed PHP/MySQL packages.
 1. Unpack the tarball you downloaded on your Web server. Usually a
    command like this will work:
 
-       tar zxf statusnet-0.9.6.tar.gz
+       tar zxf statusnet-0.9.7.tar.gz
 
-   ...which will make a statusnet-0.9.6 subdirectory in your current
+   ...which will make a statusnet-0.9.7 subdirectory in your current
    directory. (If you don't have shell access on your Web server, you
    may have to unpack the tarball on your local computer and FTP the
    files to the server.)
@@ -253,7 +257,7 @@ especially if you've previously installed PHP/MySQL packages.
 2. Move the tarball to a directory of your choosing in your Web root
    directory. Usually something like this will work:
 
-       mv statusnet-0.9.6 /var/www/statusnet
+       mv statusnet-0.9.7 /var/www/statusnet
 
    This will make your StatusNet instance available in the statusnet path of
    your server, like "http://example.net/statusnet". "microblog" or
@@ -668,7 +672,7 @@ with this situation.
 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
 been tracking the "git" version of the software, you will probably
 want to upgrade and keep your existing data. There is no automated
-upgrade procedure in StatusNet 0.9.6. Try these step-by-step
+upgrade procedure in StatusNet 0.9.7. Try these step-by-step
 instructions; read to the end first before trying them.
 
 0. Download StatusNet and set up all the prerequisites as if you were
@@ -689,25 +693,30 @@ instructions; read to the end first before trying them.
 5. Once all writing processes to your site are turned off, make a
    final backup of the Web directory and database.
 6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
-7. Unpack your StatusNet 0.9.6 tarball and move it to "statusnet" or
+7. Unpack your StatusNet 0.9.7 tarball and move it to "statusnet" or
    wherever your code used to be.
 8. Copy the config.php file and the contents of the avatar/, background/,
    file/, and local/ subdirectories from your old directory to your new
    directory.
 9. Copy htaccess.sample to .htaccess in the new directory. Change the
    RewriteBase to use the correct path.
-10. Rebuild the database. (You can safely skip this step and go to #12
-    if you're upgrading from another 0.9.x version).
+10. Rebuild the database.
 
     NOTE: this step is destructive and cannot be
     reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
     do it without a known-good backup!
 
-    If your database is at version 0.8.0 or above, you can run a
+    If your database is at version 0.8.0 or higher in the 0.8.x line, you can run a
     special upgrade script:
 
         mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
 
+    If you are upgrading from any 0.9.x version like 0.9.6, run this script:
+
+        mysql -u<rootuser> -p<rootpassword> <database> db/096to097.sql
+
+    Despite the name, it should work for any 0.9.x branch.
+
     Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
     BACKUP run the rebuilddb.sh script like this:
 
@@ -737,6 +746,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
 --------------
 
@@ -873,9 +888,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.
@@ -1139,6 +1152,9 @@ ssl: Whether to use SSL for JavaScript files. Default is null, which means
 sslserver: SSL server to use when page is HTTPS-encrypted. If
     unspecified, site ssl server and so on will be used.
 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
+bustframes: If true, all web pages will break out of framesets. If false,
+           can comfortably live in a frame or iframe... probably. Default
+           to true.
 
 xmpp
 ----
@@ -1279,7 +1295,7 @@ biolimit: max character length of bio; 0 means no limit; null means to use
 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 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.  
 
@@ -1388,13 +1404,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
 ------
@@ -1468,6 +1496,8 @@ 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. Defaults to 0; set to
+             1 to keep notices private to this site by default.
 
 message
 -------
@@ -1544,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
 ------
 
@@ -1572,6 +1618,24 @@ 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
 =======