README
------
-StatusNet 0.9.0 ("Stand")
-4 Mar 2010
+StatusNet 0.9.5 "What's The Frequency, Kenneth?"
+10 September 2010
This is the README file for StatusNet, the Open Source microblogging
platform. It includes installation instructions, descriptions of
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
=======
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
New this version
================
-This is a major feature release since version 0.8.3, released Feb 1
-2010. It is the final release version of 0.9.0, replacing any beta
-versions.
+This is a security, bug and feature release since version 0.9.4 released on
+16 August 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.
Notable changes this version:
-- Support for the new distributed status update standard OStatus
- <http://ostatus.org>, based on PubSubHubbub, Salmon, Webfinger,
- and Activity Streams.
-- Support for location using the Geolocation API. Notices are (optionally)
- marked with lat-long information with geo microformats, and can be shown
- on a map.
-- No fixed content size. Notice size is configurable, from 1 to
- unlimited number of characters. Default is still 140!
-- An authorization framework, allowing different levels of users.
-- A Web-based administration panel.
-- A moderation system that lets site moderators sandbox, silence,
- or delete uncooperative users.
-- A flag system that lets users flag profiles for moderator review.
-- Support for OAuth <http://oauth.net> authentication in the Twitter
- API.
-- User roles system that lets the owner of the site to assign
- administrator and moderator roles to other users.
-- A pluggable authentication system.
-- An authentication plugin for LDAP servers.
-- Many features that were core in 0.8.x are now plugins, such
- as OpenID, Twitter integration, Facebook integration
-- A much-improved offline processing system
-- In-browser "realtime" updates using a number of realtime
- servers (Meteor, Orbited, Cometd)
-- A plugin to provide an interface optimized for mobile browsers
-- Support for Facebook Connect
-- Support for logging in with a Twitter account
-- Vastly improved translation with additional languages and
- translation in plugins
-- Support for all-SSL instances
-- Core support for "repeats" (like Twitter's "retweets")
-- Pluggable caching system, with plugins for Memcached,
- APC, XCache, and a disk-based cache
-- Plugin to support RSSCloud
-- A framework for adding advertisements to a public site,
- and plugins for Google AdSense and OpenX server
-- Plugins to throttle excessive subscriptions and registrations.
-- A plugin to blacklist particular URLs or nicknames.
-
-There are also literally thousands of bugs fixed and minor features
-added. A full changelog is available at http://status.net/wiki/StatusNet_0.9.0.
-
-Under the covers, the software has a vastly improved plugin and
-extension mechanism that makes writing powerful and flexible additions
-to the core functionality much easier.
+- Change of license for default themes and documentation from
+ AGPLv3 to CC-By 3.0 Unported.
+- An experimental TinyMCE plugin to do in-browser rich editing of
+ status updates. Does not support StatusNet syntax like @-replies or
+ #hashtags very well.
+- An experimental plugin to add titles to notices.
+- A plugin to support the Echo <http://aboutecho.com/> commenting
+ system.
+- A plugin to support the Disqus <http://disqus.com/> commenting system.
+- Changes to OStatus support to make StatusNet work for the Social Web
+ Acid Test Level 0 <http://federatedsocialweb.net/wiki/SWAT0>.
+- Themes now support a theme.ini file for theme configuration, including
+ defining a "base" theme.
+- Improved two-way Twitter integration, including support for
+ repeats and retweets, replies, and faves going both ways across the
+ bridge, as well as better parsing of Twitter statuses.
+
+A full changelog is available at http://status.net/wiki/StatusNet_0.9.5.
Prerequisites
=============
- 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.
+ 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 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
- 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:
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
1. Unpack the tarball you downloaded on your Web server. Usually a
command like this will work:
- tar zxf statusnet-0.9.0.tar.gz
+ tar zxf statusnet-0.9.5.tar.gz
- ...which will make a statusnet-0.9.0 subdirectory in your current
+ ...which will make a statusnet-0.9.5 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.)
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.0 /var/www/statusnet
+ mv statusnet-0.9.5 /var/www/statusnet
This will make your StatusNet instance available in the statusnet path of
your server, like "http://example.net/statusnet". "microblog" or
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.0. Try these step-by-step
+upgrade procedure in StatusNet 0.9.5. 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
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.0 tarball and move it to "statusnet" or
+7. Unpack your StatusNet 0.9.5 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
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
to null.
stomp_persistent: keep items across queue server restart, if enabled.
+ Under ActiveMQ, the server configuration determines if and how
+ persistent storage is actually saved.
+
+ If using a message queue server other than ActiveMQ, you may
+ need to disable this if it does not support persistence.
+
+stomp_transactions: use transactions to aid in error detection.
+ A broken transaction will be seen quickly, allowing a message
+ to be redelivered immediately if a daemon crashes.
+
+ If using a message queue server other than ActiveMQ, you may
+ need to disable this if it does not support transactions.
+
+stomp_acks: send acknowledgements to aid in flow control.
+ An acknowledgement of successful processing tells the server
+ we're ready for more and can help keep things moving smoothly.
+
+ This should *not* be turned off when running with ActiveMQ, but
+ if using another message queue server that does not support
+ acknowledgements you might need to disable this.
softlimit: an absolute or relative "soft memory limit"; daemons will
restart themselves gracefully when they find they've hit
dead_letter_dir: for stomp, optional directory to dump data on failed
queue processing events after discarding them.
+stomp_no_transactions: for stomp, the server does not support transactions,
+ so do not try to user them. This is needed for http://www.morbidq.com/.
+
+stomp_no_acks: for stomp, the server does not support acknowledgements.
+ so do not try to user them. This is needed for http://www.morbidq.com/.
+
license
-------
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
----------
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
----
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
-----
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
----
'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
=======
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.0 without reading the "Notice
+If you upgraded to StatusNet 0.9.5 without reading the "Notice
inboxes" section above, and all your users' 'Personal' tabs are empty,
read the "Notice inboxes" section above.
projects / quix0rs-gnu-social.git / blobdiff