Go to file
2011-08-26 11:39:06 -04:00
actions * Update copyright in version info 2011-08-25 16:33:41 -07:00
avatar Disable the send-notice form at the top of the page OStatus subscription confirmation page to work around bugs in Cloudy theme. 2010-04-19 19:45:01 +02:00
background Add background dir 2009-06-16 19:23:06 -07:00
classes explicit join for subscribers to a profile list 2011-08-26 11:39:06 -04:00
db Merge branch '1.0.x' into activity 2011-08-22 19:02:16 -04:00
doc-src Capitalization 2011-04-15 21:19:30 +00:00
extlib Squashed commit of the following: 2011-07-15 12:13:57 -07:00
file Add some .gitignore files to keep the dirs available 2009-01-06 16:24:09 -05:00
js forgot to cat a bunch of useless separate files when minifying 2011-07-08 10:04:31 -04:00
lib Explicit joins for people tags 2011-08-26 11:38:39 -04:00
local Add local directory for plugins, themes, etc. 2009-03-07 11:56:01 -08:00
locale Localisation updates from http://translatewiki.net. 2011-08-20 21:30:04 +02:00
mail-src better indenting in invite email 2011-04-18 13:37:54 -04:00
plugins Merge branch '1.0.x' of gitorious.org:statusnet/mainline into 1.0.x 2011-08-25 18:03:30 -04:00
scripts remove obsolete sitemap script 2011-08-23 13:31:47 -04:00
tests Move AtomPubClient to its own module 2011-07-25 23:15:32 -04:00
theme Style for header search form. 2011-08-25 22:30:09 -04:00
tpl fix up tpl/index.php so doesn't throw errors on hosts with php shorttags on 2009-08-25 09:14:43 +12:00
.gitignore Added a couple dirs to .gitignore 2011-06-29 18:59:42 +00:00
apple-touch-icon.png Add apple-touch-icon.png support; favicons for the iPhone OS. 2009-03-16 18:04:27 -04:00
config.php.sample Change a few things around for CORS header output 2011-07-07 17:19:59 -07:00
CONFIGURE split gigantic README into separate files 2011-08-22 18:28:50 -04:00
COPYING license block for source code 2008-05-14 15:26:48 -04:00
EVENTS.txt Fancier invitation form for whitelisted domains 2011-05-09 17:07:36 -07:00
favicon.ico Updating favicon. 2011-03-10 23:57:29 -05:00
htaccess.sample And clarify a little more 2010-03-25 12:48:31 -07:00
index.php issue #3261 -- fix generic exception handler to pass through generic exception info, as already done for exceptions happening within an action. This fixes things like addPlugin() failures being hidden with a generic message. 2011-07-26 15:56:04 -07:00
INSTALL split gigantic README into separate files 2011-08-22 18:28:50 -04:00
install.php Fix install page layout. 2011-07-26 15:19:50 -04:00
lighttpd.conf.example Enable 404-based rewrites for lighttpd installations in / 2009-08-04 01:24:28 +01:00
Makefile New _m() gettext wrapper with smart detection of plugin domains. Plugin base class registers your gettext files if present at initialization. 2009-12-08 12:17:11 -08:00
PLUGINS.txt Rename plugins README so it doesn't conflict with plugins directory on case insensitive files systems (Mac/Windows) 2011-08-23 09:49:32 -07:00
README split gigantic README into separate files 2011-08-22 18:28:50 -04:00
UPGRADE split gigantic README into separate files 2011-08-22 18:28:50 -04:00

------
README
------

StatusNet 1.0.0beta2
2 August 2011

This is the README file for StatusNet, the Open Source social
networking platform. It includes installation instructions,
descriptions of options you can set, warnings, tips, and general info
for administrators. Information on using StatusNet can be found in the
"doc" subdirectory or in the "help" section on-line.

About
=====

StatusNet is a Free and Open Source social networking platform. It helps
people in a community, company or group to exchange short (140
characters, by default) messages over the Web. Users can choose which
people to "follow" and receive only their friends' or colleagues'
status messages. It provides a similar service to sites like Twitter,
Google Buzz, or Yammer.

With a little work, status messages can be sent to mobile phones,
instant messenger programs (GTalk/Jabber), and specially-designed
desktop clients that support the Twitter API.

StatusNet supports an open standard called OStatus
<http://ostatus.org/> that lets users in different networks follow
each other. It enables a distributed social network spread all across
the Web.

StatusNet was originally developed for the Open Software Service,
Identi.ca <http://identi.ca/>. It is shared with you in hope that you
too make an Open Software Service available to your users. To learn
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. 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
=======

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public
License along with this program, in the file "COPYING".  If not, see
<http://www.gnu.org/licenses/>.

    IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
    *different requirements* from the "regular" GPL. In particular, if
    you make modifications to the StatusNet source code on your server,
    you *MUST MAKE AVAILABLE* the modified version of the source code
    to your users under the same license. This is a legal requirement
    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
particulars. See each package's license file in the extlib directory
for additional terms.

New this version
================

This is a security release since version 0.9.7 released on 11 March
2011. It fixes security bug #3260. All sites running version 0.9.7 or
below are recommended to upgrade to 0.9.9 immediately.

Notable changes this version:

- Fix bug #3260, a cross-site scripting (XSS) bug that allows an
  attacker to inject JavaScript into a page with a carefully structured URL.
- Updated code for Google Analytics to reflect new API.
- Various fixes for Bookmark plugin.
- Updates to reCAPTCHA plugin based on changes to API.
- New plugin to move the site notice to the sidebar.
- Add rss.me to notice source list.
- Updates to data backup/restore.
- Correct use of "likes" in Facebook plugin.
- Ignore failures in Twitter plugin.

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

NOTE: The short-lived StatusNet 0.9.8 ("Letter Never Sent") did not
adequately fix bug #3260 as originally thought; thus this new release.

Troubleshooting
===============

The primary output for StatusNet is syslog, unless you configured a
separate logfile. This is probably the first place to look if you're
getting weird behaviour from StatusNet.

If you're tracking the unstable version of StatusNet in the git
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.x without reading the "Notice
inboxes" section above, and all your users' 'Personal' tabs are empty,
read the "Notice inboxes" section above.

Myths
=====

These are some myths you may see on the Web about StatusNet.
Documentation from the core team about StatusNet has been pretty
sparse, so some backtracking and guesswork resulted in some incorrect
assumptions.

- "Set $config['db']['debug'] = 5 to debug the database." This is an
  extremely bad idea. It's a tool built into DB_DataObject that will
  emit oodles of print lines directly to the browser of your users.
  Among these lines will be your database username and password. Do
  not enable this option on a production Web site for any reason.

- "Edit dataobject.ini with the following settings..." dataobject.ini
  is a development file for the DB_DataObject framework and is not
  used by the running software. It was removed from the StatusNet
  distribution because its presence was confusing. Do not bother
  configuring dataobject.ini, and do not put your database username
  and password into the file on a production Web server; unscrupulous
  persons may try to read it to get your passwords.

Unstable version
================

If you're adventurous or impatient, you may want to install the
development version of StatusNet. To get it, use the git version
control tool <http://git-scm.com/> like so:

    git clone git@gitorious.org:statusnet/mainline.git

This is the version of the software that runs on Identi.ca and the
status.net hosted service. Using it is a mixed bag. On the positive
side, it usually includes the latest security and bug fix patches. On
the downside, it may also include changes that require admin
intervention (like running a script or even raw SQL!) that may not be
documented yet. It may be a good idea to test this version before
installing it on your production machines.

To keep it up-to-date, use 'git pull'. Watch for conflicts!

Further information
===================

There are several ways to get more information about StatusNet.

* There is a mailing list for StatusNet developers and admins at
  http://mail.status.net/mailman/listinfo/statusnet-dev
* The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
* The StatusNet wiki, http://status.net/wiki/
* The StatusNet blog, http://status.net/blog/
* The StatusNet status update, <http://status.status.net/> (!)

Feedback
========

* Messages to http://support.status.net/ are very welcome.
* The group http://identi.ca/group/statusnet is a good
  place to discuss the software.
* StatusNet has a bug tracker for any defects you may find, or ideas for
  making things better. http://status.net/bugs

Credits
=======

The following is an incomplete list of developers who've worked on
StatusNet. Apologies for any oversight; please let evan@status.net know
if anyone's been overlooked in error.

* Evan Prodromou, founder and lead developer, StatusNet, Inc.
* Zach Copley, StatusNet, Inc.
* Earle Martin, StatusNet, Inc.
* Marie-Claude Doyon, designer, StatusNet, Inc.
* Sarven Capadisli, StatusNet, Inc.
* Robin Millette, StatusNet, Inc.
* Ciaran Gultnieks
* Michael Landers
* Ori Avtalion
* Garret Buell
* Mike Cochrane
* Matthew Gregg
* Florian Biree
* Erik Stambaugh
* 'drry'
* Gina Haeussge
* Tryggvi Björgvinsson
* Adrian Lang
* Ori Avtalion
* Meitar Moscovitz
* Ken Sheppardson (Trac server, man-about-town)
* Tiago 'gouki' Faria (i18n manager)
* Sean Murphy
* Leslie Michael Orchard
* Eric Helgeson
* Ken Sedgwick
* Brian Hendrickson
* Tobias Diekershoff
* Dan Moore
* Fil
* Jeff Mitchell
* Brenda Wallace
* Jeffery To
* Federico Marani
* Craig Andrews
* 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,
told their friends, and built the Open Microblogging network to what
it is today.