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