We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

README 7.98 KB
Newer Older
1 2 3 4
------
README
------

Evan Prodromou's avatar
Evan Prodromou committed
5
StatusNet 1.1.0alpha1
Evan Prodromou's avatar
Evan Prodromou committed
6
3 October 2011
7

Evan Prodromou's avatar
Evan Prodromou committed
8
This is the README file for StatusNet, the Open Source social
9 10 11 12 13 14 15 16 17 18 19 20 21 22
networking platform. It includes general information about the
software and the project.

Some other files to review:

- INSTALL: instructions on how to install the software.
- UPGRADE: upgrading from earlier versions
- CONFIGURE: configuration options in gruesome detail.
- PLUGINS.txt: how to install and configure plugins.
- EVENTS.txt: events supported by the plugin system
- COPYING: full text of the software license

Information on using StatusNet can be found in the "doc" subdirectory
or in the "help" section on-line.
23 24 25 26

About
=====

27 28 29 30 31 32 33
StatusNet is a Free and Open Source social networking platform. It
helps people in a community, company or group to exchange short status
updates, do polls, announce events, or other social activities (and
you can add more!). Users can choose which people to "follow" and
receive only their friends' or colleagues' status messages. It
provides a similar service to sites like Twitter, Google+, Facebook or
Yammer, but is much more awesome.
34 35 36 37 38

With a little work, status messages can be sent to mobile phones,
instant messenger programs (GTalk/Jabber), and specially-designed
desktop clients that support the Twitter API.

Evan Prodromou's avatar
Evan Prodromou committed
39 40 41 42
StatusNet supports an open standard called OStatus
<http://ostatus.org/> that lets users in different networks follow
each other. It enables a distributed social network spread all across
the Web.
43

Evan Prodromou's avatar
Evan Prodromou committed
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 53
Web service, requiring no installation on your part. See
<http://status.net/signup> for details. The software run
54 55 56 57
on status.net is identical to the software available for download, so
you can move back and forth between a hosted version or a version
installed on your own servers.

58 59 60 61
A commercial software subscription is available from StatusNet Inc. It
includes 24-hour technical support and developer support. More
information at http://status.net/contact or email sales@status.net.

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
License
=======

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public
License along with this program, in the file "COPYING".  If not, see
<http://www.gnu.org/licenses/>.

    IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
    *different requirements* from the "regular" GPL. In particular, if
Evan Prodromou's avatar
Evan Prodromou committed
81
    you make modifications to the StatusNet source code on your server,
82 83 84
    you *MUST MAKE AVAILABLE* the modified version of the source code
    to your users under the same license. This is a legal requirement
    of using the software, and if you do not wish to share your
85
    modifications, *YOU MAY NOT INSTALL STATUSNET*.
86

87 88 89 90
Documentation in the /doc-src/ directory is available under the
Creative Commons Attribution 3.0 Unported license, with attribution to
"StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.

91
CSS and images in the /theme/ directory are available under the
Evan Prodromou's avatar
Evan Prodromou committed
92 93
Creative Commons Attribution 3.0 Unported license, with attribution to
"StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
94 95 96 97 98 99 100

Our understanding and intention is that if you add your own theme that
uses only CSS and images, those files are not subject to the copyleft
requirements of the Affero General Public License 3.0. See
http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
legal advice; consult your lawyer.

Evan Prodromou's avatar
Evan Prodromou committed
101 102 103 104 105 106 107 108 109
Additional library software has been made available in the 'extlib'
directory. All of it is Free Software and can be distributed under
liberal terms, but those terms may differ in detail from the AGPL's
particulars. See each package's license file in the extlib directory
for additional terms.

New this version
================

Evan Prodromou's avatar
Evan Prodromou committed
110 111 112 113 114 115
This is a minor bug fix and feature release since 1.0.1, released 3 October
2011. It includes the following changes:

- ...

A full changelog is available at http://status.net/wiki/StatusNet_1.1.0alpha1.
Evan Prodromou's avatar
Evan Prodromou committed
116

117 118 119
Troubleshooting
===============

Evan Prodromou's avatar
Evan Prodromou committed
120
The primary output for StatusNet is syslog, unless you configured a
Evan Prodromou's avatar
Evan Prodromou committed
121
separate logfile. This is probably the first place to look if you're
Evan Prodromou's avatar
Evan Prodromou committed
122
getting weird behaviour from StatusNet.
Evan Prodromou's avatar
Evan Prodromou committed
123

Evan Prodromou's avatar
Evan Prodromou committed
124
If you're tracking the unstable version of StatusNet in the git
Evan Prodromou's avatar
Evan Prodromou committed
125 126 127
repository (see below), and you get a compilation error ("unexpected
T_STRING") in the browser, check to see that you don't have any
conflicts in your code.
128

Evan Prodromou's avatar
Evan Prodromou committed
129 130 131 132
Unstable version
================

If you're adventurous or impatient, you may want to install the
Evan Prodromou's avatar
Evan Prodromou committed
133
development version of StatusNet. To get it, use the git version
134
control tool <http://git-scm.com/> like so:
135

136
    git clone git@gitorious.org:statusnet/mainline.git
137 138 139 140 141 142 143 144

This is the version of the software that runs on Identi.ca and the
status.net hosted service. Using it is a mixed bag. On the positive
side, it usually includes the latest security and bug fix patches. On
the downside, it may also include changes that require admin
intervention (like running a script or even raw SQL!) that may not be
documented yet. It may be a good idea to test this version before
installing it on your production machines.
Evan Prodromou's avatar
Evan Prodromou committed
145

146
To keep it up-to-date, use 'git pull'. Watch for conflicts!
147

Evan Prodromou's avatar
Evan Prodromou committed
148 149 150
Further information
===================

Evan Prodromou's avatar
Evan Prodromou committed
151
There are several ways to get more information about StatusNet.
Evan Prodromou's avatar
Evan Prodromou committed
152

Evan Prodromou's avatar
Evan Prodromou committed
153
* There is a mailing list for StatusNet developers and admins at
154 155
  http://mail.status.net/mailman/listinfo/statusnet-dev
* The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
156 157
* The StatusNet wiki, http://status.net/wiki/
* The StatusNet blog, http://status.net/blog/
158
* The StatusNet status update, <http://status.status.net/> (!)
Evan Prodromou's avatar
Evan Prodromou committed
159 160 161 162

Feedback
========

Evan Prodromou's avatar
Evan Prodromou committed
163 164
* Messages to http://support.status.net/ are very welcome.
* The group http://identi.ca/group/statusnet is a good
165
  place to discuss the software.
166
* StatusNet has a bug tracker for any defects you may find, or ideas for
167
  making things better. http://status.net/open-source/issues
168
* The StatusNet forum is at http://forum.status.net/.
Evan Prodromou's avatar
Evan Prodromou committed
169

170 171
Credits
=======
Evan Prodromou's avatar
Evan Prodromou committed
172 173

The following is an incomplete list of developers who've worked on
174
StatusNet. Apologies for any oversight; please let evan@status.net know
Evan Prodromou's avatar
Evan Prodromou committed
175 176
if anyone's been overlooked in error.

177 178 179 180 181 182
* Evan Prodromou, founder and lead developer, StatusNet, Inc.
* Zach Copley, StatusNet, Inc.
* Earle Martin, StatusNet, Inc.
* Marie-Claude Doyon, designer, StatusNet, Inc.
* Sarven Capadisli, StatusNet, Inc.
* Robin Millette, StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
183 184 185 186 187 188 189 190 191 192
* Ciaran Gultnieks
* Michael Landers
* Ori Avtalion
* Garret Buell
* Mike Cochrane
* Matthew Gregg
* Florian Biree
* Erik Stambaugh
* 'drry'
* Gina Haeussge
Evan Prodromou's avatar
Evan Prodromou committed
193
* Tryggvi Björgvinsson
Evan Prodromou's avatar
Evan Prodromou committed
194 195 196 197
* Adrian Lang
* Ori Avtalion
* Meitar Moscovitz
* Ken Sheppardson (Trac server, man-about-town)
198
* Tiago 'gouki' Faria (i18n manager)
199
* Sean Murphy
200 201 202
* Leslie Michael Orchard
* Eric Helgeson
* Ken Sedgwick
203 204
* Brian Hendrickson
* Tobias Diekershoff
205 206
* Dan Moore
* Fil
207 208 209 210
* Jeff Mitchell
* Brenda Wallace
* Jeffery To
* Federico Marani
211
* Craig Andrews
Evan Prodromou's avatar
Evan Prodromou committed
212
* mEDI
Evan Prodromou's avatar
Evan Prodromou committed
213
* Brett Taylor
214
* Brigitte Schuster
215
* Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
Brion Vibber's avatar
Brion Vibber committed
216 217 218
* Brion Vibber, StatusNet, Inc.
* James Walker, StatusNet, Inc.
* Samantha Doherty, designer, StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
219

Evan Prodromou's avatar
Evan Prodromou committed
220
Thanks also to the developers of our upstream library code and to the
221
thousands of people who have tried out Identi.ca, installed StatusNet,
Evan Prodromou's avatar
Evan Prodromou committed
222 223
told their friends, and built the Open Microblogging network to what
it is today.