README

   1 ------
   2 README
   3 ------
   4
   5 StatusNet 1.1.1
   6 16 July 2013
   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 security fix and bug fix release since 1.1.0,
 111 released 2 July 2012. All 1.1.0 sites should upgrade to this version.
 112
 113 It includes the following changes:
 114
 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.
 121
 122 A full changelog is available at http://status.net/wiki/StatusNet_1.1.1.
 123
 124 Troubleshooting
 125 ===============
 126
 127 The primary output for StatusNet is syslog, unless you configured a
 128 separate logfile. This is probably the first place to look if you're
 129 getting weird behaviour from StatusNet.
 130
 131 If you're tracking the unstable version of StatusNet in the git
 132 repository (see below), and you get a compilation error ("unexpected
 133 T_STRING") in the browser, check to see that you don't have any
 134 conflicts in your code.
 135
 136 Unstable version
 137 ================
 138
 139 If you're adventurous or impatient, you may want to install the
 140 development version of StatusNet. To get it, use the git version
 141 control tool <http://git-scm.com/> like so:
 142
 143     git clone git@gitorious.org:statusnet/mainline.git
 144
 145 This is the version of the software that runs on Identi.ca and the
 146 status.net hosted service. Using it is a mixed bag. On the positive
 147 side, it usually includes the latest security and bug fix patches. On
 148 the downside, it may also include changes that require admin
 149 intervention (like running a script or even raw SQL!) that may not be
 150 documented yet. It may be a good idea to test this version before
 151 installing it on your production machines.
 152
 153 To keep it up-to-date, use 'git pull'. Watch for conflicts!
 154
 155 Further information
 156 ===================
 157
 158 There are several ways to get more information about StatusNet.
 159
 160 * There is a mailing list for StatusNet developers and admins at
 161   http://mail.status.net/mailman/listinfo/statusnet-dev
 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/> (!)
 166
 167 Feedback
 168 ========
 169
 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/.
 176
 177 Credits
 178 =======
 179
 180 The following is an incomplete list of developers who've worked on
 181 StatusNet. Apologies for any oversight; please let evan@status.net know
 182 if anyone's been overlooked in error.
 183
 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
 198 * 'drry'
 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
 213 * Fil
 214 * Jeff Mitchell
 215 * Brenda Wallace
 216 * Jeffery To
 217 * Federico Marani
 218 * Craig Andrews
 219 * mEDI
 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.
 226
 227 Thanks also to the developers of our upstream library code and to the
 228 thousands of people who have tried out Identi.ca, installed StatusNet,
 229 told their friends, and built the Open Microblogging network to what
 230 it is today.