2008-09-18 22:55:02 +09:00
|
|
|
------
|
|
|
|
README
|
|
|
|
------
|
|
|
|
|
2011-09-17 04:28:11 +09:00
|
|
|
StatusNet 1.0.0beta4
|
|
|
|
16 September 2011
|
2008-09-18 22:55:02 +09:00
|
|
|
|
2011-08-03 04:12:27 +09:00
|
|
|
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
|
2008-09-18 22:55:02 +09:00
|
|
|
"doc" subdirectory or in the "help" section on-line.
|
|
|
|
|
|
|
|
About
|
|
|
|
=====
|
|
|
|
|
2011-08-03 04:12:27 +09:00
|
|
|
StatusNet is a Free and Open Source social networking platform. It helps
|
2010-03-05 03:04:22 +09:00
|
|
|
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.
|
2008-09-18 22:55:02 +09:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2010-03-05 03:04:22 +09:00
|
|
|
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.
|
2008-09-18 22:55:02 +09:00
|
|
|
|
2009-08-26 07:25:01 +09:00
|
|
|
StatusNet was originally developed for the Open Software Service,
|
2009-02-04 06:36:11 +09:00
|
|
|
Identi.ca <http://identi.ca/>. It is shared with you in hope that you
|
2008-09-18 22:55:02 +09:00
|
|
|
too make an Open Software Service available to your users. To learn
|
2009-02-04 06:36:11 +09:00
|
|
|
more, please see the Open Software Service Definition 1.1:
|
2008-09-18 22:55:02 +09:00
|
|
|
|
2010-03-05 04:18:30 +09:00
|
|
|
http://www.opendefinition.org/ossd
|
2008-09-18 22:55:02 +09:00
|
|
|
|
2009-08-28 02:00:45 +09:00
|
|
|
StatusNet, Inc. <http://status.net/> also offers this software as a
|
2010-09-10 00:26:15 +09:00
|
|
|
Web service, requiring no installation on your part. See
|
|
|
|
<http://status.net/signup> for details. The software run
|
2009-08-28 02:00:45 +09:00
|
|
|
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.
|
|
|
|
|
2010-08-13 10:42:09 +09:00
|
|
|
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.
|
|
|
|
|
2008-09-18 22:55:02 +09:00
|
|
|
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
|
2009-08-26 07:25:01 +09:00
|
|
|
you make modifications to the StatusNet source code on your server,
|
2008-09-18 22:55:02 +09:00
|
|
|
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
|
2009-08-26 16:33:43 +09:00
|
|
|
modifications, *YOU MAY NOT INSTALL STATUSNET*.
|
2008-09-18 22:55:02 +09:00
|
|
|
|
2010-09-04 04:26:25 +09:00
|
|
|
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.
|
|
|
|
|
2010-09-03 12:23:46 +09:00
|
|
|
CSS and images in the /theme/ directory are available under the
|
2010-09-03 12:41:48 +09:00
|
|
|
Creative Commons Attribution 3.0 Unported license, with attribution to
|
|
|
|
"StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
|
2010-09-03 12:23:46 +09:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2008-09-23 07:32:39 +09:00
|
|
|
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
|
|
|
|
================
|
|
|
|
|
2011-08-02 00:14:20 +09:00
|
|
|
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
|
2011-08-03 03:40:23 +09:00
|
|
|
below are recommended to upgrade to 0.9.9 immediately.
|
2010-02-02 03:44:06 +09:00
|
|
|
|
2009-12-23 09:41:07 +09:00
|
|
|
Notable changes this version:
|
|
|
|
|
2011-08-02 00:14:20 +09:00
|
|
|
- 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.
|
|
|
|
|
2011-08-03 03:40:23 +09:00
|
|
|
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.
|
2008-09-23 07:32:39 +09:00
|
|
|
|
2008-09-18 22:55:02 +09:00
|
|
|
Troubleshooting
|
|
|
|
===============
|
|
|
|
|
2009-08-26 07:25:01 +09:00
|
|
|
The primary output for StatusNet is syslog, unless you configured a
|
2008-09-23 07:32:39 +09:00
|
|
|
separate logfile. This is probably the first place to look if you're
|
2009-08-26 07:25:01 +09:00
|
|
|
getting weird behaviour from StatusNet.
|
2008-09-23 07:32:39 +09:00
|
|
|
|
2009-08-26 07:25:01 +09:00
|
|
|
If you're tracking the unstable version of StatusNet in the git
|
2008-09-23 07:32:39 +09:00
|
|
|
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.
|
2008-09-18 22:55:02 +09:00
|
|
|
|
2010-10-19 06:48:11 +09:00
|
|
|
If you upgraded to StatusNet 0.9.x without reading the "Notice
|
2009-08-28 02:00:45 +09:00
|
|
|
inboxes" section above, and all your users' 'Personal' tabs are empty,
|
|
|
|
read the "Notice inboxes" section above.
|
2008-11-14 11:57:15 +09:00
|
|
|
|
2008-09-18 22:55:02 +09:00
|
|
|
Myths
|
|
|
|
=====
|
|
|
|
|
2009-08-26 07:25:01 +09:00
|
|
|
These are some myths you may see on the Web about StatusNet.
|
|
|
|
Documentation from the core team about StatusNet has been pretty
|
2008-09-18 22:55:02 +09:00
|
|
|
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.
|
2008-12-04 03:34:32 +09:00
|
|
|
|
2008-09-18 22:55:02 +09:00
|
|
|
- "Edit dataobject.ini with the following settings..." dataobject.ini
|
|
|
|
is a development file for the DB_DataObject framework and is not
|
2009-08-26 07:25:01 +09:00
|
|
|
used by the running software. It was removed from the StatusNet
|
2008-09-18 22:55:02 +09:00
|
|
|
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.
|
|
|
|
|
2008-09-23 07:32:39 +09:00
|
|
|
Unstable version
|
|
|
|
================
|
|
|
|
|
|
|
|
If you're adventurous or impatient, you may want to install the
|
2009-08-26 07:25:01 +09:00
|
|
|
development version of StatusNet. To get it, use the git version
|
2009-02-04 06:36:11 +09:00
|
|
|
control tool <http://git-scm.com/> like so:
|
2008-09-18 22:55:02 +09:00
|
|
|
|
2010-03-05 03:57:35 +09:00
|
|
|
git clone git@gitorious.org:statusnet/mainline.git
|
2009-08-28 02:00:45 +09:00
|
|
|
|
|
|
|
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.
|
2008-12-04 03:34:32 +09:00
|
|
|
|
2009-01-07 07:39:41 +09:00
|
|
|
To keep it up-to-date, use 'git pull'. Watch for conflicts!
|
2008-09-18 22:55:02 +09:00
|
|
|
|
2008-09-23 07:32:39 +09:00
|
|
|
Further information
|
|
|
|
===================
|
|
|
|
|
2009-08-26 07:25:01 +09:00
|
|
|
There are several ways to get more information about StatusNet.
|
2008-09-23 07:32:39 +09:00
|
|
|
|
2009-08-26 07:25:01 +09:00
|
|
|
* There is a mailing list for StatusNet developers and admins at
|
2009-08-26 07:53:24 +09:00
|
|
|
http://mail.status.net/mailman/listinfo/statusnet-dev
|
|
|
|
* The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
|
2009-08-28 02:00:45 +09:00
|
|
|
* The StatusNet wiki, http://status.net/wiki/
|
|
|
|
* The StatusNet blog, http://status.net/blog/
|
2010-03-05 03:17:48 +09:00
|
|
|
* The StatusNet status update, <http://status.status.net/> (!)
|
2008-09-23 07:32:39 +09:00
|
|
|
|
|
|
|
Feedback
|
|
|
|
========
|
|
|
|
|
2011-08-03 04:12:27 +09:00
|
|
|
* Messages to http://support.status.net/ are very welcome.
|
|
|
|
* The group http://identi.ca/group/statusnet is a good
|
2010-03-05 03:17:48 +09:00
|
|
|
place to discuss the software.
|
2010-03-05 03:34:12 +09:00
|
|
|
* StatusNet has a bug tracker for any defects you may find, or ideas for
|
|
|
|
making things better. http://status.net/bugs
|
2008-06-15 11:18:52 +09:00
|
|
|
|
2008-09-18 22:55:02 +09:00
|
|
|
Credits
|
|
|
|
=======
|
2008-09-23 07:32:39 +09:00
|
|
|
|
|
|
|
The following is an incomplete list of developers who've worked on
|
2009-08-26 16:33:43 +09:00
|
|
|
StatusNet. Apologies for any oversight; please let evan@status.net know
|
2008-09-23 07:32:39 +09:00
|
|
|
if anyone's been overlooked in error.
|
|
|
|
|
2009-08-26 16:33:43 +09:00
|
|
|
* 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.
|
2008-09-23 07:32:39 +09:00
|
|
|
* Ciaran Gultnieks
|
|
|
|
* Michael Landers
|
|
|
|
* Ori Avtalion
|
|
|
|
* Garret Buell
|
|
|
|
* Mike Cochrane
|
|
|
|
* Matthew Gregg
|
|
|
|
* Florian Biree
|
|
|
|
* Erik Stambaugh
|
|
|
|
* 'drry'
|
|
|
|
* Gina Haeussge
|
2008-11-14 11:57:15 +09:00
|
|
|
* Tryggvi Björgvinsson
|
2009-01-29 13:00:26 +09:00
|
|
|
* Adrian Lang
|
|
|
|
* Ori Avtalion
|
|
|
|
* Meitar Moscovitz
|
|
|
|
* Ken Sheppardson (Trac server, man-about-town)
|
2009-07-09 04:31:42 +09:00
|
|
|
* Tiago 'gouki' Faria (i18n manager)
|
2009-02-07 05:35:29 +09:00
|
|
|
* Sean Murphy
|
2009-03-12 11:28:42 +09:00
|
|
|
* Leslie Michael Orchard
|
|
|
|
* Eric Helgeson
|
|
|
|
* Ken Sedgwick
|
2009-04-08 12:02:55 +09:00
|
|
|
* Brian Hendrickson
|
|
|
|
* Tobias Diekershoff
|
2009-05-30 05:28:39 +09:00
|
|
|
* Dan Moore
|
|
|
|
* Fil
|
2009-07-09 04:31:42 +09:00
|
|
|
* Jeff Mitchell
|
|
|
|
* Brenda Wallace
|
|
|
|
* Jeffery To
|
|
|
|
* Federico Marani
|
2009-07-11 06:46:19 +09:00
|
|
|
* Craig Andrews
|
2009-11-01 03:19:26 +09:00
|
|
|
* mEDI
|
2009-12-23 09:41:07 +09:00
|
|
|
* Brett Taylor
|
2010-01-08 19:20:51 +09:00
|
|
|
* Brigitte Schuster
|
2010-10-19 09:26:39 +09:00
|
|
|
* Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
|
2010-10-19 06:48:11 +09:00
|
|
|
* Brion Vibber, StatusNet, Inc.
|
|
|
|
* James Walker, StatusNet, Inc.
|
|
|
|
* Samantha Doherty, designer, StatusNet, Inc.
|
2008-09-23 07:32:39 +09:00
|
|
|
|
2008-11-14 11:57:15 +09:00
|
|
|
Thanks also to the developers of our upstream library code and to the
|
2009-08-26 16:33:43 +09:00
|
|
|
thousands of people who have tried out Identi.ca, installed StatusNet,
|
2008-11-14 11:57:15 +09:00
|
|
|
told their friends, and built the Open Microblogging network to what
|
|
|
|
it is today.
|