README.md

   1 # GNU social 1.1.2 (alpha)
   2 August 2014
   3
   4 (c) Free Software Foundation, Inc
   5 (c) StatusNet, Inc
   6
   7 This is the README file for GNU social, the free
   8 software social networking platform. It includes
   9 general information about the software and the
  10 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 GNU social can be found in
  22 the "doc" subdirectory or in the "help" section
  23 on-line, or you can catch us on IRC in #social on
  24 the freenode network.
  25
  26 ## About
  27
  28 GNU social is a free social networking
  29 platform. It helps people in a community, company
  30 or group to exchange short status updates, do
  31 polls, announce events, or other social activities
  32 (and you can add more!). Users can choose which
  33 people to "follow" and receive only their friends'
  34 or colleagues' status messages. It provides a
  35 similar service to sites like Twitter, Google+ or
  36 Facebook, but is much more awesome.
  37
  38 With a little work, status messages can be sent to
  39 mobile phones, instant messenger programs (using
  40 XMPP), and specially-designed desktop clients that
  41 support the Twitter API.
  42
  43 GNU social supports an open standard called
  44 OStatus <http://ostatus.org/> that lets users in
  45 different networks follow each other. It enables a
  46 distributed social network spread all across the
  47 Web.
  48
  49 GNU social was originally developed for the
  50 service, Identi.ca <http://identi.ca/>.
  51
  52 It is shared with you in hope that you too make an
  53 service available to your users. To learn more,
  54 please see the Open Software Service Definition
  55 1.1:
  56
  57     http://www.opendefinition.org/ossd
  58
  59 ### License
  60
  61 This program is free software: you can redistribute it and/or modify
  62 it under the terms of the GNU Affero General Public License as
  63 published by the Free Software Foundation, either version 3 of the
  64 License, or (at your option) any later version.
  65
  66 This program is distributed in the hope that it will be useful, but
  67 WITHOUT ANY WARRANTY; without even the implied warranty of
  68 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  69 Affero General Public License for more details.
  70
  71 You should have received a copy of the GNU Affero General Public
  72 License along with this program, in the file "COPYING".  If not, see
  73 <http://www.gnu.org/licenses/>.
  74
  75     IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
  76     *different requirements* from the "regular" GPL. In particular, if
  77     you make modifications to the GNU social source code on your server,
  78     you *MUST MAKE AVAILABLE* the modified version of the source code
  79     to your users under the same license. This is a legal requirement
  80     of using the software, and if you do not wish to share your
  81     modifications, *YOU MAY NOT INSTALL GNU SOCIAL*.
  82
  83 Documentation in the /doc-src/ directory is available under the
  84 Creative Commons Attribution 3.0 Unported license, with attribution to
  85 "GNU social". See http://creativecommons.org/licenses/by/3.0/ for details.
  86
  87 CSS and images in the /theme/ directory are available under the
  88 Creative Commons Attribution 3.0 Unported license, with attribution to
  89 "GNU social". See http://creativecommons.org/licenses/by/3.0/ for details.
  90
  91 Our understanding and intention is that if you add your own theme that
  92 uses only CSS and images, those files are not subject to the copyleft
  93 requirements of the Affero General Public License 3.0. See
  94 http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
  95 legal advice; consult your lawyer.
  96
  97 Additional library software has been made available in the 'extlib'
  98 directory. All of it is Free Software and can be distributed under
  99 liberal terms, but those terms may differ in detail from the AGPL's
 100 particulars. See each package's license file in the extlib directory
 101 for additional terms.
 102
 103 ## New this version
 104
 105 This is a security fix and bug fix release since 1.1.0,
 106 released 2 July 2012. All 1.1.0 sites should upgrade to this version.
 107
 108 It includes the following changes:
 109
 110 - Fixes for SQL injection errors in profile lists.
 111 - Improved ActivityStreams JSON representation of activities and objects.
 112 - Upgrade to the Twitter 1.1 API.
 113 - More robust handling of errors in distribution.
 114 - Fix error in OStatus subscription for remote groups.
 115 - Fix error in XMPP distribution.
 116
 117 ### Troubleshooting
 118
 119 The primary output for GNU social is syslog,
 120 unless you configured a separate logfile. This is
 121 probably the first place to look if you're getting
 122 weird behaviour from GNU social.
 123
 124 If you're tracking the unstable version of
 125 GNU social in the git repository (see below), and you
 126 get a compilation error ("unexpected T_STRING") in
 127 the browser, check to see that you don't have any
 128 conflicts in your code.
 129
 130 ### Unstable version
 131
 132 If you're adventurous or impatient, you may want
 133 to install the development version of
 134 StatusNet. To get it, use the git version control
 135 tool <http://git-scm.com/> like so:
 136
 137     git clone git@gitorious.org:social/mainline.git
 138
 139 Using it is a mixed bag. On the positive side, it
 140 usually includes the latest security and bug fix
 141 patches. On the downside, it may also include
 142 changes that require admin intervention (like
 143 running a script or even raw SQL!) that may not be
 144 documented yet. It may be a good idea to test this
 145 version before installing it on your production
 146 machines.
 147
 148 To keep it up-to-date, use 'git pull'. Watch for
 149 conflicts!
 150
 151 ## Further information
 152
 153 There are several ways to get more information
 154 about GNU social.
 155
 156 * The #social IRC channel on freenode.net <http://www.freenode.net/>.
 157 * The GNU social website
 158 * Following us on GNU social -- http://quitter.se/gnusocial
 159 * Following us on Twitter -- https://twitter.com/gnusocial
 160
 161 * GNU social has a bug tracker for any defects you may find, or ideas for
 162   making things better. http://bugz.foocorp.net/
 163
 164 Credits
 165 =======
 166
 167 The following is an incomplete list of developers
 168 who've worked on GNU social, or its predecessors
 169 StatusNet and Free Social. Apologies for any
 170 oversight; please let mattl@gnu.org know if
 171 anyone's been overlooked in error.
 172
 173 ## Project Founders
 174
 175 * Matt Lee (GNU social)
 176 * Evan Prodromou (StatusNet)
 177 * Mikael Nordfeldth (Free Social)
 178
 179 Thanks to all of the StatusNet developers:
 180
 181 * Zach Copley, StatusNet, Inc.
 182 * Earle Martin, StatusNet, Inc.
 183 * Marie-Claude Doyon, designer, StatusNet, Inc.
 184 * Sarven Capadisli, StatusNet, Inc.
 185 * Robin Millette, StatusNet, Inc.
 186 * Ciaran Gultnieks
 187 * Michael Landers
 188 * Ori Avtalion
 189 * Garret Buell
 190 * Mike Cochrane
 191 * Matthew Gregg
 192 * Florian Biree
 193 * Erik Stambaugh
 194 * 'drry'
 195 * Gina Haeussge
 196 * Tryggvi Björgvinsson
 197 * Adrian Lang
 198 * Ori Avtalion
 199 * Meitar Moscovitz
 200 * Ken Sheppardson (Trac server, man-about-town)
 201 * Tiago 'gouki' Faria (i18n manager)
 202 * Sean Murphy
 203 * Leslie Michael Orchard
 204 * Eric Helgeson
 205 * Ken Sedgwick
 206 * Brian Hendrickson
 207 * Tobias Diekershoff
 208 * Dan Moore
 209 * Fil
 210 * Jeff Mitchell
 211 * Brenda Wallace
 212 * Jeffery To
 213 * Federico Marani
 214 * mEDI
 215 * Brett Taylor
 216 * Brigitte Schuster
 217 * Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
 218 * Brion Vibber, StatusNet, Inc.
 219 * James Walker, StatusNet, Inc.
 220 * Samantha Doherty, designer, StatusNet, Inc.
 221
 222 ### Extra special thanks to the GNU socialites
 223
 224 * Craig Andrews
 225 * Donald Robertson
 226 * Deb Nicholson
 227 * Ian Denhart
 228 * Steven DuBois
 229 * Blaine Cook
 230 * Henry Story
 231 * Melvin Carvalho
 232
 233 Thanks also to the developers of our upstream
 234 library code and to the thousands of people who
 235 have tried out GNU social, told their friends, and
 236 built the fediverse network to what it is today.
 237
 238 ### License help from
 239
 240 * Bradley M. Kuhn
 241