616 July 2013
8This is the README file for StatusNet, the Open Source social
9networking platform. It includes general information about the
10software and the project.
12Some other files to review:
14- INSTALL: instructions on how to install the software.
15- UPGRADE: upgrading from earlier versions
16- CONFIGURE: configuration options in gruesome detail.
17- PLUGINS.txt: how to install and configure plugins.
18- EVENTS.txt: events supported by the plugin system
19- COPYING: full text of the software license
21Information on using StatusNet can be found in the "doc" subdirectory
22or in the "help" section on-line.
27StatusNet is a Free and Open Source social networking platform. It
28helps people in a community, company or group to exchange short status
29updates, do polls, announce events, or other social activities (and
30you can add more!). Users can choose which people to "follow" and
31receive only their friends' or colleagues' status messages. It
32provides a similar service to sites like Twitter, Google+, Facebook or
33Yammer, but is much more awesome.
35With a little work, status messages can be sent to mobile phones,
36instant messenger programs (GTalk/Jabber), and specially-designed
37desktop clients that support the Twitter API.
39StatusNet supports an open standard called OStatus
40<http://ostatus.org/> that lets users in different networks follow
41each other. It enables a distributed social network spread all across
44StatusNet was originally developed for the Open Software Service,
45Identi.ca <http://identi.ca/>. It is shared with you in hope that you
46too make an Open Software Service available to your users. To learn
47more, please see the Open Software Service Definition 1.1:
51StatusNet, Inc. <http://status.net/> also offers this software as a
52Web service, requiring no installation on your part. See
53<http://status.net/signup> for details. The software run
54on status.net is identical to the software available for download, so
55you can move back and forth between a hosted version or a version
56installed on your own servers.
58A commercial software subscription is available from StatusNet Inc. It
59includes 24-hour technical support and developer support. More
60information at http://status.net/contact or email email@example.com.
65This program is free software: you can redistribute it and/or modify
66it under the terms of the GNU Affero General Public License as
67published by the Free Software Foundation, either version 3 of the
68License, or (at your option) any later version.
70This program is distributed in the hope that it will be useful, but
71WITHOUT ANY WARRANTY; without even the implied warranty of
72MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
73Affero General Public License for more details.
75You should have received a copy of the GNU Affero General Public
76License along with this program, in the file "COPYING". If not, see
79 IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
80 *different requirements* from the "regular" GPL. In particular, if
81 you make modifications to the StatusNet source code on your server,
82 you *MUST MAKE AVAILABLE* the modified version of the source code
83 to your users under the same license. This is a legal requirement
84 of using the software, and if you do not wish to share your
85 modifications, *YOU MAY NOT INSTALL STATUSNET*.
87Documentation in the /doc-src/ directory is available under the
88Creative Commons Attribution 3.0 Unported license, with attribution to
89"StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
91CSS and images in the /theme/ directory are available under the
92Creative Commons Attribution 3.0 Unported license, with attribution to
93"StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
95Our understanding and intention is that if you add your own theme that
96uses only CSS and images, those files are not subject to the copyleft
97requirements of the Affero General Public License 3.0. See
98http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
99legal advice; consult your lawyer.
101Additional library software has been made available in the 'extlib'
102directory. All of it is Free Software and can be distributed under
103liberal terms, but those terms may differ in detail from the AGPL's
104particulars. See each package's license file in the extlib directory
105for additional terms.
107New this version
110This is a security fix and bug fix release since 1.1.0,
111released 2 July 2012. All 1.1.0 sites should upgrade to this version.
113It includes the following changes:
115- Fixes for SQL injection errors in profile lists.
116- Improved ActivityStreams JSON representation of activities and objects.
117- Upgrade to the Twitter 1.1 API.
118- More robust handling of errors in distribution.
119- Fix error in OStatus subscription for remote groups.
120- Fix error in XMPP distribution.
122A full changelog is available at http://status.net/wiki/StatusNet_1.1.1.
127The primary output for StatusNet is syslog, unless you configured a
128separate logfile. This is probably the first place to look if you're
129getting weird behaviour from StatusNet.
131If you're tracking the unstable version of StatusNet in the git
132repository (see below), and you get a compilation error ("unexpected
133T_STRING") in the browser, check to see that you don't have any
134conflicts in your code.
139If you're adventurous or impatient, you may want to install the
140development version of StatusNet. To get it, use the git version
141control tool <http://git-scm.com/> like so:
143 git clone firstname.lastname@example.org:statusnet/mainline.git
145This is the version of the software that runs on Identi.ca and the
146status.net hosted service. Using it is a mixed bag. On the positive
147side, it usually includes the latest security and bug fix patches. On
148the downside, it may also include changes that require admin
149intervention (like running a script or even raw SQL!) that may not be
150documented yet. It may be a good idea to test this version before
151installing it on your production machines.
153To keep it up-to-date, use 'git pull'. Watch for conflicts!
158There are several ways to get more information about StatusNet.
160* There is a mailing list for StatusNet developers and admins at
162* The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
163* The StatusNet wiki, http://status.net/wiki/
164* The StatusNet blog, http://status.net/blog/
165* The StatusNet status update, <http://status.status.net/> (!)
170* Messages to http://support.status.net/ are very welcome.
171* The group http://identi.ca/group/statusnet is a good
172 place to discuss the software.
173* StatusNet has a bug tracker for any defects you may find, or ideas for
174 making things better. http://status.net/open-source/issues
175* The StatusNet forum is at http://forum.status.net/.
180The following is an incomplete list of developers who've worked on
181StatusNet. Apologies for any oversight; please let email@example.com know
182if anyone's been overlooked in error.
184* Evan Prodromou, founder and lead developer, StatusNet, Inc.
185* Zach Copley, StatusNet, Inc.
186* Earle Martin, StatusNet, Inc.
187* Marie-Claude Doyon, designer, StatusNet, Inc.
188* Sarven Capadisli, StatusNet, Inc.
189* Robin Millette, StatusNet, Inc.
190* Ciaran Gultnieks
191* Michael Landers
192* Ori Avtalion
193* Garret Buell
194* Mike Cochrane
195* Matthew Gregg
196* Florian Biree
197* Erik Stambaugh
199* Gina Haeussge
200* Tryggvi Björgvinsson
201* Adrian Lang
202* Ori Avtalion
203* Meitar Moscovitz
204* Ken Sheppardson (Trac server, man-about-town)
205* Tiago 'gouki' Faria (i18n manager)
206* Sean Murphy
207* Leslie Michael Orchard
208* Eric Helgeson
209* Ken Sedgwick
210* Brian Hendrickson
211* Tobias Diekershoff
212* Dan Moore
214* Jeff Mitchell
215* Brenda Wallace
216* Jeffery To
217* Federico Marani
218* Craig Andrews
220* Brett Taylor
221* Brigitte Schuster
222* Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
223* Brion Vibber, StatusNet, Inc.
224* James Walker, StatusNet, Inc.
225* Samantha Doherty, designer, StatusNet, Inc.
227Thanks also to the developers of our upstream library code and to the
228thousands of people who have tried out Identi.ca, installed StatusNet,
229told their friends, and built the Open Microblogging network to what
230it is today.