README 9.46 KB
Newer Older
1 2 3 4
------
README
------

Evan Prodromou's avatar
Evan Prodromou committed
5
StatusNet 1.0.0beta2
6
2 August 2011
7

Evan Prodromou's avatar
Evan Prodromou committed
8 9 10 11
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
12 13 14 15 16
"doc" subdirectory or in the "help" section on-line.

About
=====

Evan Prodromou's avatar
Evan Prodromou committed
17
StatusNet is a Free and Open Source social networking platform. It helps
Evan Prodromou's avatar
Evan Prodromou committed
18 19 20 21 22
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.
23 24 25 26 27

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.

Evan Prodromou's avatar
Evan Prodromou committed
28 29 30 31
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.
32

Evan Prodromou's avatar
Evan Prodromou committed
33
StatusNet was originally developed for the Open Software Service,
34
Identi.ca <http://identi.ca/>. It is shared with you in hope that you
35
too make an Open Software Service available to your users. To learn
36
more, please see the Open Software Service Definition 1.1:
37

38
    http://www.opendefinition.org/ossd
39

40
StatusNet, Inc. <http://status.net/> also offers this software as a
41 42
Web service, requiring no installation on your part. See
<http://status.net/signup> for details. The software run
43 44 45 46
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.

47 48 49 50
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.

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
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
Evan Prodromou's avatar
Evan Prodromou committed
70
    you make modifications to the StatusNet source code on your server,
71 72 73
    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
74
    modifications, *YOU MAY NOT INSTALL STATUSNET*.
75

76 77 78 79
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.

80
CSS and images in the /theme/ directory are available under the
Evan Prodromou's avatar
Evan Prodromou committed
81 82
Creative Commons Attribution 3.0 Unported license, with attribution to
"StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
83 84 85 86 87 88 89

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.

Evan Prodromou's avatar
Evan Prodromou committed
90 91 92 93 94 95 96 97 98
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
================

Evan Prodromou's avatar
Evan Prodromou committed
99 100
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
101
below are recommended to upgrade to 0.9.9 immediately.
Evan Prodromou's avatar
Evan Prodromou committed
102

Evan Prodromou's avatar
Evan Prodromou committed
103 104
Notable changes this version:

Evan Prodromou's avatar
Evan Prodromou committed
105 106 107 108 109 110 111 112 113 114 115
- 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.

116 117 118 119
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.
Evan Prodromou's avatar
Evan Prodromou committed
120

121 122 123
Troubleshooting
===============

Evan Prodromou's avatar
Evan Prodromou committed
124
The primary output for StatusNet is syslog, unless you configured a
Evan Prodromou's avatar
Evan Prodromou committed
125
separate logfile. This is probably the first place to look if you're
Evan Prodromou's avatar
Evan Prodromou committed
126
getting weird behaviour from StatusNet.
Evan Prodromou's avatar
Evan Prodromou committed
127

Evan Prodromou's avatar
Evan Prodromou committed
128
If you're tracking the unstable version of StatusNet in the git
Evan Prodromou's avatar
Evan Prodromou committed
129 130 131
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.
132

Brion Vibber's avatar
Brion Vibber committed
133
If you upgraded to StatusNet 0.9.x without reading the "Notice
134 135
inboxes" section above, and all your users' 'Personal' tabs are empty,
read the "Notice inboxes" section above.
Evan Prodromou's avatar
Evan Prodromou committed
136

137 138 139
Myths
=====

Evan Prodromou's avatar
Evan Prodromou committed
140 141
These are some myths you may see on the Web about StatusNet.
Documentation from the core team about StatusNet has been pretty
142 143 144 145 146 147 148 149
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.
Evan Prodromou's avatar
Evan Prodromou committed
150

151 152
- "Edit dataobject.ini with the following settings..." dataobject.ini
  is a development file for the DB_DataObject framework and is not
Evan Prodromou's avatar
Evan Prodromou committed
153
  used by the running software. It was removed from the StatusNet
154 155 156 157 158
  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.

Evan Prodromou's avatar
Evan Prodromou committed
159 160 161 162
Unstable version
================

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

166
    git clone git@gitorious.org:statusnet/mainline.git
167 168 169 170 171 172 173 174

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.
Evan Prodromou's avatar
Evan Prodromou committed
175

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

Evan Prodromou's avatar
Evan Prodromou committed
178 179 180
Further information
===================

Evan Prodromou's avatar
Evan Prodromou committed
181
There are several ways to get more information about StatusNet.
Evan Prodromou's avatar
Evan Prodromou committed
182

Evan Prodromou's avatar
Evan Prodromou committed
183
* There is a mailing list for StatusNet developers and admins at
184 185
  http://mail.status.net/mailman/listinfo/statusnet-dev
* The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
186 187
* The StatusNet wiki, http://status.net/wiki/
* The StatusNet blog, http://status.net/blog/
188
* The StatusNet status update, <http://status.status.net/> (!)
Evan Prodromou's avatar
Evan Prodromou committed
189 190 191 192

Feedback
========

Evan Prodromou's avatar
Evan Prodromou committed
193 194
* Messages to http://support.status.net/ are very welcome.
* The group http://identi.ca/group/statusnet is a good
195
  place to discuss the software.
196 197
* StatusNet has a bug tracker for any defects you may find, or ideas for
  making things better. http://status.net/bugs
Evan Prodromou's avatar
Evan Prodromou committed
198

199 200
Credits
=======
Evan Prodromou's avatar
Evan Prodromou committed
201 202

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

206 207 208 209 210 211
* 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.
Evan Prodromou's avatar
Evan Prodromou committed
212 213 214 215 216 217 218 219 220 221
* Ciaran Gultnieks
* Michael Landers
* Ori Avtalion
* Garret Buell
* Mike Cochrane
* Matthew Gregg
* Florian Biree
* Erik Stambaugh
* 'drry'
* Gina Haeussge
Evan Prodromou's avatar
Evan Prodromou committed
222
* Tryggvi Björgvinsson
Evan Prodromou's avatar
Evan Prodromou committed
223 224 225 226
* Adrian Lang
* Ori Avtalion
* Meitar Moscovitz
* Ken Sheppardson (Trac server, man-about-town)
227
* Tiago 'gouki' Faria (i18n manager)
228
* Sean Murphy
229 230 231
* Leslie Michael Orchard
* Eric Helgeson
* Ken Sedgwick
232 233
* Brian Hendrickson
* Tobias Diekershoff
234 235
* Dan Moore
* Fil
236 237 238 239
* Jeff Mitchell
* Brenda Wallace
* Jeffery To
* Federico Marani
240
* Craig Andrews
Evan Prodromou's avatar
Evan Prodromou committed
241
* mEDI
Evan Prodromou's avatar
Evan Prodromou committed
242
* Brett Taylor
243
* Brigitte Schuster
244
* Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
Brion Vibber's avatar
Brion Vibber committed
245 246 247
* Brion Vibber, StatusNet, Inc.
* James Walker, StatusNet, Inc.
* Samantha Doherty, designer, StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
248

Evan Prodromou's avatar
Evan Prodromou committed
249
Thanks also to the developers of our upstream library code and to the
250
thousands of people who have tried out Identi.ca, installed StatusNet,
Evan Prodromou's avatar
Evan Prodromou committed
251 252
told their friends, and built the Open Microblogging network to what
it is today.