README.md

   1 # GNU social 1.2.x
   2 2015
   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 <https://www.w3.org/community/ostatus/> 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 as "StatusNet" by
  50 StatusNet, Inc. with Evan Prodromou as lead developer.
  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 the development branch for the 1.2.x version of GNU social.
 104 All daring 1.1.x admins should upgrade to this version.
 105
 106 So far it includes the following changes:
 107
 108 - Backing up a user's account is more and more complete.
 109 - Emojis 😸 (utf8mb4 support)
 110
 111 The last release, 1.1.3, gave us these improvements:
 112
 113 - XSS security fix (thanks Simon Waters, <https://www.surevine.com/>)
 114 - Many improvements to ease adoption of the Qvitter front-end <https://github.com/hannesmannerheim/qvitter>
 115 - Protocol adaptions for improved performance and stability
 116
 117 Upgrades from _StatusNet_ 1.1.1 will also experience these improvements:
 118
 119 - Fixes for SQL injection errors in profile lists.
 120 - Improved ActivityStreams JSON representation of activities and objects.
 121 - Upgrade to the Twitter 1.1 API.
 122 - More robust handling of errors in distribution.
 123 - Fix error in OStatus subscription for remote groups.
 124 - Fix error in XMPP distribution.
 125 - Tracking of conversation URI metadata (more coherent convos)
 126
 127 ### Troubleshooting
 128
 129 The primary output for GNU social is syslog,
 130 unless you configured a separate logfile. This is
 131 probably the first place to look if you're getting
 132 weird behaviour from GNU social.
 133
 134 If you're tracking the unstable version of
 135 GNU social in the git repository (see below), and you
 136 get a compilation error ("unexpected T_STRING") in
 137 the browser, check to see that you don't have any
 138 conflicts in your code.
 139
 140 ### Unstable version
 141
 142 If you're adventurous or impatient, you may want
 143 to install the development version of GNU social.
 144 To get it, use the git version control tool
 145 <http://git-scm.com/> like so:
 146
 147     git clone git@git.gnu.io:gnu/gnu-social.git
 148
 149 In the current phase of development it is probably
 150 recommended to use git as a means to stay up to date
 151 with the source code. You can choose between these
 152 branches:
 153 - 1.2.x     "stable", few updates, well tested code
 154 - master    "testing", more updates, usually working well
 155 - nightly   "unstable", most updates, not always working
 156
 157 To keep it up-to-date, use 'git pull'. Watch for conflicts!
 158
 159 ## Further information
 160
 161 There are several ways to get more information about GNU social.
 162
 163 * The #social IRC channel on freenode.net <https://www.freenode.net/>.
 164 * The unofficial XMPP room linked to IRC on <xmpp:gnusocial@conference.bka.li>
 165 * The GNU social website <https://gnu.io/social/>
 166 * Following us on GNU social -- <https://quitter.se/gnusocial>
 167
 168 * GNU social has a bug tracker for any defects you may find, or ideas for
 169   making things better. <https://git.gnu.io/gnu/gnu-social/issues/>
 170 * Patches are welcome, preferrably to our repository on git.gnu.io. <https://git.gnu.io/gnu/gnu-social>
 171
 172 Credits
 173 =======
 174
 175 The following is an incomplete list of developers
 176 who've worked on GNU social, or its predecessors
 177 StatusNet and Free Social. Apologies for any
 178 oversight; please let mattl@gnu.org know if
 179 anyone's been overlooked in error.
 180
 181 ## Project Founders
 182
 183 * Matt Lee (GNU social)
 184 * Evan Prodromou (StatusNet)
 185 * Mikael Nordfeldth (Free Social)
 186
 187 Thanks to all of the StatusNet developers:
 188
 189 * Zach Copley, StatusNet, Inc.
 190 * Earle Martin, StatusNet, Inc.
 191 * Marie-Claude Doyon, designer, StatusNet, Inc.
 192 * Sarven Capadisli, StatusNet, Inc.
 193 * Robin Millette, StatusNet, Inc.
 194 * Ciaran Gultnieks
 195 * Michael Landers
 196 * Ori Avtalion
 197 * Garret Buell
 198 * Mike Cochrane
 199 * Matthew Gregg
 200 * Florian Biree
 201 * Erik Stambaugh
 202 * 'drry'
 203 * Gina Haeussge
 204 * Tryggvi Björgvinsson
 205 * Adrian Lang
 206 * Ori Avtalion
 207 * Meitar Moscovitz
 208 * Ken Sheppardson (Trac server, man-about-town)
 209 * Tiago 'gouki' Faria (i18n manager)
 210 * Sean Murphy
 211 * Leslie Michael Orchard
 212 * Eric Helgeson
 213 * Ken Sedgwick
 214 * Brian Hendrickson
 215 * Tobias Diekershoff
 216 * Dan Moore
 217 * Fil
 218 * Jeff Mitchell
 219 * Brenda Wallace
 220 * Jeffery To
 221 * Federico Marani
 222 * mEDI
 223 * Brett Taylor
 224 * Brigitte Schuster
 225 * Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
 226 * Brion Vibber, StatusNet, Inc.
 227 * James Walker, StatusNet, Inc.
 228 * Samantha Doherty, designer, StatusNet, Inc.
 229 * Simon Waters, Surevine
 230 * Joshua Judson Rosen (rozzin)
 231
 232 ### Extra special thanks to the GNU socialites
 233
 234 * Craig Andrews
 235 * Donald Robertson
 236 * Deb Nicholson
 237 * Ian Denhart
 238 * Steven DuBois
 239 * Blaine Cook
 240 * Henry Story
 241 * Melvin Carvalho
 242
 243 Thanks also to the developers of our upstream
 244 library code and to the thousands of people who
 245 have tried out GNU social, told their friends, and
 246 built the fediverse network to what it is today.
 247
 248 ### License help from
 249
 250 * Bradley M. Kuhn
 251