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: <http://www.opendefinition.org/ossd>
  56
  57 ### License
  58
  59 This program is free software: you can redistribute it and/or modify
  60 it under the terms of the GNU Affero General Public License as
  61 published by the Free Software Foundation, either version 3 of the
  62 License, or (at your option) any later version.
  63
  64 This program is distributed in the hope that it will be useful, but
  65 WITHOUT ANY WARRANTY; without even the implied warranty of
  66 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  67 Affero General Public License for more details.
  68
  69 You should have received a copy of the GNU Affero General Public
  70 License along with this program, in the file "COPYING".  If not, see
  71 <http://www.gnu.org/licenses/>.
  72
  73     IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
  74     *different requirements* from the "regular" GPL. In particular, if
  75     you make modifications to the GNU social source code on your server,
  76     you *MUST MAKE AVAILABLE* the modified version of the source code
  77     to your users under the same license. This is a legal requirement
  78     of using the software, and if you do not wish to share your
  79     modifications, *YOU MAY NOT INSTALL GNU SOCIAL*.
  80
  81 Documentation in the /doc-src/ directory is available under the
  82 Creative Commons Attribution 3.0 Unported license, with attribution to
  83 "GNU social". See <http://creativecommons.org/licenses/by/3.0/> for details.
  84
  85 CSS and images in the /theme/ directory are available under the
  86 Creative Commons Attribution 3.0 Unported license, with attribution to
  87 "GNU social". See <http://creativecommons.org/licenses/by/3.0/> for details.
  88
  89 Our understanding and intention is that if you add your own theme that
  90 uses only CSS and images, those files are not subject to the copyleft
  91 requirements of the Affero General Public License 3.0. See
  92 <http://wordpress.org/news/2009/07/themes-are-gpl-too/>. This is not
  93 legal advice; consult your lawyer.
  94
  95 Additional library software has been made available in the 'extlib'
  96 directory. All of it is Free Software and can be distributed under
  97 liberal terms, but those terms may differ in detail from the AGPL's
  98 particulars. See each package's license file in the extlib directory
  99 for additional terms.
 100
 101 ## New this version
 102
 103 This is a security fix and bug fix release since 1.1.1-alpha2.
 104 The current release base version, 1.1.2, began work on 2014-10-25.
 105 All 1.1.1 sites should upgrade to this version.
 106
 107 So far it includes the following changes:
 108
 109 - XSS security fix (thanks Simon Waters, <https://www.surevine.com/> )
 110
 111 Upgrades from _StatusNet_ 1.1.1 will also experience these improvements:
 112
 113 - Fixes for SQL injection errors in profile lists.
 114 - Improved ActivityStreams JSON representation of activities and objects.
 115 - Upgrade to the Twitter 1.1 API.
 116 - More robust handling of errors in distribution.
 117 - Fix error in OStatus subscription for remote groups.
 118 - Fix error in XMPP distribution.
 119 - Tracking of conversation URI metadata (more coherent convos)
 120
 121 ### Troubleshooting
 122
 123 The primary output for GNU social is syslog,
 124 unless you configured a separate logfile. This is
 125 probably the first place to look if you're getting
 126 weird behaviour from GNU social.
 127
 128 If you're tracking the unstable version of
 129 GNU social in the git repository (see below), and you
 130 get a compilation error ("unexpected T_STRING") in
 131 the browser, check to see that you don't have any
 132 conflicts in your code.
 133
 134 ### Unstable version
 135
 136 If you're adventurous or impatient, you may want
 137 to install the development version of GNU social.
 138 To get it, use the git version control tool
 139 <http://git-scm.com/> like so:
 140
 141     git clone git@gitorious.org:social/mainline.git
 142
 143 In the current phase of development it is probably
 144 recommended to use git as a means to stay up to date
 145 with the source code. You can choose between these
 146 branches:
 147 - 1.1.x     "stable", few updates, well tested code
 148 - master    "testing", more updates, usually working well
 149 - nightly   "unstable", most updates, not always working
 150
 151 To keep it up-to-date, use 'git pull'. Watch for conflicts!
 152
 153 ## Further information
 154
 155 There are several ways to get more information about GNU social.
 156
 157 * The #social IRC channel on freenode.net <http://www.freenode.net/>.
 158 * The GNU social website <http://gnu.io/social/>
 159 * Following us on GNU social -- <http://quitter.se/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 * Patches are welcome, either on the bug tracker or our repository at
 164   Gitorious. <https://gitorious.org/social/mainline>
 165
 166 Credits
 167 =======
 168
 169 The following is an incomplete list of developers
 170 who've worked on GNU social, or its predecessors
 171 StatusNet and Free Social. Apologies for any
 172 oversight; please let mattl@gnu.org know if
 173 anyone's been overlooked in error.
 174
 175 ## Project Founders
 176
 177 * Matt Lee (GNU social)
 178 * Evan Prodromou (StatusNet)
 179 * Mikael Nordfeldth (Free Social)
 180
 181 Thanks to all of the StatusNet developers:
 182
 183 * Zach Copley, StatusNet, Inc.
 184 * Earle Martin, StatusNet, Inc.
 185 * Marie-Claude Doyon, designer, StatusNet, Inc.
 186 * Sarven Capadisli, StatusNet, Inc.
 187 * Robin Millette, StatusNet, Inc.
 188 * Ciaran Gultnieks
 189 * Michael Landers
 190 * Ori Avtalion
 191 * Garret Buell
 192 * Mike Cochrane
 193 * Matthew Gregg
 194 * Florian Biree
 195 * Erik Stambaugh
 196 * 'drry'
 197 * Gina Haeussge
 198 * Tryggvi Björgvinsson
 199 * Adrian Lang
 200 * Ori Avtalion
 201 * Meitar Moscovitz
 202 * Ken Sheppardson (Trac server, man-about-town)
 203 * Tiago 'gouki' Faria (i18n manager)
 204 * Sean Murphy
 205 * Leslie Michael Orchard
 206 * Eric Helgeson
 207 * Ken Sedgwick
 208 * Brian Hendrickson
 209 * Tobias Diekershoff
 210 * Dan Moore
 211 * Fil
 212 * Jeff Mitchell
 213 * Brenda Wallace
 214 * Jeffery To
 215 * Federico Marani
 216 * mEDI
 217 * Brett Taylor
 218 * Brigitte Schuster
 219 * Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
 220 * Brion Vibber, StatusNet, Inc.
 221 * James Walker, StatusNet, Inc.
 222 * Samantha Doherty, designer, StatusNet, Inc.
 223 * Simon Waters, Surevine
 224
 225 ### Extra special thanks to the GNU socialites
 226
 227 * Craig Andrews
 228 * Donald Robertson
 229 * Deb Nicholson
 230 * Ian Denhart
 231 * Steven DuBois
 232 * Blaine Cook
 233 * Henry Story
 234 * Melvin Carvalho
 235
 236 Thanks also to the developers of our upstream
 237 library code and to the thousands of people who
 238 have tried out GNU social, told their friends, and
 239 built the fediverse network to what it is today.
 240
 241 ### License help from
 242
 243 * Bradley M. Kuhn
 244