]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - README
Re-camelcase ApiOauthAuthorizeAction so it will be accessible when
[quix0rs-gnu-social.git] / README
diff --git a/README b/README
index 3ea363ff1a55d49dcea9c992d33e25aef682a12a..43a9bb5e959d683230b07a3cd54afe72c8b1e572 100644 (file)
--- a/README
+++ b/README
@@ -2,8 +2,8 @@
 README
 ------
 
-StatusNet 0.9.2 ("King of Birds")
-3 May 2010
+StatusNet 0.9.6 "Man on the Moon"
+19 October 2010
 
 This is the README file for StatusNet, the Open Source microblogging
 platform. It includes installation instructions, descriptions of
@@ -38,11 +38,16 @@ more, please see the Open Software Service Definition 1.1:
     http://www.opendefinition.org/ossd
 
 StatusNet, Inc. <http://status.net/> also offers this software as a
-Web service, requiring no installation on your part. The software run
+Web service, requiring no installation on your part. See
+<http://status.net/signup> for details. The software run
 on status.net is identical to the software available for download, so
 you can move back and forth between a hosted version or a version
 installed on your own servers.
 
+A commercial software subscription is available from StatusNet Inc. It
+includes 24-hour technical support and developer support. More
+information at http://status.net/contact or email sales@status.net.
+
 License
 =======
 
@@ -68,6 +73,20 @@ License along with this program, in the file "COPYING".  If not, see
     of using the software, and if you do not wish to share your
     modifications, *YOU MAY NOT INSTALL STATUSNET*.
 
+Documentation in the /doc-src/ directory is available under the
+Creative Commons Attribution 3.0 Unported license, with attribution to
+"StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
+
+CSS and images in the /theme/ directory are available under the
+Creative Commons Attribution 3.0 Unported license, with attribution to
+"StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
+
+Our understanding and intention is that if you add your own theme that
+uses only CSS and images, those files are not subject to the copyleft
+requirements of the Affero General Public License 3.0. See
+http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
+legal advice; consult your lawyer.
+
 Additional library software has been made available in the 'extlib'
 directory. All of it is Free Software and can be distributed under
 liberal terms, but those terms may differ in detail from the AGPL's
@@ -77,31 +96,33 @@ for additional terms.
 New this version
 ================
 
-This is a minor bug and feature release since version 0.9.1 released 28 
-March 2010.
+This is a security, bug and feature release since version 0.9.5 released on
+10 September 2010.
 
-Because of fixes to OStatus bugs, it is highly recommended that all
-public sites upgrade to the new version immediately.
+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.
 
 Notable changes this version:
 
-- Fixed email notifications for @-replies that come in via OStatus
-- OStatus related Fixes to the cloudy theme 
-- Pass geo locations over Twitter bridge (will only be used if enabled on the Twitter side)
-- scripts/showplugins.php - script to dump the list of activated plugins and their settings
-- scripts/fixup_blocks.php - script to finds any stray subscriptions in violation of blocks, and removes them
-- Allow blocking someone who's not currently subscribed to you (prevents seeing @-replies from them, or them subbing to you in future)
-- Default 2-second timeout on Geonames web service lookups 
-- Improved localization for plugins
-- New anti-spam measures: added nofollow rels to group members list, subscribers list
-- Shared cache key option for Geonames plugin (lets multi-instance sites share their cached geoname lookups)
-- Stability fixes to the TwitterStatusFetcher
-- If user allows location sharing but turned off browser location use profile location
-- Improved group listing via the API
-- Improved FOAF output
-- Several other bugfixes
-
-A full changelog is available at http://status.net/wiki/StatusNet_0.9.2.
+- 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...
+
+A full changelog is available at http://status.net/wiki/StatusNet_0.9.6.
 
 Prerequisites
 =============
@@ -112,8 +133,8 @@ run correctly.
 - PHP 5.2.3+. It may be possible to run this software on earlier
   versions of PHP, but many of the functions used are only available
   in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
-  daemons on 64-bit platforms. PHP 5.3.x should work but is known
-  to cause some failures for OpenID.
+  daemons on 64-bit platforms. PHP 5.3.x should work correctly in this
+  release, but problems with some plugins are possible.
 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
   server. It has been primarily tested on 5.x servers, although it may
   be possible to install on earlier (or later!) versions. The server
@@ -129,7 +150,6 @@ Your PHP installation must include the following PHP extensions:
 - MySQL. For accessing the database.
 - GD. For scaling down avatar images.
 - mbstring. For handling Unicode (UTF-8) encoded strings.
-- gettext. For multiple languages. Default on many PHP installs.
 
 For some functionality, you will also need the following extensions:
 
@@ -144,6 +164,8 @@ For some functionality, you will also need the following extensions:
   Sphinx server to serve the search queries.
 - bcmath or gmp. For Salmon signatures (part of OStatus). Needed
   if you have OStatus configured.
+- gettext. For multiple languages. Default on many PHP installs;
+  will be emulated if not present.
 
 You will almost definitely get 2-3 times better performance from your
 site if you install a PHP bytecode cache/accelerator. Some well-known
@@ -213,9 +235,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.2.tar.gz
+       tar zxf statusnet-0.9.6.tar.gz
 
-   ...which will make a statusnet-0.9.2 subdirectory in your current
+   ...which will make a statusnet-0.9.6 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.)
@@ -223,7 +245,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.2 /var/www/statusnet
+       mv statusnet-0.9.6 /var/www/statusnet
 
    This will make your StatusNet instance available in the statusnet path of
    your server, like "http://example.net/statusnet". "microblog" or
@@ -582,7 +604,7 @@ 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:
-you can use the Web interface at TranslateWiki.net 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.
 
@@ -638,7 +660,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.2. Try these step-by-step
+upgrade procedure in StatusNet 0.9.6. 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
@@ -659,10 +681,11 @@ 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.2 tarball and move it to "statusnet" or
+7. Unpack your StatusNet 0.9.6 tarball and move it to "statusnet" or
    wherever your code used to be.
-8. Copy the config.php file and avatar directory from your old
-   directory to your new directory.
+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
@@ -830,6 +853,8 @@ notice: A plain string that will appear on every page. A good place
     be escaped.
 logo: URL of an image file to use as the logo for the site. Overrides
     the logo in the theme, if any.
+ssllogo: URL of an image file to use as the logo on SSL pages. If unset,
+    theme logo is used instead.
 ssl: Whether to use SSL and https:// URLs for some or all pages.
     Possible values are 'always' (use it for all pages), 'never'
     (don't use it for any pages), or 'sometimes' (use it for
@@ -1089,6 +1114,9 @@ path: Path part of theme URLs, before the theme name. Relative to the
     which means to use the site path + '/theme'.
 ssl: Whether to use SSL for theme elements. Default is null, which means
     guess based on site SSL settings.
+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.
 
 javascript
 ----------
@@ -1100,6 +1128,9 @@ path: Path part of Javascript URLs. Defaults to null,
     which means to use the site path + '/js/'.
 ssl: Whether to use SSL for JavaScript files. Default is null, which means
     guess based on site SSL settings.
+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.
 
 xmpp
 ----
@@ -1327,6 +1358,11 @@ ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
 filecommand: command to use for determining the type of a file. May be
     skipped if fileinfo extension is installed. Defaults to
     '/usr/bin/file'.
+sslserver: if specified, this server will be used when creating HTTPS
+    URLs. Otherwise, the site SSL server will be used, with /file/ path.
+sslpath: if this and the sslserver are specified, this path will be used
+    when creating HTTPS URLs. Otherwise, the attachments|path value
+    will be used.
 
 group
 -----
@@ -1383,8 +1419,9 @@ dir: directory to write backgrounds too. Default is '/background/'
     subdir of install dir.
 path: path to backgrounds. Default is sub-path of install path; note
     that you may need to change this if you change site-path too.
-ssl: Whether or not to use HTTPS for background files. Defaults to
-    null, meaning to guess from site-wide SSL settings.
+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.
 
 ping
 ----
@@ -1449,7 +1486,8 @@ 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.
+nickname: nickname of the single user. If no nickname is specified,
+          the site owner account will be used (if present).
 
 robotstxt
 ---------
@@ -1465,6 +1503,33 @@ disallow: Array of (virtual) directories to disallow. Default is 'main',
     'search', 'message', 'settings', 'admin'. Ignored when site
     is private, in which case the entire site ('/') is disallowed.
 
+api
+---
+
+Options for the Twitter-like API.
+
+realm: HTTP Basic Auth realm (see http://tools.ietf.org/html/rfc2617
+    for details). Some third-party tools like ping.fm want this to be
+    'Identi.ca API', so set it to that if you want to. default = null,
+    meaning 'something based on the site name'.
+
+nofollow
+--------
+
+We optionally put 'rel="nofollow"' on some links in some pages. The
+following configuration settings let you fine-tune how or when things
+are nofollowed. See http://en.wikipedia.org/wiki/Nofollow for more
+information on what 'nofollow' means.
+
+subscribers: whether to nofollow links to subscribers on the profile
+    and personal pages. Default is true.
+members: links to members on the group page. Default true.
+peopletag: links to people listed in the peopletag page. Default true.
+external: external links in notices. One of three values: 'sometimes',
+    'always', 'never'. If 'sometimes', then external links are not
+    nofollowed on profile, notice, and favorites page. Default is
+    'sometimes'.
+
 Plugins
 =======
 
@@ -1522,7 +1587,7 @@ repository (see below), and you get a compilation error ("unexpected
 T_STRING") in the browser, check to see that you don't have any
 conflicts in your code.
 
-If you upgraded to StatusNet 0.9.2 without reading the "Notice
+If you upgraded to StatusNet 0.9.x without reading the "Notice
 inboxes" section above, and all your users' 'Personal' tabs are empty,
 read the "Notice inboxes" section above.
 
@@ -1633,6 +1698,10 @@ if anyone's been overlooked in error.
 * mEDI
 * Brett Taylor
 * Brigitte Schuster
+* Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
+* Brion Vibber, StatusNet, Inc.
+* James Walker, StatusNet, Inc.
+* Samantha Doherty, designer, StatusNet, Inc.
 
 Thanks also to the developers of our upstream library code and to the
 thousands of people who have tried out Identi.ca, installed StatusNet,