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

Brion Vibber's avatar
Brion Vibber committed
5 6
StatusNet 0.9.5 "What's The Frequency, Kenneth?"
10 September 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
=====

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.

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
================

99 100
This is a security, bug and feature release since version 0.9.4 released on
16 August 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.
105

106 107
Notable changes this version:

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
- Change of license for default themes and documentation from
  AGPLv3 to CC-By 3.0 Unported.
- An experimental TinyMCE plugin to do in-browser rich editing of
  status updates. Does not support StatusNet syntax like @-replies or
  #hashtags very well.
- An experimental plugin to add titles to notices.
- A plugin to support the Echo <http://aboutecho.com/> commenting
  system.
- A plugin to support the Disqus <http://disqus.com/> commenting system.
- Changes to OStatus support to make StatusNet work for the Social Web
  Acid Test Level 0 <http://federatedsocialweb.net/wiki/SWAT0>.
- Themes now support a theme.ini file for theme configuration, including
  defining a "base" theme.
- Improved two-way Twitter integration, including support for
  repeats and retweets, replies, and faves going both ways across the
  bridge, as well as better parsing of Twitter statuses.

A full changelog is available at http://status.net/wiki/StatusNet_0.9.5.
Evan Prodromou's avatar
Evan Prodromou committed
126

127 128 129 130 131 132
Prerequisites
=============

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

133
- PHP 5.2.3+. It may be possible to run this software on earlier
134
  versions of PHP, but many of the functions used are only available
135
  in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
136 137
  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
138
- MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
139 140 141 142 143
  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
144
  mod_rewrite extension installed and enabled.
145 146 147 148 149 150

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
151
- GD. For scaling down avatar images.
152
- mbstring. For handling Unicode (UTF-8) encoded strings.
153 154 155 156 157 158 159 160 161

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.
162 163 164
- 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.
165 166
- bcmath or gmp. For Salmon signatures (part of OStatus). Needed
  if you have OStatus configured.
167 168
- gettext. For multiple languages. Default on many PHP installs;
  will be emulated if not present.
169

170 171 172 173 174 175 176 177 178 179 180 181 182 183
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.
184

Evan Prodromou's avatar
Evan Prodromou committed
185 186
- DB_DataObject http://pear.php.net/package/DB_DataObject
- Validate http://pear.php.net/package/Validate
187
- OpenID from OpenIDEnabled (not the PEAR version!). We decided
Evan Prodromou's avatar
Evan Prodromou committed
188
  to use the openidenabled.com version since it's more widely
189
  implemented, and seems to be better supported.
190
  http://openidenabled.com/php-openid/
191 192 193 194 195 196
- 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
197
- OAuth.php from http://oauth.googlecode.com/svn/code/php/
198
- markdown.php from http://michelf.com/projects/php-markdown/
Evan Prodromou's avatar
Evan Prodromou committed
199
- PEAR Mail, for sending out mail notifications
200
  http://pear.php.net/package/Mail
Evan Prodromou's avatar
Evan Prodromou committed
201
- PEAR Net_SMTP, if you use the SMTP factory for notifications
202
  http://pear.php.net/package/Net_SMTP
Evan Prodromou's avatar
Evan Prodromou committed
203 204
- PEAR Net_Socket, if you use the SMTP factory for notifications
  http://pear.php.net/package/Net_Socket
205 206 207 208 209
- 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
210
  version may render your StatusNet site unable to send or receive XMPP
211
  messages.
Evan Prodromou's avatar
Evan Prodromou committed
212
- Facebook library. Used for the Facebook application.
213 214
- PEAR Services_oEmbed. Used for some multimedia integration.
- PEAR HTTP_Request is an oEmbed dependency.
215 216
- PEAR Validate is an oEmbed dependency.
- PEAR Net_URL2 is an oEmbed dependency.
217
- Console_GetOpt for parsing command-line options.
218 219 220
- libomb. a library for implementing OpenMicroBlogging 0.1, the
  predecessor to OStatus.
- HTTP_Request2, a library for making HTTP requests.
221

Evan Prodromou's avatar
Evan Prodromou committed
222
A design goal of StatusNet is that the basic Web functionality should
223 224 225 226 227 228 229 230 231
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
232
Installing the basic StatusNet Web component is relatively easy,
233 234 235 236
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:
237

238
       tar zxf statusnet-0.9.5.tar.gz
239

240
   ...which will make a statusnet-0.9.5 subdirectory in your current
241 242 243
   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.)
244

245 246
2. Move the tarball to a directory of your choosing in your Web root
   directory. Usually something like this will work:
247

248
       mv statusnet-0.9.5 /var/www/statusnet
249

250 251
   This will make your StatusNet instance available in the statusnet path of
   your server, like "http://example.net/statusnet". "microblog" or
252
   "statusnet" might also be good path names. If you know how to
253 254
   configure virtual hosts on your web server, you can try setting up
   "http://micro.example.net/" or the like.
255

256
3. Make your target directory writeable by the Web server.
257

258
       chmod a+w /var/www/statusnet/
259

260
   On some systems, this will probably work:
261

262
       chgrp www-data /var/www/statusnet/
263
       chmod g+w /var/www/statusnet/
264 265 266

   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
267
   a new group like "statusnet" and add the Web server's user to the group.
268

269 270 271
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:
272

273 274 275
       chmod a+w /var/www/statusnet/avatar
       chmod a+w /var/www/statusnet/background
       chmod a+w /var/www/statusnet/file
276

277 278
   You can also make the avatar, background, and file directories
   writeable by the Web server group, as noted above.
279 280

5. Create a database to hold your microblog data. Something like this
281
   should work:
282

283
       mysqladmin -u "username" --password="password" create statusnet
284

Evan Prodromou's avatar
Evan Prodromou committed
285
   Note that StatusNet must have its own database; you can't share the
286 287
   database with another program. You can name it whatever you want,
   though.
288

289 290 291 292
   (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
293
6. Create a new database account that StatusNet will use to access the
294 295
   database. If you have shell access, this will probably work from the
   MySQL shell:
296

297 298 299
       GRANT ALL on statusnet.*
       TO 'statusnetuser'@'localhost'
       IDENTIFIED BY 'statusnetpassword';
300

301
   You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
302 303 304
   username and password. You may want to test logging in to MySQL as
   this new user.

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

307
       http://yourserver.example.com/statusnet/install.php
308 309 310 311 312 313 314 315 316 317 318

   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.
319

320 321 322
Fancy URLs
----------

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

327
    http://example.org/statusnet/index.php/statusnet/fred
328 329 330 331

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

332
    http://example.org/statusnet/index.php?p=statusnet/fred
333 334 335

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

336
    http://example.org/statusnet/fred
337 338

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

Evan Prodromou's avatar
Evan Prodromou committed
343
1. Copy the htaccess.sample file to .htaccess in your StatusNet
344 345 346 347 348
   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.
349

350
2. Change the "RewriteBase" in the new .htaccess file to be the URL path
Evan Prodromou's avatar
Evan Prodromou committed
351 352
   to your StatusNet installation on your server. Typically this will
   be the path to your StatusNet directory relative to your Web root.
353 354 355 356

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

       $config['site']['fancy'] = true;
357

358 359 360
You should now be able to navigate to a "fancy" URL on your server,
like:

361
    http://example.net/statusnet/main/register
362 363 364 365

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

366 367 368 369 370 371
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:

372
    http://httpd.apache.org/docs/2.2/howto/htaccess.html
373 374 375

Also, check that mod_rewrite is installed and enabled:

376
    http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
377

378 379 380
Sphinx
------

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

384 385
    addPlugin('SphinxSearch');
    $config['sphinx']['server'] = 'searchhost.local';
386

387 388 389 390
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.
391

392 393 394
SMS
---

Evan Prodromou's avatar
Evan Prodromou committed
395
StatusNet supports a cheap-and-dirty system for sending update messages
396 397 398 399 400 401 402 403 404
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
405
converted to a notice and stored in the DB.
406 407 408 409

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
410
1. Run the SQL script carrier.sql in your StatusNet database. This will
411 412
   usually work:

413
       mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
414 415 416 417 418 419

   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:

420
       chmod +x scripts/maildaemon.php
421

422 423
   Note that "daemon" is kind of a misnomer here; the script is more
   of a filter than a daemon.
424

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

427
       *: /path/to/statusnet/scripts/maildaemon.php
428 429 430

3. Run whatever code you need to to update your aliases database. For
   many mail servers (Postfix, Exim, Sendmail), this should work:
431

432
       newaliases
433

434 435 436 437 438
   You may need to restart your mail server for the new database to
   take effect.

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

439
       $config['mail']['domain'] = 'yourdomain.example.net';
440

441 442
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
443 444
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.
445 446 447 448

XMPP
----

449
XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
450 451 452 453 454 455 456 457
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.
458

459 460 461 462
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.
463

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

468 469
3. Configure your site's XMPP variables, as described below in the
   configuration section.
470

471 472 473 474 475 476 477
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.

478 479
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
480
work around this bug in StatusNet; current recommendation is to move
481 482
off of amd64 to another server.

483 484 485 486 487 488 489 490 491 492
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:

493
    $config['xmpp']['public'][] = 'downstream@example.net';
494

495 496 497 498 499 500 501 502
(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
------------------

503
Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
504 505 506 507 508 509 510 511 512 513
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
514
2. If you're using a separate server for queues, install StatusNet
515 516 517 518 519 520 521
   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:

522
       $config['queue']['enabled'] = true;
523 524 525 526 527

   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.
528

529
4. On the queues server, run the command scripts/startdaemons.sh.
530

531
This will run the queue handlers:
532

533
* queuedaemon.php - polls for queued items for inbox processing and
534
  pushing out to OStatus, SMS, XMPP, etc.
535
* xmppdaemon.php - listens for new XMPP messages from users and stores
536 537 538 539 540 541 542
  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.

543 544 545
Additional daemons may be also started by this script for certain
plugins, such as the Twitter bridge.

546
It may be a good idea to use a daemon-monitoring service, like 'monit',
547 548 549 550 551 552
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.

553
Since version 0.8.0, it's now possible to use a STOMP server instead of
554 555 556 557 558
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.
559

560 561 562
Themes
------

Evan Prodromou's avatar
Evan Prodromou committed
563
There are two themes shipped with this version of StatusNet: "identica",
Evan Prodromou's avatar
Evan Prodromou committed
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
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
581
    Explorer 6.
Evan Prodromou's avatar
Evan Prodromou committed
582
ie7.css: a CSS2 file for override styling for fixing up Internet
583
    Explorer 7.
Evan Prodromou's avatar
Evan Prodromou committed
584 585
logo.png: a logo image for the site.
default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
586
    users who don't upload their own.
Evan Prodromou's avatar
Evan Prodromou committed
587 588
default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
589
    listing on profile pages.
Evan Prodromou's avatar
Evan Prodromou committed
590 591 592 593

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

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

598 599 600
Translation
-----------

Evan Prodromou's avatar
Evan Prodromou committed
601
Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
Evan Prodromou's avatar
Evan Prodromou committed
602 603 604 605
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
606
Contributions of translation information to StatusNet are very easy:
607
you can use the Web interface at TranslateWiki.net to add one
608 609 610
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.

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

613 614 615
Backups
-------

Evan Prodromou's avatar
Evan Prodromou committed
616 617
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
618
the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
619 620
and to backup the Web directory, try tar.

621 622 623 624 625 626 627 628
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.

629 630 631 632
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.
633

634 635 636 637
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:

638
       mkdir /var/www/statusnet-files
639 640 641 642

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

643
       chmod a+x /var/www/statusnet-files
644 645 646 647

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

648
       $config['attachments']['dir'] = '/var/www/statusnet-files';
649

650 651 652
Upgrading
=========

Evan Prodromou's avatar
Evan Prodromou committed
653
IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
654 655 656 657 658 659
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
660
If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
661 662
been tracking the "git" version of the software, you will probably
want to upgrade and keep your existing data. There is no automated
663
upgrade procedure in StatusNet 0.9.5. Try these step-by-step
664
instructions; read to the end first before trying them.
Evan Prodromou's avatar
Evan Prodromou committed
665

Evan Prodromou's avatar
Evan Prodromou committed
666
0. Download StatusNet and set up all the prerequisites as if you were
Evan Prodromou's avatar
Evan Prodromou committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
   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.
683
6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
684
7. Unpack your StatusNet 0.9.5 tarball and move it to "statusnet" or
Evan Prodromou's avatar
Evan Prodromou committed
685 686 687 688 689
   wherever your code used to be.
8. Copy the config.php file and avatar directory from your old
   directory to your new directory.
9. Copy htaccess.sample to .htaccess in the new directory. Change the
   RewriteBase to use the correct path.
690
10. Rebuild the database. (You can safely skip this step and go to #12
691
    if you're upgrading from another 0.9.x version).
692 693

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

697 698
    If your database is at version 0.8.0 or above, you can run a
    special upgrade script:
699

700
        mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
701

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

705
        ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
706 707 708

    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
709
    that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
710 711
    your database and rebuilds it; if there is an error you have no
    database. Make sure you have a backup.
712 713 714 715 716
    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
717 718 719 720 721 722
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
723 724
precooked data in the DB. All upgraders should check out the inboxes
options below.
Evan Prodromou's avatar
Evan Prodromou committed
725

726
NOTE: the database definition file, laconica.ini, has been renamed to
727
statusnet.ini (since this is the recommended database name). If you
728 729 730
have a line in your config.php pointing to the old name, you'll need
to update it.

731 732 733
Notice inboxes
--------------

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

737 738 739
UTF-8 Database
--------------

Evan Prodromou's avatar
Evan Prodromou committed
740
StatusNet 0.7.4 introduced a fix for some incorrectly-stored
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
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.

760 761 762
Configuration options
=====================

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

769 770 771 772 773 774 775
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.

776
Starting with version 0.7.1, you can put config files in the
777
/etc/statusnet/ directory on your server, if it exists. Config files
778 779
will be included in this order:

780
* /etc/statusnet/statusnet.php - server-wide config
781 782
* /etc/statusnet/<servername>.php - for a virtual host
* /etc/statusnet/<servername>_<pathname>.php - for a path
783 784
* INSTALLDIR/config.php - for a particular implementation

785 786 787 788
Almost all configuration options are made through a two-dimensional
associative array, cleverly named $config. A typical configuration
line will be:

789
    $config['section']['option'] = value;
790 791 792 793 794 795 796 797 798 799 800

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'.
801
path: The path part of your site's URLs, like 'statusnet' or ''
802
    (installed in root).
803
fancy: whether or not your site uses fancy URLs (see Fancy URLs
804
    section above). Default is false.
Evan Prodromou's avatar
Evan Prodromou committed
805
logfile: full path to a file for StatusNet to save logging
806 807
    information to. You may want to use this if you don't have
    access to syslog.
808
logdebug: whether to log additional debug info like backtraces on
809
    hard errors. Default false.
810
locale_path: full path to the directory for locale data. Unless you
811 812
    store all your locale data in one place, you probably
    don't need to use this.
813
language: default language for your site. Defaults to US English.
814 815 816 817 818 819
    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.
820
languages: A list of languages supported on your site. Typically you'd
821 822 823 824
    only change this if you wanted to disable support for one
    or another language:
    "unset($config['site']['languages']['de'])" will disable
    support for German.
825
theme: Theme for your site (see Theme section). Two themes are
826 827 828
    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.
829
email: contact email address for your site. By default, it's extracted
830
    from your Web server environment; you may want to customize it.
831
broughtbyurl: name of an organization or individual who provides the
832 833 834
    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.
835 836
broughtby: text used for the "brought by" link.
timezone: default timezone for message display. Users can set their
837
    own time zone. Defaults to 'UTC', which is a pretty good default.
838
closed: If set to 'true', will disallow registration on your site.
839 840 841
    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'.
842
inviteonly: If set to 'true', will only allow registration if the user
843
    was invited by an existing user.
844
private: If set to 'true', anonymous users will be redirected to the
845 846 847 848
    '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.
849
notice: A plain string that will appear on every page. A good place
850 851
    to put introductory information about your service, or info about
    upgrades and outages, or other community info. Any HTML will
852
    be escaped.
853
logo: URL of an image file to use as the logo for the site. Overrides
854
    the logo in the theme, if any.
855
ssl: Whether to use SSL and https:// URLs for some or all pages.
856 857 858 859
    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'.
860
sslserver: use an alternate server name for SSL URLs, like
861 862 863 864
    '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.
865
shorturllength: Length of URL at which URLs in a message exceeding 140
866 867
    characters will be sent to the user's chosen
    shortening service.
868
dupelimit: minimum time allowed for one person to say the same thing
869 870
    twice. Default 60s. Anything lower is considered a user
    or UI error.
871
textlimit: default max size for texts in the site. Defaults to 140.
872 873
    0 means no limit. Can be fine-tuned for notices, messages,
    profile bios and group descriptions.
874

875 876 877 878
db
--

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

Evan Prodromou's avatar
Evan Prodromou committed
882
database: a DSN (Data Source Name) for your StatusNet database. This is
883 884 885 886
    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.
887
ini_yourdbname: if your database is not named 'statusnet', you'll need
888 889 890
    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'.
891
db_driver: You can try changing this to 'MDB2' to use the other driver
892 893
    type for DB_DataObject, but note that it breaks the OpenID
    libraries, which only support PEAR::DB.
894
debug: On a database error, you may get a message saying to set this
895 896 897
    value to 5 to see debug messages in the browser. This breaks
    just about all pages, and will also expose the username and
    password
898 899
quote_identifiers: Set this to true if you're using postgresql.
type: either 'mysql' or 'postgresql' (used for some bits of
900
    database-type-specific SQL in the code). Defaults to mysql.
901
mirror: you can set this to an array of DSNs, like the above
902 903 904 905 906 907 908
    '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.
909
utf8: whether to talk to the database in UTF-8 mode. This is the default
910 911 912
    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
913
schemacheck: when to let plugins check the database schema to add
914 915 916 917 918 919 920
    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.
921

922 923 924
syslog
------

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

Evan Prodromou's avatar
Evan Prodromou committed
928
appname: The name that StatusNet uses to log messages. By default it's
929 930 931
    "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.
932 933
priority: level to log at. Currently ignored.
facility: what syslog facility to used. Defaults to LOG_USER, only
934 935
    reset if you know what syslog is and have a good reason
    to change it.
936 937 938 939 940 941 942 943

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
944
enabled: Whether to uses queues. Defaults to false.
945
subsystem: Which kind of queueserver to use. Values include "db" for
946 947
    our hacked-together database queuing (no other server
    required) and "stomp" for a stomp server.
948
stomp_server: "broker URI" for stomp server. Something like
949 950 951
    "tcp://hostname:61613". More complicated ones are
    possible; see your stomp server's documentation for
    details.
952
queue_basename: a root name to use for queues (stomp only). Typically
953 954 955 956
    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.
957

958
stomp_username: username for connecting to the stomp server; defaults
959
    to null.
960
stomp_password: password for connecting to the stomp server; defaults
961
    to null.
962 963

stomp_persistent: keep items across queue server restart, if enabled.
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
    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.
984 985

softlimit: an absolute or relative "soft memory limit"; daemons will
986 987 988
    restart themselves gracefully when they find they've hit
    this amount of memory usage. Defaults to 90% of PHP's global
    memory_limit setting.
989 990

inboxes: delivery of messages to receiver's inboxes can be delayed to
991 992 993
    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.
994 995

breakout: for stomp, individual queues are by default grouped up for
996 997
    best scalability. If some need to be run by separate daemons,
    etc they can be manually adjusted here.
998

999 1000 1001
        Default will share all queues for all sites within each group.
        Specify as <group>/<queue> or <group>/<queue>/<site>,
        using nickname identifier as site.
1002

1003 1004
        'main/distrib' separate "distrib" queue covering all sites
        'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
1005 1006

max_retries: for stomp, drop messages after N failed attempts to process.
1007
    Defaults to 10.
1008 1009

dead_letter_dir: for stomp, optional directory to dump data on failed
1010
    queue processing events after discarding them.
1011

1012 1013 1014 1015 1016 1017
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
1018 1019 1020 1021 1022 1023 1024
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.
1025

1026
type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1027 1028
    (default copyright), or 'private' (for private and confidential
    information).
1029
owner: for 'allrightsreserved' or 'private', an assigned copyright
1030 1031
    holder (for example, an employer for a private site). If
    not specified, will be attributed to 'contributors'.
Evan Prodromou's avatar
Evan Prodromou committed
1032 1033 1034 1035 1036
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
1037 1038
----

Evan Prodromou's avatar
Evan Prodromou committed
1039 1040
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
1041

Evan Prodromou's avatar
Evan Prodromou committed
1042
backend: the backend to use for mail, one of 'mail', 'sendmail', and
1043
    'smtp'. Defaults to PEAR's default, 'mail'.
Evan Prodromou's avatar
Evan Prodromou committed
1044
params: if the mail backend requires any parameters, you can provide
1045
    them in an associative array.
1046

Evan Prodromou's avatar
Evan Prodromou committed
1047 1048 1049 1050 1051 1052
nickname
--------

This is for configuring nicknames in the service.

blacklist: an array of strings for usernames that may not be
1053 1054 1055 1056 1057
    registered. A default array exists for strings that are
    used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
    but you may want to add others if you have other software
    installed in a subdirectory of StatusNet or if you just
    don't want certain words used as usernames.
1058
featured: an array of nicknames of 'featured' users of the site.
1059 1060
    Can be useful to draw attention to well-known users, or
    interesting people, or whatever.
Evan Prodromou's avatar
Evan Prodromou committed
1061 1062 1063 1064 1065 1066

avatar
------

For configuring avatar access.

1067
dir: Directory to look for avatar files and to put them into.
1068 1069
    Defaults to avatar subdirectory of install directory; if
    you change it, make sure to change path, too.
1070
path: Path to avatars. Defaults to path for avatar subdirectory,
1071 1072
    but you can change it if you wish. Note that this will
    be included with the avatar server, too.
Evan Prodromou's avatar
Evan Prodromou committed
1073
server: If set, defines another server where avatars are stored in the
1074 1075 1076 1077 1078 1079 1080
    root directory. Note that the 'avatar' subdir still has to be
    writeable. You'd typically use this to split HTTP requests on
    the client to speed up page loading, either with another
    virtual server or with an NFS or SAMBA share. Clients
    typically only make 2 connections to a single server at a
    time <http://ur1.ca/6ih>, so this can parallelize the job.
    Defaults to null.
1081 1082
ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
    to guess based on site-wide SSL settings.
Evan Prodromou's avatar
Evan Prodromou committed
1083 1084 1085 1086 1087 1088 1089

public
------

For configuring the public stream.

localonly: If set to true, only messages posted by users of this
1090 1091
    service (rather than other services, filtered through OMB)
    are shown in the public stream. Default true.
1092
blacklist: An array of IDs of users to hide from the public stream.
1093 1094
    Useful if you have someone making excessive Twitterfeed posts
    to the site, other kinds of automated posts, testing bots, etc.
1095
autosource: Sources of notices that are from automatic posters, and thus
1096
    should be kept off the public timeline. Default empty.
Evan Prodromou's avatar
Evan Prodromou committed
1097 1098 1099 1100 1101

theme
-----

server: Like avatars, you can speed up page loading by pointing the
1102 1103
    theme file lookup to another server (virtual or real).
    Defaults to NULL, meaning to use the site server.
1104
dir: Directory where theme files are stored. Used to determine
1105 1106
    whether to show parts of a theme file. Defaults to the theme
    subdirectory of the install directory.
1107
path: Path part of theme URLs, before the theme name. Relative to the
1108 1109 1110 1111
    theme server. It may make sense to change this path when upgrading,
    (using version numbers as the path) to make sure that all files are
    reloaded by caching clients or proxies. Defaults to null,
    which means to use the site path + '/theme'.
1112
ssl: Whether to use SSL for theme elements. Default is null, which means
1113
    guess based on site SSL settings.
Evan Prodromou's avatar
Evan Prodromou committed
1114

1115 1116 1117 1118
javascript
----------

server: You can speed up page loading by pointing the
1119 1120
    theme file lookup to another server (virtual or real).
    Defaults to NULL, meaning to use the site server.
1121
path: Path part of Javascript URLs. Defaults to null,
1122
    which means to use the site path + '/js/'.
1123
ssl: Whether to use SSL for JavaScript files. Default is null, which means
1124
    guess based on site SSL settings.
1125

Evan Prodromou's avatar
Evan Prodromou committed
1126
xmpp
1127 1128
----

Evan Prodromou's avatar
Evan Prodromou committed
1129 1130 1131 1132 1133
For configuring the XMPP sub-system.

enabled: Whether to accept and send messages by XMPP. Default false.
server: server part of XMPP ID for update user.
port: connection port for clients. Default 5222, which you probably
1134
    shouldn't need to change.
Evan Prodromou's avatar
Evan Prodromou committed
1135
user: username for the client connection. Users will receive messages
1136
    from 'user'@'server'.
Evan Prodromou's avatar
Evan Prodromou committed
1137
resource: a unique identifier for the connection to the server. This
1138
    is actually used as a prefix for each XMPP component in the system.
Evan Prodromou's avatar
Evan Prodromou committed
1139 1140
password: password for the user account.
host: some XMPP domains are served by machines with a different
1141 1142 1143
    hostname. (For example, @gmail.com GTalk users connect to
    talk.google.com). Set this to the correct hostname if that's the
    case with your server.
Evan Prodromou's avatar
Evan Prodromou committed
1144
encryption: Whether to encrypt the connection between StatusNet and the
1145 1146 1147 1148
    XMPP server. Defaults to true, but you can get
    considerably better performance turning it off if you're
    connecting to a server on the same machine or on a
    protected network.
Evan Prodromou's avatar
Evan Prodromou committed
1149
debug: if turned on, this will make the XMPP library blurt out all of
1150 1151 1152
    the incoming and outgoing messages as XML stanzas. Use as a
    last resort, and never turn it on if you don't have queues
    enabled, since it will spit out sensitive data to the browser.
Evan Prodromou's avatar
Evan Prodromou committed
1153
public: an array of JIDs to send _all_ notices to. This is useful for
1154
    participating in third-party search and archiving services.
Evan Prodromou's avatar
Evan Prodromou committed
1155

1156 1157 1158 1159 1160 1161 1162
invite
------

For configuring invites.

enabled: Whether to allow users to send invites. Default true.

Evan Prodromou's avatar
Evan Prodromou committed
1163 1164 1165 1166 1167 1168
tag
---

Miscellaneous tagging stuff.

dropoff: Decay factor for tag listing, in seconds.
1169 1170
    Defaults to exponential decay over ten days; you can twiddle
    with it to try and get better results for your site.
1171

1172 1173 1174 1175 1176 1177
popular
-------

Settings for the "popular" section of the site.

dropoff: Decay factor for popularity listing, in seconds.
1178 1179
    Defaults to exponential decay over ten days; you can twiddle
    with it to try and get better results for your site.
1180

Evan Prodromou's avatar
Evan Prodromou committed
1181 1182 1183 1184 1185 1186
daemon
------

For daemon processes.

piddir: directory that daemon processes should write their PID file
1187 1188
    (process ID) to. Defaults to /var/run/, which is where this
    stuff should usually go on Unix-ish systems.
Evan Prodromou's avatar
Evan Prodromou committed
1189
user: If set, the daemons will try to change their effective user ID
1190 1191 1192
    to this user before running. Probably a good idea, especially if
    you start the daemons as root. Note: user name, like 'daemon',
    not 1001.
Evan Prodromou's avatar
Evan Prodromou committed
1193
group: If set, the daemons will try to change their effective group ID
1194
    to this named group. Again, a name, not a numerical ID.
Evan Prodromou's avatar
Evan Prodromou committed
1195

1196 1197 1198 1199
memcached
---------

You can get a significant boost in performance by caching some
1200
database data in memcached <http://www.danga.com/memcached/>.
1201 1202 1203

enabled: Set to true to enable. Default false.
server: a string with the hostname of the memcached server. Can also
1204
    be an array of hostnames, if you've got more than one server.
1205
base: memcached uses key-value pairs to store data. We build long,
1206 1207 1208 1209 1210
    funny-looking keys to make sure we don't have any conflicts. The
    base of the key is usually a simplified version of the site name
    (like "Identi.ca" => "identica"), but you can overwrite this if
    you need to. You can safely ignore it if you only have one
    StatusNet site using your memcached server.
1211
port: Port to connect to; defaults to 11211.
1212

1213 1214 1215 1216 1217 1218
emailpost
---------

For post-by-email.

enabled: Whether to enable post-by-email. Defaults to true. You will
1219
    also need to set up maildaemon.php.
1220

1221 1222 1223 1224 1225 1226
sms
---

For SMS integration.

enabled: Whether to enable SMS integration. Defaults to true. Queues
1227
    should also be enabled.
1228

1229 1230 1231 1232 1233
integration
-----------

A catch-all for integration with other systems.

1234
taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1235

1236 1237 1238 1239 1240
inboxes
-------

For notice inboxes.

Evan Prodromou's avatar
Evan Prodromou committed
1241
enabled: No longer used. If you set this to something other than true,
1242
    StatusNet will no longer run.
1243

1244 1245 1246 1247 1248 1249 1250
throttle
--------

For notice-posting throttles.

enabled: Whether to throttle posting. Defaults to false.
count: Each user can make this many posts in 'timespan' seconds. So, if count
1251 1252
    is 100 and timespan is 3600, then there can be only 100 posts
    from a user every hour.
1253 1254 1255 1256 1257 1258 1259
timespan: see 'count'.

profile
-------

Profile management.

1260
biolimit: max character length of bio; 0 means no limit; null means to use
1261
    the site text limit default.
1262

1263 1264 1265 1266 1267
newuser
-------

Options with new users.

1268
default: nickname of a user account to automatically subscribe new
1269 1270 1271
    users to. Typically this would be system account for e.g.
    service updates or announcements. Users are able to unsub
    if they want. Default is null; no auto subscribe.
1272
welcome: nickname of a user account that sends welcome messages to new
1273 1274 1275
    users. Can be the same as 'default' account, although on
    busy servers it may be a good idea to keep that one just for
    'urgent' messages. Default is null; no message.
1276

1277 1278 1279
If either of these special user accounts are specified, the users should
be created before the configuration is updated.

1280 1281 1282 1283
snapshot
--------

The software will, by default, send statistical snapshots about the
Evan Prodromou's avatar
Evan Prodromou committed
1284
local installation to a stats server on the status.net Web site. This
1285 1286 1287
data is used by the developers to prioritize development decisions. No
identifying data about users or organizations is collected. The data
is available to the public for review. Participating in this survey
Evan Prodromou's avatar
Evan Prodromou committed
1288
helps StatusNet developers take your needs into account when updating
1289 1290 1291
the software.

run: string indicating when to run the statistics. Values can be 'web'
1292 1293 1294
    (run occasionally at Web time), 'cron' (run from a cron script),
    or 'never' (don't ever run). If you set it to 'cron', remember to
    schedule the script to run on a regular basis.
1295
frequency: if run value is 'web', how often to report statistics.
1296 1297 1298
    Measured in Web hits; depends on how active your site is.
    Default is 10000 -- that is, one report every 10000 Web hits,
    on average.
Evan Prodromou's avatar
Evan Prodromou committed
1299
reporturl: URL to post statistics to. Defaults to StatusNet developers'
1300 1301 1302 1303 1304
    report system, but if they go evil or disappear you may
    need to update this to another value. Note: if you
    don't want to report stats, it's much better to
    set 'run' to 'never' than to set this value to something
    nonsensical.
1305

1306 1307 1308 1309 1310 1311 1312
attachments
-----------

The software lets users upload files with their notices. You can configure
the types of accepted files by mime types and a trio of quota options:
per file, per user (total), per user per month.

1313 1314 1315
We suggest the use of the pecl file_info extension to handle mime type
detection.

1316
supported: an array of mime types you accept to store and distribute,
1317 1318 1319 1320
    like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
    setup your server to properly recognize the types you want to
    support.
uploads: false to disable uploading files with notices (true by default).
1321
filecommand: The required MIME_Type library may need to use the 'file'
1322 1323 1324
    command. It tries the one in the Web server's path, but if
    you're having problems with uploads, try setting this to the
    correct value. Note: 'file' must accept '-b' and '-i' options.
1325 1326 1327 1328 1329 1330 1331

For quotas, be sure you've set the upload_max_filesize and post_max_size
in php.ini to be large enough to handle your upload. In httpd.conf
(if you're using apache), check that the LimitRequestBody directive isn't
set too low (it's optional, so it may not be there at all).

file_quota: maximum size for a single file upload in bytes. A user can send
1332 1333
    any amount of notices with attachments as long as each attachment
    is smaller than file_quota.
1334
user_quota: total size in bytes a user can store on this server. Each user
1335 1336
    can store any number of files as long as their total size does
    not exceed the user_quota.
1337
monthly_quota: total size permitted in the current month. This is the total
1338
    size in bytes that a user can upload each month.
1339
dir: directory accessible to the Web process where uploads should go.
1340 1341
    Defaults to the 'file' subdirectory of the install directory, which
    should be writeable by the Web user.
1342
server: server name to use when creating URLs for uploaded files.
1343 1344
    Defaults to null, meaning to use the default Web server. Using
    a virtual server here can speed up Web performance.
1345
path: URL path, relative to the server, to find files. Defaults to
1346
    main path + '/file/'.
1347
ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
1348
    guess based on other SSL settings.
1349
filecommand: command to use for determining the type of a file. May be
1350 1351
    skipped if fileinfo extension is installed. Defaults to
    '/usr/bin/file'.
1352

1353 1354 1355 1356 1357 1358
group
-----

Options for group functionality.

maxaliases: maximum number of aliases a group can have. Default 3. Set
1359
    to 0 or less to prevent aliases in a group.
1360
desclimit: maximum number of characters to allow in group descriptions.
1361 1362
    null (default) means to use the site-wide text limits. 0
    means no limit.
1363

1364 1365 1366 1367 1368 1369 1370
oohembed
--------

oEmbed endpoint for multimedia attachments (links in posts).

endpoint: oohembed endpoint using http://oohembed.com/ software.

Evan Prodromou's avatar
Evan Prodromou committed
1371 1372 1373 1374 1375 1376
search
------

Some stuff for search.

type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1377 1378 1379 1380 1381
    be 'fulltext' (default) or 'like'. The former is faster and more efficient
    but requires the lame old MyISAM engine for MySQL. The latter
    will work with InnoDB but could be miserably slow on large
    systems. We'll probably add another type sometime in the future,
    with our own indexing system (maybe like MediaWiki's).
Evan Prodromou's avatar
Evan Prodromou committed
1382

1383 1384 1385 1386 1387 1388
sessions
--------

Session handling.

handle: boolean. Whether we should register our own PHP session-handling
1389 1390 1391
    code (using the database and memcache if enabled). Defaults to false.
    Setting this to true makes some sense on large or multi-server
    sites, but it probably won't hurt for smaller ones, either.
Evan Prodromou's avatar
Evan Prodromou committed
1392
debug: whether to output debugging info for session storage. Can help
1393
    with weird session bugs, sometimes. Default false.
1394

1395 1396 1397 1398 1399 1400 1401
background
----------

Users can upload backgrounds for their pages; this section defines
their use.

server: the server to use for background. Using a separate (even
1402 1403
    virtual) server for this can speed up load times. Default is
    null; same as site server.
1404
dir: directory to write backgrounds too. Default is '/background/'
1405
    subdir of install dir.
1406
path: path to backgrounds. Default is sub-path of install path; note
1407
    that you may need to change this if you change site-path too.
1408
ssl: Whether or not to use HTTPS for background files. Defaults to
1409
    null, meaning to guess from site-wide SSL settings.
1410 1411 1412 1413