update README for 1.0.0 golden
[statusnet:freesocial.git] / README
1 ------
2 README
3 ------
4
5 StatusNet 1.0.0
6 30 September 2011
7
8 This is the README file for StatusNet, the Open Source social
9 networking platform. It includes general information about the
10 software and the project.
11
12 Some other files to review:
13
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
20
21 Information on using StatusNet can be found in the "doc" subdirectory
22 or in the "help" section on-line.
23
24 About
25 =====
26
27 StatusNet is a Free and Open Source social networking platform. It
28 helps people in a community, company or group to exchange short status
29 updates, do polls, announce events, or other social activities (and
30 you can add more!). Users can choose which people to "follow" and
31 receive only their friends' or colleagues' status messages. It
32 provides a similar service to sites like Twitter, Google+, Facebook or
33 Yammer, but is much more awesome.
34
35 With a little work, status messages can be sent to mobile phones,
36 instant messenger programs (GTalk/Jabber), and specially-designed
37 desktop clients that support the Twitter API.
38
39 StatusNet supports an open standard called OStatus
40 <http://ostatus.org/> that lets users in different networks follow
41 each other. It enables a distributed social network spread all across
42 the Web.
43
44 StatusNet was originally developed for the Open Software Service,
45 Identi.ca <http://identi.ca/>. It is shared with you in hope that you
46 too make an Open Software Service available to your users. To learn
47 more, please see the Open Software Service Definition 1.1:
48
49     http://www.opendefinition.org/ossd
50
51 StatusNet, Inc. <http://status.net/> also offers this software as a
52 Web service, requiring no installation on your part. See
53 <http://status.net/signup> for details. The software run
54 on status.net is identical to the software available for download, so
55 you can move back and forth between a hosted version or a version
56 installed on your own servers.
57
58 A commercial software subscription is available from StatusNet Inc. It
59 includes 24-hour technical support and developer support. More
60 information at http://status.net/contact or email sales@status.net.
61
62 License
63 =======
64
65 This program is free software: you can redistribute it and/or modify
66 it under the terms of the GNU Affero General Public License as
67 published by the Free Software Foundation, either version 3 of the
68 License, or (at your option) any later version.
69
70 This program is distributed in the hope that it will be useful, but
71 WITHOUT ANY WARRANTY; without even the implied warranty of
72 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
73 Affero General Public License for more details.
74
75 You should have received a copy of the GNU Affero General Public
76 License along with this program, in the file "COPYING".  If not, see
77 <http://www.gnu.org/licenses/>.
78
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*.
86
87 Documentation in the /doc-src/ directory is available under the
88 Creative Commons Attribution 3.0 Unported license, with attribution to
89 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
90
91 CSS and images in the /theme/ directory are available under the
92 Creative Commons Attribution 3.0 Unported license, with attribution to
93 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
94
95 Our understanding and intention is that if you add your own theme that
96 uses only CSS and images, those files are not subject to the copyleft
97 requirements of the Affero General Public License 3.0. See
98 http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
99 legal advice; consult your lawyer.
100
101 Additional library software has been made available in the 'extlib'
102 directory. All of it is Free Software and can be distributed under
103 liberal terms, but those terms may differ in detail from the AGPL's
104 particulars. See each package's license file in the extlib directory
105 for additional terms.
106
107 New this version
108 ================
109
110 This is a major feature release since 0.9.9, released 2 August
111 2011. It is the first release of the new branch of StatusNet, and the
112 first release in the 1.x timeline.
113
114 Notable changes this version:
115
116 - Support for private updates, including private-to-groups, private
117   within a site, and private to followers only.
118 - Conversation mode in streams; notices appear along with all replies.
119 - Microapps -- post different types of activities to timelines, with
120   interaction. Events, bookmarks, Q&A, and polls included by default.
121 - New 3-column layout in 'neo' theme by default. Older, 2-column layout
122   themes have been removed.
123 - Alphabetical, searchable user directory.
124 - Alphabetical, searchable group directory.
125 - Groups can require all posts to be private ('private groups'), and
126   limit members to the group.
127 - Users can make all posts private to their followers ('private stream'),
128   and require authorization to follow.
129 - General plugin for IM support; added AIM, IRC and MSN to existing
130   XMPP code.
131 - Support for Twitter-like lists, to follow other users without 
132   interfering with the home timeline.
133 - Subscription to searches.
134 - Subscription to tags.
135 - Drupal-style schema system ("schemax") allows in-place database
136   upgrades from various software versions.
137 - Fine-grained control of URL shortening, and an internal URL shortener
138   available.
139 - Extended profile for private, enterprise sites.
140 - sites are private by default.
141 - Blog plugin for extended posts.
142 - Plugin to restrict all users of a site to a single email domain.
143 - Plugin to send a daily email summary to site users.
144 - Deeper integration with Activity Streams (http://activitystrea.ms) format.
145 - Automated upgrade script.
146
147 A full changelog is available at http://status.net/wiki/StatusNet_1.0.0.
148
149 Troubleshooting
150 ===============
151
152 The primary output for StatusNet is syslog, unless you configured a
153 separate logfile. This is probably the first place to look if you're
154 getting weird behaviour from StatusNet.
155
156 If you're tracking the unstable version of StatusNet in the git
157 repository (see below), and you get a compilation error ("unexpected
158 T_STRING") in the browser, check to see that you don't have any
159 conflicts in your code.
160
161 Unstable version
162 ================
163
164 If you're adventurous or impatient, you may want to install the
165 development version of StatusNet. To get it, use the git version
166 control tool <http://git-scm.com/> like so:
167
168     git clone git@gitorious.org:statusnet/mainline.git
169
170 This is the version of the software that runs on Identi.ca and the
171 status.net hosted service. Using it is a mixed bag. On the positive
172 side, it usually includes the latest security and bug fix patches. On
173 the downside, it may also include changes that require admin
174 intervention (like running a script or even raw SQL!) that may not be
175 documented yet. It may be a good idea to test this version before
176 installing it on your production machines.
177
178 To keep it up-to-date, use 'git pull'. Watch for conflicts!
179
180 Further information
181 ===================
182
183 There are several ways to get more information about StatusNet.
184
185 * There is a mailing list for StatusNet developers and admins at
186   http://mail.status.net/mailman/listinfo/statusnet-dev
187 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
188 * The StatusNet wiki, http://status.net/wiki/
189 * The StatusNet blog, http://status.net/blog/
190 * The StatusNet status update, <http://status.status.net/> (!)
191
192 Feedback
193 ========
194
195 * Messages to http://support.status.net/ are very welcome.
196 * The group http://identi.ca/group/statusnet is a good
197   place to discuss the software.
198 * StatusNet has a bug tracker for any defects you may find, or ideas for
199   making things better. http://status.net/open-source/issues
200 * The StatusNet forum is at http://forum.status.net/.
201
202 Credits
203 =======
204
205 The following is an incomplete list of developers who've worked on
206 StatusNet. Apologies for any oversight; please let evan@status.net know
207 if anyone's been overlooked in error.
208
209 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
210 * Zach Copley, StatusNet, Inc.
211 * Earle Martin, StatusNet, Inc.
212 * Marie-Claude Doyon, designer, StatusNet, Inc.
213 * Sarven Capadisli, StatusNet, Inc.
214 * Robin Millette, StatusNet, Inc.
215 * Ciaran Gultnieks
216 * Michael Landers
217 * Ori Avtalion
218 * Garret Buell
219 * Mike Cochrane
220 * Matthew Gregg
221 * Florian Biree
222 * Erik Stambaugh
223 * 'drry'
224 * Gina Haeussge
225 * Tryggvi Bj√∂rgvinsson
226 * Adrian Lang
227 * Ori Avtalion
228 * Meitar Moscovitz
229 * Ken Sheppardson (Trac server, man-about-town)
230 * Tiago 'gouki' Faria (i18n manager)
231 * Sean Murphy
232 * Leslie Michael Orchard
233 * Eric Helgeson
234 * Ken Sedgwick
235 * Brian Hendrickson
236 * Tobias Diekershoff
237 * Dan Moore
238 * Fil
239 * Jeff Mitchell
240 * Brenda Wallace
241 * Jeffery To
242 * Federico Marani
243 * Craig Andrews
244 * mEDI
245 * Brett Taylor
246 * Brigitte Schuster
247 * Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
248 * Brion Vibber, StatusNet, Inc.
249 * James Walker, StatusNet, Inc.
250 * Samantha Doherty, designer, StatusNet, Inc.
251
252 Thanks also to the developers of our upstream library code and to the
253 thousands of people who have tried out Identi.ca, installed StatusNet,
254 told their friends, and built the Open Microblogging network to what
255 it is today.