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

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

Brion Vibber's avatar
Brion Vibber committed
5
StatusNet 0.9.6 "Man on the Moon"
Brion Vibber's avatar
Brion Vibber committed
6
29 October 2010
7

8 9 10 11
This is the README file for StatusNet, the Open Source microblogging
platform. It includes installation instructions, descriptions of
options you can set, warnings, tips, and general info for
administrators. Information on using StatusNet can be found in the
12 13 14 15 16
"doc" subdirectory or in the "help" section on-line.

About
=====

Evan Prodromou's avatar
Evan Prodromou committed
17 18 19 20 21 22
StatusNet is a Free and Open Source microblogging platform. It helps
people in a community, company or group to exchange short (140
characters, by default) messages over the Web. 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 Buzz, or Yammer.
23 24 25 26 27

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
28 29 30 31
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.
32

Evan Prodromou's avatar
Evan Prodromou committed
33
StatusNet was originally developed for the Open Software Service,
34
Identi.ca <http://identi.ca/>. It is shared with you in hope that you
35
too make an Open Software Service available to your users. To learn
36
more, please see the Open Software Service Definition 1.1:
37

38
    http://www.opendefinition.org/ossd
39

40
StatusNet, Inc. <http://status.net/> also offers this software as a
41 42
Web service, requiring no installation on your part. See
<http://status.net/signup> for details. The software run
43 44 45 46
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.

47 48 49 50
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.

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
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
70
    you make modifications to the StatusNet source code on your server,
71 72 73
    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
74
    modifications, *YOU MAY NOT INSTALL STATUSNET*.
75

76 77 78 79
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.

80
CSS and images in the /theme/ directory are available under the
Evan Prodromou's avatar
Evan Prodromou committed
81 82
Creative Commons Attribution 3.0 Unported license, with attribution to
"StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
83 84 85 86 87 88 89

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
90 91 92 93 94 95 96 97 98
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
================

Brion Vibber's avatar
Brion Vibber committed
99 100
This is a security, bug and feature release since version 0.9.5 released on
10 September 2010.
101

102 103 104
For best compatibility with client software and site federation, and a lot of
bug fixes, it is highly recommended that all public sites upgrade to the new
version.
Evan Prodromou's avatar
Evan Prodromou committed
105

Evan Prodromou's avatar
Evan Prodromou committed
106 107
Notable changes this version:

Brion Vibber's avatar
Brion Vibber committed
108 109 110 111 112 113 114
- Site moderators can now delete groups.
- New themes: clean, shiny, mnml, victorian
- New YammerImport plugin allows site admins to import non-private profiles and
  message from an authenticated Yammer site.
- New experimental plugins: AnonFavorites, SlicedFavorites, GroupFavorited,
  ForceGroup, ShareNotice
- OAuth upgraded to 1.0a
115
- Localization updates now include plugins, thanks to translatewiki.net!
Brion Vibber's avatar
Brion Vibber committed
116 117 118 119 120 121 122 123 124
- SSL link generation should be more consistent; alternate SSL URLs can be
  set in the admin UI for more parts of the system.
- Experimental backupuser.php, restoreuser.php command-line scripts to
  dump/restore a user's complete activity stream. Can be used to transfer
  accounts manually between sites, or to save a backup before deleting.
- Unicode fixes for OStatus notices
- Header metadata on notice pages to aid in manual reposting on Facebook
- Lots of little fixes...

Brion Vibber's avatar
Brion Vibber committed
125 126 127 128 129 130 131 132 133 134
Changes from 0.9.6 release candidate 1:
- fix for broken group pages when logged out
- fix for stuck ping queue entries when bad profile
- fix for bogus single-user nickname config entry error
- i18n updates
- nofollow updates
- SSL-only mode secure cookie fix
- experimental ApiLogger plugin for usage data gathering
- experimental follow-everyone plugin

Brion Vibber's avatar
Brion Vibber committed
135
A full changelog is available at http://status.net/wiki/StatusNet_0.9.6.
Evan Prodromou's avatar
Evan Prodromou committed
136

137 138 139 140 141 142
Prerequisites
=============

The following software packages are *required* for this software to
run correctly.

Craig Andrews's avatar
Craig Andrews committed
143
- PHP 5.2.3+. It may be possible to run this software on earlier
144
  versions of PHP, but many of the functions used are only available
145
  in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
146 147
  daemons on 64-bit platforms. PHP 5.3.x should work correctly in this
  release, but problems with some plugins are possible.
Evan Prodromou's avatar
Evan Prodromou committed
148
- MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
149 150 151 152 153
  server. It has been primarily tested on 5.x servers, although it may
  be possible to install on earlier (or later!) versions. The server
  *must* support the MyISAM storage engine -- the default for most
  MySQL servers -- *and* the InnoDB storage engine.
- A Web server. Preferably, you should have Apache 2.2.x with the
Evan Prodromou's avatar
Evan Prodromou committed
154
  mod_rewrite extension installed and enabled.
155 156 157 158 159 160

Your PHP installation must include the following PHP extensions:

- Curl. This is for fetching files by HTTP.
- XMLWriter. This is for formatting XML and HTML output.
- MySQL. For accessing the database.
Evan Prodromou's avatar
Evan Prodromou committed
161
- GD. For scaling down avatar images.
162
- mbstring. For handling Unicode (UTF-8) encoded strings.
163 164 165 166 167 168 169 170 171

For some functionality, you will also need the following extensions:

- Memcache. A client for the memcached server, which caches database
  information in volatile memory. This is important for adequate
  performance on high-traffic sites. You will also need a memcached
  server to store the data in.
- Mailparse. Efficient parsing of email requires this extension.
  Submission by email or SMS-over-email uses this extension.
172 173 174
- Sphinx Search. A client for the sphinx server, an alternative
  to MySQL or Postgresql fulltext search. You will also need a
  Sphinx server to serve the search queries.
175 176
- bcmath or gmp. For Salmon signatures (part of OStatus). Needed
  if you have OStatus configured.
177 178
- gettext. For multiple languages. Default on many PHP installs;
  will be emulated if not present.
179

180 181 182 183 184 185 186 187 188 189 190 191 192 193
You will almost definitely get 2-3 times better performance from your
site if you install a PHP bytecode cache/accelerator. Some well-known
examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
is a proprietary accelerator installed on some hosting sites.

External libraries
------------------

A number of external PHP libraries are used to provide basic
functionality and optional functionality for your system. For your
convenience, they are available in the "extlib" directory of this
package, and you do not have to download and install them. However,
you may want to keep them up-to-date with the latest upstream version,
and the URLs are listed here for your convenience.
194

Evan Prodromou's avatar
Evan Prodromou committed
195 196
- DB_DataObject http://pear.php.net/package/DB_DataObject
- Validate http://pear.php.net/package/Validate
197
- OpenID from OpenIDEnabled (not the PEAR version!). We decided
Evan Prodromou's avatar
Evan Prodromou committed
198
  to use the openidenabled.com version since it's more widely
199
  implemented, and seems to be better supported.
200
  http://openidenabled.com/php-openid/
201 202 203 204 205 206
- PEAR DB. Although this is an older data access system (new
  packages should probably use PHP DBO), the OpenID libraries
  depend on PEAR DB so we use it here, too. DB_DataObject can
  also use PEAR MDB2, which may give you better performance
  but won't work with OpenID.
  http://pear.php.net/package/DB
207
- OAuth.php from http://oauth.googlecode.com/svn/code/php/
Evan Prodromou's avatar
Evan Prodromou committed
208
- markdown.php from http://michelf.com/projects/php-markdown/
Evan Prodromou's avatar
Evan Prodromou committed
209
- PEAR Mail, for sending out mail notifications
210
  http://pear.php.net/package/Mail
Evan Prodromou's avatar
Evan Prodromou committed
211
- PEAR Net_SMTP, if you use the SMTP factory for notifications
212
  http://pear.php.net/package/Net_SMTP
Evan Prodromou's avatar
Evan Prodromou committed
213 214
- PEAR Net_Socket, if you use the SMTP factory for notifications
  http://pear.php.net/package/Net_Socket
215 216 217 218 219
- XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
  library available for PHP. http://xmpphp.googlecode.com/. Note that
  as of this writing the version of this library that is available in
  the extlib directory is *significantly different* from the upstream
  version (patches have been submitted). Upgrading to the upstream
Evan Prodromou's avatar
Evan Prodromou committed
220
  version may render your StatusNet site unable to send or receive XMPP
221
  messages.
Evan Prodromou's avatar
Evan Prodromou committed
222
- Facebook library. Used for the Facebook application.
223
- PEAR Validate is used for URL and email validation.
224
- Console_GetOpt for parsing command-line options.
225 226 227
- libomb. a library for implementing OpenMicroBlogging 0.1, the
  predecessor to OStatus.
- HTTP_Request2, a library for making HTTP requests.
228
- PEAR Net_URL2 is an HTTP_Request2 dependency.
229

Evan Prodromou's avatar
Evan Prodromou committed
230
A design goal of StatusNet is that the basic Web functionality should
231 232 233 234 235 236 237 238 239
work on even the most restrictive commercial hosting services.
However, additional functionality, such as receiving messages by
Jabber/GTalk, require that you be able to run long-running processes
on your account. In addition, posting by email or from SMS require
that you be able to install a mail filter in your mail server.

Installation
============

Evan Prodromou's avatar
Evan Prodromou committed
240
Installing the basic StatusNet Web component is relatively easy,
241 242 243 244
especially if you've previously installed PHP/MySQL packages.

1. Unpack the tarball you downloaded on your Web server. Usually a
   command like this will work:
Evan Prodromou's avatar
Evan Prodromou committed
245

Brion Vibber's avatar
Brion Vibber committed
246
       tar zxf statusnet-0.9.6.tar.gz
Evan Prodromou's avatar
Evan Prodromou committed
247

Brion Vibber's avatar
Brion Vibber committed
248
   ...which will make a statusnet-0.9.6 subdirectory in your current
249 250 251
   directory. (If you don't have shell access on your Web server, you
   may have to unpack the tarball on your local computer and FTP the
   files to the server.)
Evan Prodromou's avatar
Evan Prodromou committed
252

253 254
2. Move the tarball to a directory of your choosing in your Web root
   directory. Usually something like this will work:
Evan Prodromou's avatar
Evan Prodromou committed
255

Brion Vibber's avatar
Brion Vibber committed
256
       mv statusnet-0.9.6 /var/www/statusnet
Evan Prodromou's avatar
Evan Prodromou committed
257

258 259
   This will make your StatusNet instance available in the statusnet path of
   your server, like "http://example.net/statusnet". "microblog" or
260
   "statusnet" might also be good path names. If you know how to
261 262
   configure virtual hosts on your web server, you can try setting up
   "http://micro.example.net/" or the like.
Evan Prodromou's avatar
Evan Prodromou committed
263

264
3. Make your target directory writeable by the Web server.
Evan Prodromou's avatar
Evan Prodromou committed
265

266
       chmod a+w /var/www/statusnet/
Evan Prodromou's avatar
Evan Prodromou committed
267

268
   On some systems, this will probably work:
Evan Prodromou's avatar
Evan Prodromou committed
269

270
       chgrp www-data /var/www/statusnet/
271
       chmod g+w /var/www/statusnet/
272 273 274

   If your Web server runs as another user besides "www-data", try
   that user's default group instead. As a last resort, you can create
275
   a new group like "statusnet" and add the Web server's user to the group.
276

277 278 279
4. You should also take this moment to make your avatar, background, and
   file subdirectories writeable by the Web server. An insecure way to do
   this is:
280

281 282 283
       chmod a+w /var/www/statusnet/avatar
       chmod a+w /var/www/statusnet/background
       chmod a+w /var/www/statusnet/file
284

285 286
   You can also make the avatar, background, and file directories
   writeable by the Web server group, as noted above.
287 288

5. Create a database to hold your microblog data. Something like this
289
   should work:
Evan Prodromou's avatar
Evan Prodromou committed
290

291
       mysqladmin -u "username" --password="password" create statusnet
Evan Prodromou's avatar
Evan Prodromou committed
292

Evan Prodromou's avatar
Evan Prodromou committed
293
   Note that StatusNet must have its own database; you can't share the
294 295
   database with another program. You can name it whatever you want,
   though.
Evan Prodromou's avatar
Evan Prodromou committed
296

297 298 299 300
   (If you don't have shell access to your server, you may need to use
   a tool like PHPAdmin to create a database. Check your hosting
   service's documentation for how to create a new MySQL database.)

Evan Prodromou's avatar
Evan Prodromou committed
301
6. Create a new database account that StatusNet will use to access the
302 303
   database. If you have shell access, this will probably work from the
   MySQL shell:
Evan Prodromou's avatar
Evan Prodromou committed
304

305 306 307
       GRANT ALL on statusnet.*
       TO 'statusnetuser'@'localhost'
       IDENTIFIED BY 'statusnetpassword';
Evan Prodromou's avatar
Evan Prodromou committed
308

309
   You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
310 311 312
   username and password. You may want to test logging in to MySQL as
   this new user.

Evan Prodromou's avatar
Evan Prodromou committed
313
7. In a browser, navigate to the StatusNet install script; something like:
314

315
       http://yourserver.example.com/statusnet/install.php
316 317 318 319 320 321 322 323 324 325 326

   Enter the database connection information and your site name. The
   install program will configure your site and install the initial,
   almost-empty database.

8. You should now be able to navigate to your microblog's main directory
   and see the "Public Timeline", which will be empty. If not, magic
   has happened! You can now register a new user, post some notices,
   edit your profile, etc. However, you may want to wait to do that stuff
   if you think you can set up "fancy URLs" (see below), since some
   URLs are stored in the database.
Evan Prodromou's avatar
Evan Prodromou committed
327

328 329 330
Fancy URLs
----------

Evan Prodromou's avatar
Evan Prodromou committed
331
By default, StatusNet will use URLs that include the main PHP program's
332
name in them. For example, a user's home profile might be
333 334
found at:

335
    http://example.org/statusnet/index.php/statusnet/fred
336 337 338 339

On certain systems that don't support this kind of syntax, they'll
look like this:

340
    http://example.org/statusnet/index.php?p=statusnet/fred
341 342 343

It's possible to configure the software so it looks like this instead:

344
    http://example.org/statusnet/fred
345 346

These "fancy URLs" are more readable and memorable for users. To use
347
fancy URLs, you must either have Apache 2.x with .htaccess enabled and
348
mod_rewrite enabled, -OR- know how to configure "url redirection" in
349
your server.
350

Evan Prodromou's avatar
Evan Prodromou committed
351
1. Copy the htaccess.sample file to .htaccess in your StatusNet
352 353 354 355 356
   directory. Note: if you have control of your server's httpd.conf or
   similar configuration files, it can greatly improve performance to
   import the .htaccess file into your conf file instead. If you're
   not sure how to do it, you may save yourself a lot of headache by
   just leaving the .htaccess file.
Evan Prodromou's avatar
Evan Prodromou committed
357

358
2. Change the "RewriteBase" in the new .htaccess file to be the URL path
Evan Prodromou's avatar
Evan Prodromou committed
359 360
   to your StatusNet installation on your server. Typically this will
   be the path to your StatusNet directory relative to your Web root.
361 362 363 364

3. Add or uncomment or change a line in your config.php file so it says:

       $config['site']['fancy'] = true;
Evan Prodromou's avatar
Evan Prodromou committed
365

366 367 368
You should now be able to navigate to a "fancy" URL on your server,
like:

369
    http://example.net/statusnet/main/register
370 371 372 373

If you changed your HTTP server configuration, you may need to restart
the server first.

374 375 376 377 378 379
If it doesn't work, double-check that AllowOverride for the StatusNet
directory is 'All' in your Apache configuration file. This is usually
/etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
/etc/apache2/sites-available/default. See the Apache documentation for
.htaccess files for more details:

380
    http://httpd.apache.org/docs/2.2/howto/htaccess.html
381 382 383

Also, check that mod_rewrite is installed and enabled:

384
    http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
385

386 387 388
Sphinx
------

389 390
To use a Sphinx server to search users and notices, you'll need to
enable the SphinxSearch plugin. Add to your config.php:
391

392 393
    addPlugin('SphinxSearch');
    $config['sphinx']['server'] = 'searchhost.local';
394

395 396 397 398
You also need to install, compile and enable the sphinx pecl extension for
php on the client side, which itself depends on the sphinx development files.

See plugins/SphinxSearch/README for more details and server setup.
399

400 401 402
SMS
---

Evan Prodromou's avatar
Evan Prodromou committed
403
StatusNet supports a cheap-and-dirty system for sending update messages
404 405 406 407 408 409 410 411 412
to mobile phones and for receiving updates from the mobile. Instead of
sending through the SMS network itself, which is costly and requires
buy-in from the wireless carriers, it simply piggybacks on the email
gateways that many carriers provide to their customers. So, SMS
configuration is essentially email configuration.

Each user sends to a made-up email address, which they keep a secret.
Incoming email that is "From" the user's SMS email address, and "To"
the users' secret email address on the site's domain, will be
Evan Prodromou's avatar
Evan Prodromou committed
413
converted to a notice and stored in the DB.
414 415 416 417

For this to work, there *must* be a domain or sub-domain for which all
(or most) incoming email can pass through the incoming mail filter.

Evan Prodromou's avatar
Evan Prodromou committed
418
1. Run the SQL script carrier.sql in your StatusNet database. This will
419 420
   usually work:

421
       mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
422 423 424 425 426 427

   This will populate your database with a list of wireless carriers
   that support email SMS gateways.

2. Make sure the maildaemon.php file is executable:

428
       chmod +x scripts/maildaemon.php
Evan Prodromou's avatar
Evan Prodromou committed
429

430 431
   Note that "daemon" is kind of a misnomer here; the script is more
   of a filter than a daemon.
Evan Prodromou's avatar
Evan Prodromou committed
432

433 434
2. Edit /etc/aliases on your mail server and add the following line:

435
       *: /path/to/statusnet/scripts/maildaemon.php
436 437 438

3. Run whatever code you need to to update your aliases database. For
   many mail servers (Postfix, Exim, Sendmail), this should work:
Evan Prodromou's avatar
Evan Prodromou committed
439

440
       newaliases
Evan Prodromou's avatar
Evan Prodromou committed
441

442 443 444 445 446
   You may need to restart your mail server for the new database to
   take effect.

4. Set the following in your config.php file:

447
       $config['mail']['domain'] = 'yourdomain.example.net';
Evan Prodromou's avatar
Evan Prodromou committed
448

449 450
At this point, post-by-email and post-by-SMS-gateway should work. Note
that if your mail server is on a different computer from your email
Evan Prodromou's avatar
Evan Prodromou committed
451 452
server, you'll need to have a full installation of StatusNet, a working
config.php, and access to the StatusNet database from the mail server.
453 454 455 456

XMPP
----

457
XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
458 459 460 461 462 463 464 465
instant-messenger protocol that drives Jabber and GTalk IM. You can
distribute messages via XMPP using the system below; however, you
need to run the XMPP incoming daemon to allow incoming messages as
well.

1. You may want to strongly consider setting up your own XMPP server.
   Ejabberd, OpenFire, and JabberD are all Open Source servers.
   Jabber, Inc. provides a high-performance commercial server.
Evan Prodromou's avatar
Evan Prodromou committed
466

467 468 469 470
2. You must register a Jabber ID (JID) with your new server. It helps
   to choose a name like "update@example.com" or "notice" or something
   similar.  Alternately, your "update JID" can be registered on a
   publicly-available XMPP service, like jabber.org or GTalk.
Evan Prodromou's avatar
Evan Prodromou committed
471

Evan Prodromou's avatar
Evan Prodromou committed
472
   StatusNet will not register the JID with your chosen XMPP server;
473 474
   you need to do this manually, with an XMPP client like Gajim,
   Telepathy, or Pidgin.im.
Evan Prodromou's avatar
Evan Prodromou committed
475

476 477
3. Configure your site's XMPP variables, as described below in the
   configuration section.
Evan Prodromou's avatar
Evan Prodromou committed
478

479 480 481 482 483 484 485
On a default installation, your site can broadcast messages using
XMPP. Users won't be able to post messages using XMPP unless you've
got the XMPP daemon running.  See 'Queues and daemons' below for how
to set that up. Also, once you have a sizable number of users, sending
a lot of SMS, OMB, and XMPP messages whenever someone posts a message
can really slow down your site; it may cause posting to timeout.

486 487
NOTE: stream_select(), a crucial function for network programming, is
broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
Evan Prodromou's avatar
Evan Prodromou committed
488
work around this bug in StatusNet; current recommendation is to move
489 490
off of amd64 to another server.

491 492 493 494 495 496 497 498 499 500
Public feed
-----------

You can send *all* messages from your microblogging site to a
third-party service using XMPP. This can be useful for providing
search, indexing, bridging, or other cool services.

To configure a downstream site to receive your public stream, add
their "JID" (Jabber ID) to your config.php as follows:

501
    $config['xmpp']['public'][] = 'downstream@example.net';
Evan Prodromou's avatar
Evan Prodromou committed
502

503 504 505 506 507 508 509 510
(Don't miss those square brackets at the end.) Note that your XMPP
broadcasting must be configured as mentioned above. Although you can
send out messages at "Web time", high-volume sites should strongly
consider setting up queues and daemons.

Queues and daemons
------------------

Brion Vibber's avatar
Brion Vibber committed
511
Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
512 513 514 515 516 517 518 519 520 521
and XMPP messages, can be 'queued' and done by off-line bots instead.
For this to work, you must be able to run long-running offline
processes, either on your main Web server or on another server you
control. (Your other server will still need all the above
prerequisites, with the exception of Apache.) Installing on a separate
server is probably a good idea for high-volume sites.

1. You'll need the "CLI" (command-line interface) version of PHP
   installed on whatever server you use.

Evan Prodromou's avatar
Evan Prodromou committed
522
2. If you're using a separate server for queues, install StatusNet
523 524 525 526 527 528 529
   somewhere on the server. You don't need to worry about the
   .htaccess file, but make sure that your config.php file is close
   to, or identical to, your Web server's version.

3. In your config.php files (both the Web server and the queues
   server!), set the following variable:

530
       $config['queue']['enabled'] = true;
531 532 533 534 535

   You may also want to look at the 'daemon' section of this file for
   more daemon options. Note that if you set the 'user' and/or 'group'
   options, you'll need to create that user and/or group by hand.
   They're not created automatically.
Evan Prodromou's avatar
Evan Prodromou committed
536

Brion Vibber's avatar
Brion Vibber committed
537
4. On the queues server, run the command scripts/startdaemons.sh.
Evan Prodromou's avatar
Evan Prodromou committed
538

539
This will run the queue handlers:
540

541
* queuedaemon.php - polls for queued items for inbox processing and
Brion Vibber's avatar
Brion Vibber committed
542
  pushing out to OStatus, SMS, XMPP, etc.
543
* xmppdaemon.php - listens for new XMPP messages from users and stores
544 545 546 547 548 549 550
  them as notices in the database; also pulls queued XMPP output from
  queuedaemon.php to push out to clients.

These two daemons will automatically restart in most cases of failure
including memory leaks (if a memory_limit is set), but may still die
or behave oddly if they lose connections to the XMPP or queue servers.

Brion Vibber's avatar
Brion Vibber committed
551 552 553
Additional daemons may be also started by this script for certain
plugins, such as the Twitter bridge.

554
It may be a good idea to use a daemon-monitoring service, like 'monit',
555 556 557 558 559 560
to check their status and keep them running.

All the daemons write their process IDs (pids) to /var/run/ by
default. This can be useful for starting, stopping, and monitoring the
daemons.

561
Since version 0.8.0, it's now possible to use a STOMP server instead of
Brion Vibber's avatar
Brion Vibber committed
562 563 564 565 566
our kind of hacky home-grown DB-based queue solution. This is strongly
recommended for best response time, especially when using XMPP.

See the "queues" config section below for how to configure to use STOMP.
As of this writing, the software has been tested with ActiveMQ 5.3.
Evan Prodromou's avatar
Evan Prodromou committed
567

568 569 570
Themes
------

Evan Prodromou's avatar
Evan Prodromou committed
571
There are two themes shipped with this version of StatusNet: "identica",
Evan Prodromou's avatar
Evan Prodromou committed
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
which is what the Identi.ca site uses, and "default", which is a good
basis for other sites.

As of right now, your ability to change the theme is site-wide; users
can't choose their own theme. Additionally, the only thing you can
change in the theme is CSS stylesheets and some image files; you can't
change the HTML output, like adding or removing menu items.

You can choose a theme using the $config['site']['theme'] element in
the config.php file. See below for details.

You can add your own theme by making a sub-directory of the 'theme'
subdirectory with the name of your theme. Each theme can have the
following files:

display.css: a CSS2 file for "default" styling for all browsers.
ie6.css: a CSS2 file for override styling for fixing up Internet
589
    Explorer 6.
Evan Prodromou's avatar
Evan Prodromou committed
590
ie7.css: a CSS2 file for override styling for fixing up Internet
591
    Explorer 7.
Evan Prodromou's avatar
Evan Prodromou committed
592 593
logo.png: a logo image for the site.
default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
594
    users who don't upload their own.
Evan Prodromou's avatar
Evan Prodromou committed
595 596
default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
597
    listing on profile pages.
Evan Prodromou's avatar
Evan Prodromou committed
598 599 600 601

You may want to start by copying the files from the default theme to
your own directory.

Evan Prodromou's avatar
Evan Prodromou committed
602
NOTE: the HTML generated by StatusNet changed *radically* between
Evan Prodromou's avatar
Evan Prodromou committed
603 604 605
version 0.6.x and 0.7.x. Older themes will need signification
modification to use the new output format.

606 607 608
Translation
-----------

Evan Prodromou's avatar
Evan Prodromou committed
609
Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
Evan Prodromou's avatar
Evan Prodromou committed
610 611 612 613
Theoretically, you can add your own sub-directory to the locale/
subdirectory to add a new language to your system. You'll need to
compile the ".po" files into ".mo" files, however.

Evan Prodromou's avatar
Evan Prodromou committed
614
Contributions of translation information to StatusNet are very easy:
615
you can use the Web interface at translatewiki.net to add one
616 617 618
or a few or lots of new translations -- or even new languages. You can
also download more up-to-date .po files there, if you so desire.

619 620
For info on helping with translations, see http://status.net/wiki/Translations

621 622 623
Backups
-------

Evan Prodromou's avatar
Evan Prodromou committed
624 625
There is no built-in system for doing backups in StatusNet. You can make
backups of a working StatusNet system by backing up the database and
626
the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
627 628
and to backup the Web directory, try tar.

629 630 631 632 633 634 635 636
Private
-------

The administrator can set the "private" flag for a site so that it's
not visible to non-logged-in users. This might be useful for
workgroups who want to share a microblogging site for project
management, but host it on a public server.

Evan Prodromou's avatar
Evan Prodromou committed
637 638 639 640
Total privacy is not guaranteed or ensured. Also, privacy is
all-or-nothing for a site; you can't have some accounts or notices
private, and others public. The interaction of private sites
with OStatus is undefined.
641

642 643 644 645
Access to file attachments can also be restricted to logged-in users only.
1. Add a directory outside the web root where your file uploads will be
   stored. Usually a command like this will work:

646
       mkdir /var/www/statusnet-files
647 648 649 650

2. Make the file uploads directory writeable by the web server. An
   insecure way to do this is:

651
       chmod a+x /var/www/statusnet-files
652 653 654 655

3. Tell StatusNet to use this directory for file uploads. Add a line
   like this to your config.php:

656
       $config['attachments']['dir'] = '/var/www/statusnet-files';
657

658 659 660
Upgrading
=========

Evan Prodromou's avatar
Evan Prodromou committed
661
IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
662 663 664 665 666 667
incorrectly-stored international characters ("UTF-8"). For new
installations, it will now store non-ASCII characters correctly.
However, older installations will have the incorrect storage, and will
consequently show up "wrong" in browsers. See below for how to deal
with this situation.

Evan Prodromou's avatar
Evan Prodromou committed
668
If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
669 670
been tracking the "git" version of the software, you will probably
want to upgrade and keep your existing data. There is no automated
Brion Vibber's avatar
Brion Vibber committed
671
upgrade procedure in StatusNet 0.9.6. Try these step-by-step
672
instructions; read to the end first before trying them.
Evan Prodromou's avatar
Evan Prodromou committed
673

Evan Prodromou's avatar
Evan Prodromou committed
674
0. Download StatusNet and set up all the prerequisites as if you were
Evan Prodromou's avatar
Evan Prodromou committed
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
   doing a new install.
1. Make backups of both your database and your Web directory. UNDER NO
   CIRCUMSTANCES should you try to do an upgrade without a known-good
   backup. You have been warned.
2. Shut down Web access to your site, either by turning off your Web
   server or by redirecting all pages to a "sorry, under maintenance"
   page.
3. Shut down XMPP access to your site, typically by shutting down the
   xmppdaemon.php process and all other daemons that you're running.
   If you've got "monit" or "cron" automatically restarting your
   daemons, make sure to turn that off, too.
4. Shut down SMS and email access to your site. The easy way to do
   this is to comment out the line piping incoming email to your
   maildaemon.php file, and running something like "newaliases".
5. Once all writing processes to your site are turned off, make a
   final backup of the Web directory and database.
691
6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
Brion Vibber's avatar
Brion Vibber committed
692
7. Unpack your StatusNet 0.9.6 tarball and move it to "statusnet" or
Evan Prodromou's avatar
Evan Prodromou committed
693
   wherever your code used to be.
694 695 696
8. Copy the config.php file and the contents of the avatar/, background/,
   file/, and local/ subdirectories from your old directory to your new
   directory.
Evan Prodromou's avatar
Evan Prodromou committed
697 698
9. Copy htaccess.sample to .htaccess in the new directory. Change the
   RewriteBase to use the correct path.
699
10. Rebuild the database. (You can safely skip this step and go to #12
700
    if you're upgrading from another 0.9.x version).
701 702

    NOTE: this step is destructive and cannot be
703 704 705
    reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
    do it without a known-good backup!

Evan Prodromou's avatar
Evan Prodromou committed
706 707
    If your database is at version 0.8.0 or above, you can run a
    special upgrade script:
708

709
        mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
710

Evan Prodromou's avatar
Evan Prodromou committed
711
    Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
712
    BACKUP run the rebuilddb.sh script like this:
713

714
        ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
715 716 717

    Here, rootuser and rootpassword are the username and password for a
    user who can drop and create databases as well as tables; typically
Evan Prodromou's avatar
Evan Prodromou committed
718
    that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
719 720
    your database and rebuilds it; if there is an error you have no
    database. Make sure you have a backup.
721 722 723 724 725
    For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
    which operates slightly differently. Read the documentation in that
    script before running it.
11. Use mysql or psql client to log into your database and make sure that
    the notice, user, profile, subscription etc. tables are non-empty.
Evan Prodromou's avatar
Evan Prodromou committed
726 727 728 729 730 731
12. Turn back on the Web server, and check that things still work.
13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
    bots have changed since version 0.5; see above for details.

If you're upgrading from very old versions, you may want to look at
the fixup_* scripts in the scripts directories. These will store some
732 733
precooked data in the DB. All upgraders should check out the inboxes
options below.
Evan Prodromou's avatar
Evan Prodromou committed
734

735
NOTE: the database definition file, laconica.ini, has been renamed to
736
statusnet.ini (since this is the recommended database name). If you
737 738 739
have a line in your config.php pointing to the old name, you'll need
to update it.

740 741 742
Notice inboxes
--------------

Evan Prodromou's avatar
Evan Prodromou committed
743 744
Notice inboxes are now required. If you don't have inboxes enabled,
StatusNet will no longer run.
745

746 747 748
UTF-8 Database
--------------

Evan Prodromou's avatar
Evan Prodromou committed
749
StatusNet 0.7.4 introduced a fix for some incorrectly-stored
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
international characters ("UTF-8"). This fix is not
backwards-compatible; installations from before 0.7.4 will show
non-ASCII characters of old notices incorrectly. This section explains
what to do.

0. You can disable the new behaviour by setting the 'db''utf8' config
   option to "false". You should only do this until you're ready to
   convert your DB to the new format.
1. When you're ready to convert, you can run the fixup_utf8.php script
   in the scripts/ subdirectory. If you've had the "new behaviour"
   enabled (probably a good idea), you can give the ID of the first
   "new" notice as a parameter, and only notices before that one will
   be converted. Notices are converted in reverse chronological order,
   so the most recent (and visible) ones will be converted first. The
   script should work whether or not you have the 'db''utf8' config
   option enabled.
2. When you're ready, set $config['db']['utf8'] to true, so that
   new notices will be stored correctly.

769 770 771
Configuration options
=====================

Evan Prodromou's avatar
Evan Prodromou committed
772 773
The main configuration file for StatusNet (excepting configurations for
dependency software) is config.php in your StatusNet directory. If you
Evan Prodromou's avatar
Evan Prodromou committed
774
edit any other file in the directory, like lib/default.php (where most
775 776 777
of the defaults are defined), you will lose your configuration options
in any upgrade, and you will wish that you had been more careful.

Evan Prodromou's avatar
Evan Prodromou committed
778 779 780 781 782 783 784
Starting with version 0.9.0, a Web based configuration panel has been
added to StatusNet. The preferred method for changing config options is
to use this panel.

A command-line script, setconfig.php, can be used to set individual
configuration options. It's in the scripts/ directory.

785
Starting with version 0.7.1, you can put config files in the
786
/etc/statusnet/ directory on your server, if it exists. Config files
787 788
will be included in this order:

789
* /etc/statusnet/statusnet.php - server-wide config
790 791
* /etc/statusnet/<servername>.php - for a virtual host
* /etc/statusnet/<servername>_<pathname>.php - for a path
792 793
* INSTALLDIR/config.php - for a particular implementation

794 795 796 797
Almost all configuration options are made through a two-dimensional
associative array, cleverly named $config. A typical configuration
line will be:

798
    $config['section']['option'] = value;
799 800 801 802 803 804 805 806 807 808 809

For brevity, the following documentation describes each section and
option.

site
----

This section is a catch-all for site-wide variables.

name: the name of your site, like 'YourCompany Microblog'.
server: the server part of your site's URLs, like 'example.net'.
810
path: The path part of your site's URLs, like 'statusnet' or ''
811
    (installed in root).
812
fancy: whether or not your site uses fancy URLs (see Fancy URLs
813
    section above). Default is false.
Evan Prodromou's avatar
Evan Prodromou committed
814
logfile: full path to a file for StatusNet to save logging
815 816
    information to. You may want to use this if you don't have
    access to syslog.
Evan Prodromou's avatar
Evan Prodromou committed
817
logdebug: whether to log additional debug info like backtraces on
818
    hard errors. Default false.
819
locale_path: full path to the directory for locale data. Unless you
820 821
    store all your locale data in one place, you probably
    don't need to use this.
822
language: default language for your site. Defaults to US English.
823 824 825 826 827 828
    Note that this is overridden if a user is logged in and has
    selected a different language. It is also overridden if the
    user is NOT logged in, but their browser requests a different
    langauge. Since pretty much everybody's browser requests a
    language, that means that changing this setting has little or
    no effect in practice.
829
languages: A list of languages supported on your site. Typically you'd
830 831 832 833
    only change this if you wanted to disable support for one
    or another language:
    "unset($config['site']['languages']['de'])" will disable
    support for German.
834
theme: Theme for your site (see Theme section). Two themes are
835 836 837
    provided by default: 'default' and 'stoica' (the one used by
    Identi.ca). It's appreciated if you don't use the 'stoica' theme
    except as the basis for your own.
838
email: contact email address for your site. By default, it's extracted
839
    from your Web server environment; you may want to customize it.
840
broughtbyurl: name of an organization or individual who provides the
841 842 843
    service. Each page will include a link to this name in the
    footer. A good way to link to the blog, forum, wiki,
    corporate portal, or whoever is making the service available.
844 845
broughtby: text used for the "brought by" link.
timezone: default timezone for message display. Users can set their
846
    own time zone. Defaults to 'UTC', which is a pretty good default.
847
closed: If set to 'true', will disallow registration on your site.
848 849 850
    This is a cheap way to restrict accounts to only one
    individual or group; just register the accounts you want on
    the service, *then* set this variable to 'true'.
851
inviteonly: If set to 'true', will only allow registration if the user
852
    was invited by an existing user.
Evan Prodromou's avatar
Evan Prodromou committed
853
private: If set to 'true', anonymous users will be redirected to the
854 855 856 857
    'login' page. Also, API methods that normally require no
    authentication will require it. Note that this does not turn
    off registration; use 'closed' or 'inviteonly' for the
    behaviour you want.
858
notice: A plain string that will appear on every page. A good place
859 860
    to put introductory information about your service, or info about
    upgrades and outages, or other community info. Any HTML will
861
    be escaped.
862
logo: URL of an image file to use as the logo for the site. Overrides
863
    the logo in the theme, if any.
864 865
ssllogo: URL of an image file to use as the logo on SSL pages. If unset,
    theme logo is used instead.
866
ssl: Whether to use SSL and https:// URLs for some or all pages.
867 868 869 870
    Possible values are 'always' (use it for all pages), 'never'
    (don't use it for any pages), or 'sometimes' (use it for
    sensitive pages that include passwords like login and registration,
    but not for regular pages). Default to 'never'.
871
sslserver: use an alternate server name for SSL URLs, like
872 873 874 875
    'secure.example.org'. You should be careful to set cookie
    parameters correctly so that both the SSL server and the
    "normal" server can access the session cookie and
    preferably other cookies as well.
876
shorturllength: Length of URL at which URLs in a message exceeding 140
877 878
    characters will be sent to the user's chosen
    shortening service.
Evan Prodromou's avatar
Evan Prodromou committed
879
dupelimit: minimum time allowed for one person to say the same thing
880 881
    twice. Default 60s. Anything lower is considered a user
    or UI error.
882
textlimit: default max size for texts in the site. Defaults to 140.
883 884
    0 means no limit. Can be fine-tuned for notices, messages,
    profile bios and group descriptions.
885

886 887 888 889
db
--

This section is a reference to the configuration options for
890
DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
891 892
set are listed below for clarity.

Evan Prodromou's avatar
Evan Prodromou committed
893
database: a DSN (Data Source Name) for your StatusNet database. This is
894 895 896 897
    in the format 'protocol://username:password@hostname/databasename',
    where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
    really know what you're doing), 'username' is the username,
    'password' is the password, and etc.
898
ini_yourdbname: if your database is not named 'statusnet', you'll need
899 900 901
    to set this to point to the location of the
    statusnet.ini file. Note that the real name of your database
    should go in there, not literally 'yourdbname'.
902
db_driver: You can try changing this to 'MDB2' to use the other driver
903 904
    type for DB_DataObject, but note that it breaks the OpenID
    libraries, which only support PEAR::DB.
905
debug: On a database error, you may get a message saying to set this
906 907 908
    value to 5 to see debug messages in the browser. This breaks
    just about all pages, and will also expose the username and
    password
909 910
quote_identifiers: Set this to true if you're using postgresql.
type: either 'mysql' or 'postgresql' (used for some bits of
911
    database-type-specific SQL in the code). Defaults to mysql.
912
mirror: you can set this to an array of DSNs, like the above
913 914 915 916 917 918 919
    'database' value. If it's set, certain read-only actions will
    use a random value out of this array for the database, rather
    than the one in 'database' (actually, 'database' is overwritten).
    You can offload a busy DB server by setting up MySQL replication
    and adding the slaves to this array. Note that if you want some
    requests to go to the 'database' (master) server, you'll need
    to include it in this array, too.
920
utf8: whether to talk to the database in UTF-8 mode. This is the default
921 922 923
    with new installations, but older sites may want to turn it off
    until they get their databases fixed up. See "UTF-8 database"
    above for details.
Evan Prodromou's avatar
Evan Prodromou committed
924
schemacheck: when to let plugins check the database schema to add
925 926 927 928 929 930 931
    tables or update them. Values can be 'runtime' (default)
    or 'script'. 'runtime' can be costly (plugins check the
    schema on every hit, adding potentially several db
    queries, some quite long), but not everyone knows how to
    run a script. If you can, set this to 'script' and run
    scripts/checkschema.php whenever you install or upgrade a
    plugin.
932

933 934 935
syslog
------

Evan Prodromou's avatar
Evan Prodromou committed
936
By default, StatusNet sites log error messages to the syslog facility.
937 938
(You can override this using the 'logfile' parameter described above).

Evan Prodromou's avatar
Evan Prodromou committed
939
appname: The name that StatusNet uses to log messages. By default it's
940 941 942
    "statusnet", but if you have more than one installation on the
    server, you may want to change the name for each instance so
    you can track log messages more easily.
Evan Prodromou's avatar
Evan Prodromou committed
943 944
priority: level to log at. Currently ignored.
facility: what syslog facility to used. Defaults to LOG_USER, only
945 946
    reset if you know what syslog is and have a good reason
    to change it.
947 948 949 950 951 952 953 954

queue
-----

You can configure the software to queue time-consuming tasks, like
sending out SMS email or XMPP messages, for off-line processing. See
'Queues and daemons' above for how to set this up.

Evan Prodromou's avatar
Evan Prodromou committed
955
enabled: Whether to uses queues. Defaults to false.
Evan Prodromou's avatar
Evan Prodromou committed
956
subsystem: Which kind of queueserver to use. Values include "db" for
957 958
    our hacked-together database queuing (no other server
    required) and "stomp" for a stomp server.
Evan Prodromou's avatar
Evan Prodromou committed
959
stomp_server: "broker URI" for stomp server. Something like
960 961 962
    "tcp://hostname:61613". More complicated ones are
    possible; see your stomp server's documentation for
    details.
Evan Prodromou's avatar
Evan Prodromou committed
963
queue_basename: a root name to use for queues (stomp only). Typically
964 965 966 967
    something like '/queue/sitename/' makes sense. If running
    multiple instances on the same server, make sure that
    either this setting or $config['site']['nickname'] are
    unique for each site to keep them separate.
Evan Prodromou's avatar
Evan Prodromou committed
968

Evan Prodromou's avatar
Evan Prodromou committed
969
stomp_username: username for connecting to the stomp server; defaults
970
    to null.
Evan Prodromou's avatar
Evan Prodromou committed
971
stomp_password: password for connecting to the stomp server; defaults
972
    to null.
Brion Vibber's avatar
Brion Vibber committed
973 974

stomp_persistent: keep items across queue server restart, if enabled.
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
    Under ActiveMQ, the server configuration determines if and how
    persistent storage is actually saved.

    If using a message queue server other than ActiveMQ, you may
    need to disable this if it does not support persistence.

stomp_transactions: use transactions to aid in error detection.
    A broken transaction will be seen quickly, allowing a message
    to be redelivered immediately if a daemon crashes.

    If using a message queue server other than ActiveMQ, you may
    need to disable this if it does not support transactions.

stomp_acks: send acknowledgements to aid in flow control.
    An acknowledgement of successful processing tells the server
    we're ready for more and can help keep things moving smoothly.

    This should *not* be turned off when running with ActiveMQ, but
    if using another message queue server that does not support
    acknowledgements you might need to disable this.
Brion Vibber's avatar
Brion Vibber committed
995 996

softlimit: an absolute or relative "soft memory limit"; daemons will
997 998 999
    restart themselves gracefully when they find they've hit
    this amount of memory usage. Defaults to 90% of PHP's global
    memory_limit setting.
Brion Vibber's avatar
Brion Vibber committed
1000 1001

inboxes: delivery of messages to receiver's inboxes can be delayed to
1002 1003 1004
    queue time for best interactive performance on the sender.
    This may however be annoyingly slow when using the DB queues,
    so you can set this to false if it's causing trouble.
Brion Vibber's avatar
Brion Vibber committed
1005 1006

breakout: for stomp, individual queues are by default grouped up for
1007 1008
    best scalability. If some need to be run by separate daemons,
    etc they can be manually adjusted here.
Brion Vibber's avatar
Brion Vibber committed
1009

1010 1011 1012
        Default will share all queues for all sites within each group.
        Specify as <group>/<queue> or <group>/<queue>/<site>,
        using nickname identifier as site.
Brion Vibber's avatar
Brion Vibber committed
1013

1014 1015
        'main/distrib' separate "distrib" queue covering all sites
        'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
Brion Vibber's avatar
Brion Vibber committed
1016 1017

max_retries: for stomp, drop messages after N failed attempts to process.
1018
    Defaults to 10.
Brion Vibber's avatar
Brion Vibber committed
1019 1020

dead_letter_dir: for stomp, optional directory to dump data on failed
1021
    queue processing events after discarding them.
Brion Vibber's avatar
Brion Vibber committed
1022

1023 1024 1025 1026 1027 1028
stomp_no_transactions: for stomp, the server does not support transactions,
    so do not try to user them. This is needed for http://www.morbidq.com/.

stomp_no_acks: for stomp, the server does not support acknowledgements.
    so do not try to user them. This is needed for http://www.morbidq.com/.

Evan Prodromou's avatar
Evan Prodromou committed
1029 1030 1031 1032 1033 1034 1035
license
-------

The default license to use for your users notices. The default is the
Creative Commons Attribution 3.0 license, which is probably the right
choice for any public site. Note that some other servers will not
accept notices if you apply a stricter license than this.
1036

1037
type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1038 1039
    (default copyright), or 'private' (for private and confidential
    information).
1040
owner: for 'allrightsreserved' or 'private', an assigned copyright
1041 1042
    holder (for example, an employer for a private site). If
    not specified, will be attributed to 'contributors'.
Evan Prodromou's avatar
Evan Prodromou committed
1043 1044 1045 1046 1047
url: URL of the license, used for links.
title: Title for the license, like 'Creative Commons Attribution 3.0'.
image: A button shown on each page for the license.

mail
1048 1049
----

Evan Prodromou's avatar
Evan Prodromou committed
1050 1051
This is for configuring out-going email. We use PEAR's Mail module,
see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1052

Evan Prodromou's avatar
Evan Prodromou committed
1053
backend: the backend to use for mail, one of 'mail', 'sendmail', and
1054
    'smtp'. Defaults to PEAR's default, 'mail'.
Evan Prodromou's avatar
Evan Prodromou committed
1055
params: if the mail backend requires any parameters, you can provide
1056
    them in an associative array.
Evan Prodromou's avatar
Evan Prodromou committed
1057

Evan Prodromou's avatar
Evan Prodromou committed
1058 1059 1060 1061 1062 1063
nickname
--------

This is for configuring nicknames in the service.

blacklist: an array of strings for usernames that may not be
1064 1065 1066 1067