README

   1 ------
   2 README
   3 ------
   4
   5 StatusNet 1.0.1
   6 3 October 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 minor bug fix release since 1.0.0, released 30 September
 111 2011. It fixes the following bugs:
 112
 113 - Change default OEmbed provider from oohembed to noembed.
 114 - Fix problem with path matching on new installs.
 115
 116 Notable additions in the 1.0.x series:
 117
 118 - Support for private updates, including private-to-groups, private
 119   within a site, and private to followers only.
 120 - Conversation mode in streams; notices appear along with all replies.
 121 - Microapps -- post different types of activities to timelines, with
 122   interaction. Events, bookmarks, Q&A, and polls included by default.
 123 - New 3-column layout in 'neo' theme by default. Older, 2-column layout
 124   themes have been removed.
 125 - Alphabetical, searchable user directory.
 126 - Alphabetical, searchable group directory.
 127 - Groups can require all posts to be private ('private groups'), and
 128   limit members to the group.
 129 - Users can make all posts private to their followers ('private stream'),
 130   and require authorization to follow.
 131 - General plugin for IM support; added AIM, IRC and MSN to existing
 132   XMPP code.
 133 - Support for Twitter-like lists, to follow other users without
 134   interfering with the home timeline.
 135 - Subscription to searches.
 136 - Subscription to tags.
 137 - Drupal-style schema system ("schemax") allows in-place database
 138   upgrades from various software versions.
 139 - Fine-grained control of URL shortening, and an internal URL shortener
 140   available.
 141 - Extended profile for private, enterprise sites.
 142 - sites are private by default.
 143 - Blog plugin for extended posts.
 144 - Plugin to restrict all users of a site to a single email domain.
 145 - Plugin to send a daily email summary to site users.
 146 - Deeper integration with Activity Streams (http://activitystrea.ms) format.
 147 - Automated upgrade script.
 148
 149 A full changelog is available at http://status.net/wiki/StatusNet_1.0.1.
 150
 151 Troubleshooting
 152 ===============
 153
 154 The primary output for StatusNet is syslog, unless you configured a
 155 separate logfile. This is probably the first place to look if you're
 156 getting weird behaviour from StatusNet.
 157
 158 If you're tracking the unstable version of StatusNet in the git
 159 repository (see below), and you get a compilation error ("unexpected
 160 T_STRING") in the browser, check to see that you don't have any
 161 conflicts in your code.
 162
 163 Unstable version
 164 ================
 165
 166 If you're adventurous or impatient, you may want to install the
 167 development version of StatusNet. To get it, use the git version
 168 control tool <http://git-scm.com/> like so:
 169
 170     git clone git@gitorious.org:statusnet/mainline.git
 171
 172 This is the version of the software that runs on Identi.ca and the
 173 status.net hosted service. Using it is a mixed bag. On the positive
 174 side, it usually includes the latest security and bug fix patches. On
 175 the downside, it may also include changes that require admin
 176 intervention (like running a script or even raw SQL!) that may not be
 177 documented yet. It may be a good idea to test this version before
 178 installing it on your production machines.
 179
 180 To keep it up-to-date, use 'git pull'. Watch for conflicts!
 181
 182 Further information
 183 ===================
 184
 185 There are several ways to get more information about StatusNet.
 186
 187 * There is a mailing list for StatusNet developers and admins at
 188   http://mail.status.net/mailman/listinfo/statusnet-dev
 189 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
 190 * The StatusNet wiki, http://status.net/wiki/
 191 * The StatusNet blog, http://status.net/blog/
 192 * The StatusNet status update, <http://status.status.net/> (!)
 193
 194 Feedback
 195 ========
 196
 197 * Messages to http://support.status.net/ are very welcome.
 198 * The group http://identi.ca/group/statusnet is a good
 199   place to discuss the software.
 200 * StatusNet has a bug tracker for any defects you may find, or ideas for
 201   making things better. http://status.net/open-source/issues
 202 * The StatusNet forum is at http://forum.status.net/.
 203
 204 Credits
 205 =======
 206
 207 The following is an incomplete list of developers who've worked on
 208 StatusNet. Apologies for any oversight; please let evan@status.net know
 209 if anyone's been overlooked in error.
 210
 211 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
 212 * Zach Copley, StatusNet, Inc.
 213 * Earle Martin, StatusNet, Inc.
 214 * Marie-Claude Doyon, designer, StatusNet, Inc.
 215 * Sarven Capadisli, StatusNet, Inc.
 216 * Robin Millette, StatusNet, Inc.
 217 * Ciaran Gultnieks
 218 * Michael Landers
 219 * Ori Avtalion
 220 * Garret Buell
 221 * Mike Cochrane
 222 * Matthew Gregg
 223 * Florian Biree
 224 * Erik Stambaugh
 225 * 'drry'
 226 * Gina Haeussge
 227 * Tryggvi Björgvinsson
 228 * Adrian Lang
 229 * Ori Avtalion
 230 * Meitar Moscovitz
 231 * Ken Sheppardson (Trac server, man-about-town)
 232 * Tiago 'gouki' Faria (i18n manager)
 233 * Sean Murphy
 234 * Leslie Michael Orchard
 235 * Eric Helgeson
 236 * Ken Sedgwick
 237 * Brian Hendrickson
 238 * Tobias Diekershoff
 239 * Dan Moore
 240 * Fil
 241 * Jeff Mitchell
 242 * Brenda Wallace
 243 * Jeffery To
 244 * Federico Marani
 245 * Craig Andrews
 246 * mEDI
 247 * Brett Taylor
 248 * Brigitte Schuster
 249 * Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
 250 * Brion Vibber, StatusNet, Inc.
 251 * James Walker, StatusNet, Inc.
 252 * Samantha Doherty, designer, StatusNet, Inc.
 253
 254 Thanks also to the developers of our upstream library code and to the
 255 thousands of people who have tried out Identi.ca, installed StatusNet,
 256 told their friends, and built the Open Microblogging network to what
 257 it is today.