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

Evan Prodromou's avatar
Evan Prodromou committed
5 6
StatusNet 0.9.7 "World Leader Pretend"
17 March 2011
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
================

Evan Prodromou's avatar
Evan Prodromou committed
99 100
This is a security, bug and feature release since version 0.9.6 released on
23 October 2010.
101

Evan Prodromou's avatar
Evan Prodromou committed
102 103 104 105
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. Upgrades require new database indexes for
best performance; see Upgrade below.
106

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

Evan Prodromou's avatar
Evan Prodromou committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
- GroupPrivateMessage plugin lets users send private messages
  to a group. (Similar to "private groups" on Yammer.)
- Support for Twitter streaming API in Twitter bridge plugin
- Support for a new Activity Streams-based API using AtomPub, allowing
  richer API data. See http://status.net/wiki/AtomPub for details.
- Unified Facebook plugin, replacing previous Facebook application
  and Facebook Connect plugin.
- A plugin to send out a daily summary email to network users.
- In-line thumbnails of some attachments (video, images) and oEmbed objects.
- Local copies of remote profiles to let moderators manage OStatus users.
- Upgrade upstream JS, minify everything.
- Allow pushing plugin JS, CSS, and static files to a CDN.
- Configurable nickname rules.
- Better support for bit.ly URL shortener.
- InProcessCache plugin for additional caching on top of memcached.
- Support for Activity Streams JSON feeds on many streams.
- User-initiated backup and restore of account data in Activity Streams
  format.
- Bookmark plugin for making del.icio.us-like social bookmarking sites,
  including del.icio.us backup file import. Supports OStatus.
- SQLProfile plugin to tune SQL queries.
- Better sorting on timelines to support restored or imported data.
- Hundreds of translations from http://translatewiki.net/
- Hundreds of performance tunings, bug fixes, and UI improvements.
- Remove deprecated data from Activity Streams Atom output, to the
  extent possible.
- NewMenu plugin for new layout of menu items.
- Experimental support for moving an account from one server to
  another, using new AtomPub API.

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

141 142 143 144 145 146
Prerequisites
=============

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

Craig Andrews's avatar
Craig Andrews committed
147
- PHP 5.2.3+. It may be possible to run this software on earlier
148
  versions of PHP, but many of the functions used are only available
149
  in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
150 151
  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
152
- MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
153 154 155 156 157
  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
158
  mod_rewrite extension installed and enabled.
159 160 161 162 163 164

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
165
- GD. For scaling down avatar images.
166
- mbstring. For handling Unicode (UTF-8) encoded strings.
167 168 169 170 171 172 173 174 175

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.
176 177 178
- 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.
179 180
- bcmath or gmp. For Salmon signatures (part of OStatus). Needed
  if you have OStatus configured.
181 182
- gettext. For multiple languages. Default on many PHP installs;
  will be emulated if not present.
183

184 185 186 187 188 189 190 191 192 193 194 195 196 197
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.
198

Evan Prodromou's avatar
Evan Prodromou committed
199 200
- DB_DataObject http://pear.php.net/package/DB_DataObject
- Validate http://pear.php.net/package/Validate
201
- OpenID from OpenIDEnabled (not the PEAR version!). We decided
Evan Prodromou's avatar
Evan Prodromou committed
202
  to use the openidenabled.com version since it's more widely
203
  implemented, and seems to be better supported.
204
  http://openidenabled.com/php-openid/
205 206 207 208 209 210
- 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
211
- OAuth.php from http://oauth.googlecode.com/svn/code/php/
212
- markdown.php from http://michelf.com/projects/php-markdown/
Evan Prodromou's avatar
Evan Prodromou committed
213
- PEAR Mail, for sending out mail notifications
214
  http://pear.php.net/package/Mail
Evan Prodromou's avatar
Evan Prodromou committed
215
- PEAR Net_SMTP, if you use the SMTP factory for notifications
216
  http://pear.php.net/package/Net_SMTP
Evan Prodromou's avatar
Evan Prodromou committed
217 218
- PEAR Net_Socket, if you use the SMTP factory for notifications
  http://pear.php.net/package/Net_Socket
219 220 221 222 223
- 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
224
  version may render your StatusNet site unable to send or receive XMPP
225
  messages.
Evan Prodromou's avatar
Evan Prodromou committed
226
- Facebook library. Used for the Facebook application.
227
- PEAR Validate is used for URL and email validation.
228
- Console_GetOpt for parsing command-line options.
229 230
  predecessor to OStatus.
- HTTP_Request2, a library for making HTTP requests.
231
- PEAR Net_URL2 is an HTTP_Request2 dependency.
232

Evan Prodromou's avatar
Evan Prodromou committed
233
A design goal of StatusNet is that the basic Web functionality should
234 235 236 237 238 239 240 241 242
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
243
Installing the basic StatusNet Web component is relatively easy,
244 245 246 247
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:
248

Evan Prodromou's avatar
Evan Prodromou committed
249
       tar zxf statusnet-0.9.7.tar.gz
250

Evan Prodromou's avatar
Evan Prodromou committed
251
   ...which will make a statusnet-0.9.7 subdirectory in your current
252 253 254
   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.)
255

256 257
2. Move the tarball to a directory of your choosing in your Web root
   directory. Usually something like this will work:
258

Evan Prodromou's avatar
Evan Prodromou committed
259
       mv statusnet-0.9.7 /var/www/statusnet
260

261 262
   This will make your StatusNet instance available in the statusnet path of
   your server, like "http://example.net/statusnet". "microblog" or
263
   "statusnet" might also be good path names. If you know how to
264 265
   configure virtual hosts on your web server, you can try setting up
   "http://micro.example.net/" or the like.
266

267
3. Make your target directory writeable by the Web server.
268

269
       chmod a+w /var/www/statusnet/
270

271
   On some systems, this will probably work:
272

273
       chgrp www-data /var/www/statusnet/
274
       chmod g+w /var/www/statusnet/
275 276 277

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

280 281 282
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:
283

284 285 286
       chmod a+w /var/www/statusnet/avatar
       chmod a+w /var/www/statusnet/background
       chmod a+w /var/www/statusnet/file
287

288 289
   You can also make the avatar, background, and file directories
   writeable by the Web server group, as noted above.
290 291

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

294
       mysqladmin -u "username" --password="password" create statusnet
295

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

300 301 302 303
   (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
304
6. Create a new database account that StatusNet will use to access the
305 306
   database. If you have shell access, this will probably work from the
   MySQL shell:
307

308 309 310
       GRANT ALL on statusnet.*
       TO 'statusnetuser'@'localhost'
       IDENTIFIED BY 'statusnetpassword';
311

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

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

318
       http://yourserver.example.com/statusnet/install.php
319 320 321 322 323 324 325 326 327 328 329

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

331 332 333
Fancy URLs
----------

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

338
    http://example.org/statusnet/index.php/statusnet/fred
339 340 341 342

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

343
    http://example.org/statusnet/index.php?p=statusnet/fred
344 345 346

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

347
    http://example.org/statusnet/fred
348 349

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

Evan Prodromou's avatar
Evan Prodromou committed
354
1. Copy the htaccess.sample file to .htaccess in your StatusNet
355 356 357 358 359
   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.
360

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

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

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

369 370 371
You should now be able to navigate to a "fancy" URL on your server,
like:

372
    http://example.net/statusnet/main/register
373 374 375 376

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

377 378 379 380 381 382
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:

383
    http://httpd.apache.org/docs/2.2/howto/htaccess.html
384 385 386

Also, check that mod_rewrite is installed and enabled:

387
    http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
388

389 390 391
Sphinx
------

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

395 396
    addPlugin('SphinxSearch');
    $config['sphinx']['server'] = 'searchhost.local';
397

398 399 400 401
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.
402

403 404 405
SMS
---

Evan Prodromou's avatar
Evan Prodromou committed
406
StatusNet supports a cheap-and-dirty system for sending update messages
407 408 409 410 411 412 413 414 415
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
416
converted to a notice and stored in the DB.
417 418 419 420

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

424
       mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
425 426 427 428 429 430

   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:

431
       chmod +x scripts/maildaemon.php
432

433 434
   Note that "daemon" is kind of a misnomer here; the script is more
   of a filter than a daemon.
435

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

438
       *: /path/to/statusnet/scripts/maildaemon.php
439 440 441

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

443
       newaliases
444

445 446 447 448 449
   You may need to restart your mail server for the new database to
   take effect.

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

450
       $config['mail']['domain'] = 'yourdomain.example.net';
451

452 453
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
454 455
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.
456 457 458 459

XMPP
----

460
XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
461 462 463 464 465 466 467 468
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.
469

470 471 472 473
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.
474

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

479 480
3. Configure your site's XMPP variables, as described below in the
   configuration section.
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
486
a lot of SMS, OStatus, and XMPP messages whenever someone posts a message
487 488
can really slow down your site; it may cause posting to timeout.

489 490
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
491
work around this bug in StatusNet; current recommendation is to move
492 493
off of amd64 to another server.

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

504
    $config['xmpp']['public'][] = 'downstream@example.net';
505

506 507 508 509 510 511 512 513
(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
------------------

514
Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
515 516 517 518 519 520 521 522 523 524
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
525
2. If you're using a separate server for queues, install StatusNet
526 527 528 529 530 531 532
   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:

533
       $config['queue']['enabled'] = true;
534 535 536 537 538

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

540
4. On the queues server, run the command scripts/startdaemons.sh.
541

542
This will run the queue handlers:
543

544
* queuedaemon.php - polls for queued items for inbox processing and
545
  pushing out to OStatus, SMS, XMPP, etc.
546
* xmppdaemon.php - listens for new XMPP messages from users and stores
547 548 549 550 551 552 553
  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.

554 555 556
Additional daemons may be also started by this script for certain
plugins, such as the Twitter bridge.

557
It may be a good idea to use a daemon-monitoring service, like 'monit',
558 559 560 561 562 563
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.

564
Since version 0.8.0, it's now possible to use a STOMP server instead of
565 566 567 568 569
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
570

571 572 573
Themes
------

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

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

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

609 610 611
Translation
-----------

Evan Prodromou's avatar
Evan Prodromou committed
612
Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
Evan Prodromou's avatar
Evan Prodromou committed
613 614 615 616
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
617
Contributions of translation information to StatusNet are very easy:
618
you can use the Web interface at translatewiki.net to add one
619 620 621
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.

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

624 625 626
Backups
-------

Evan Prodromou's avatar
Evan Prodromou committed
627 628
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
629
the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
630 631
and to backup the Web directory, try tar.

632 633 634 635 636 637 638 639
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.

640 641 642 643
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.
644

645 646 647 648
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:

649
       mkdir /var/www/statusnet-files
650 651 652 653

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

654
       chmod a+x /var/www/statusnet-files
655 656 657 658

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

659
       $config['attachments']['dir'] = '/var/www/statusnet-files';
660

661 662 663
Upgrading
=========

Evan Prodromou's avatar
Evan Prodromou committed
664
IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
665 666 667 668 669 670
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
671
If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
672 673
been tracking the "git" version of the software, you will probably
want to upgrade and keep your existing data. There is no automated
Evan Prodromou's avatar
Evan Prodromou committed
674
upgrade procedure in StatusNet 0.9.7. Try these step-by-step
675
instructions; read to the end first before trying them.
Evan Prodromou's avatar
Evan Prodromou committed
676

Evan Prodromou's avatar
Evan Prodromou committed
677
0. Download StatusNet and set up all the prerequisites as if you were
Evan Prodromou's avatar
Evan Prodromou committed
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
   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.
694
6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
Evan Prodromou's avatar
Evan Prodromou committed
695
7. Unpack your StatusNet 0.9.7 tarball and move it to "statusnet" or
Evan Prodromou's avatar
Evan Prodromou committed
696
   wherever your code used to be.
697 698 699
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
700 701
9. Copy htaccess.sample to .htaccess in the new directory. Change the
   RewriteBase to use the correct path.
Evan Prodromou's avatar
Evan Prodromou committed
702
10. Rebuild the database.
703 704

    NOTE: this step is destructive and cannot be
705 706 707
    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
708
    If your database is at version 0.8.0 or higher in the 0.8.x line, you can run a
709
    special upgrade script:
710

711
        mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
712

Evan Prodromou's avatar
Evan Prodromou committed
713 714 715 716 717 718
    If you are upgrading from any 0.9.x version like 0.9.6, run this script:

        mysql -u<rootuser> -p<rootpassword> <database> db/096to097.sql

    Despite the name, it should work for any 0.9.x branch.

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

722
        ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
723 724 725

    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
726
    that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
727 728
    your database and rebuilds it; if there is an error you have no
    database. Make sure you have a backup.
729 730 731 732 733
    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
734 735 736 737 738 739
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
740 741
precooked data in the DB. All upgraders should check out the inboxes
options below.
Evan Prodromou's avatar
Evan Prodromou committed
742

743
NOTE: the database definition file, laconica.ini, has been renamed to
744
statusnet.ini (since this is the recommended database name). If you
745 746 747
have a line in your config.php pointing to the old name, you'll need
to update it.

748 749 750 751 752 753
NOTE: the 1.0.0 version of StatusNet changed the URLs for all admin
panels from /admin/* to /panel/*. This now allows the (popular)
username 'admin', but blocks the considerably less popular username
'panel'. If you have an existing user named 'panel', you should rename
them before upgrading.

754 755 756
Notice inboxes
--------------

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

760 761 762
UTF-8 Database
--------------

Evan Prodromou's avatar
Evan Prodromou committed
763
StatusNet 0.7.4 introduced a fix for some incorrectly-stored
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
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.

783 784 785
Configuration options
=====================

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

792 793 794 795 796 797 798
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.

799
Starting with version 0.7.1, you can put config files in the
800
/etc/statusnet/ directory on your server, if it exists. Config files
801 802
will be included in this order:

803
* /etc/statusnet/statusnet.php - server-wide config
804 805
* /etc/statusnet/<servername>.php - for a virtual host
* /etc/statusnet/<servername>_<pathname>.php - for a path
806 807
* INSTALLDIR/config.php - for a particular implementation

808 809 810 811
Almost all configuration options are made through a two-dimensional
associative array, cleverly named $config. A typical configuration
line will be:

812
    $config['section']['option'] = value;
813 814 815 816 817 818 819 820 821 822 823

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

898 899 900 901
db
--

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

Evan Prodromou's avatar
Evan Prodromou committed
905
database: a DSN (Data Source Name) for your StatusNet database. This is
906 907 908 909
    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.
910
ini_yourdbname: if your database is not named 'statusnet', you'll need
911 912 913
    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'.
914
db_driver: You can try changing this to 'MDB2' to use the other driver
915 916
    type for DB_DataObject, but note that it breaks the OpenID
    libraries, which only support PEAR::DB.
917
debug: On a database error, you may get a message saying to set this
918 919 920
    value to 5 to see debug messages in the browser. This breaks
    just about all pages, and will also expose the username and
    password
921 922
quote_identifiers: Set this to true if you're using postgresql.
type: either 'mysql' or 'postgresql' (used for some bits of
923
    database-type-specific SQL in the code). Defaults to mysql.
924
mirror: you can set this to an array of DSNs, like the above
925 926 927 928 929 930 931
    '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.
932
utf8: whether to talk to the database in UTF-8 mode. This is the default
933 934 935
    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
936
schemacheck: when to let plugins check the database schema to add
937 938 939 940 941 942 943
    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.
944

945 946 947
syslog
------

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

Evan Prodromou's avatar
Evan Prodromou committed
951
appname: The name that StatusNet uses to log messages. By default it's
952 953 954
    "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
955 956
priority: level to log at. Currently ignored.
facility: what syslog facility to used. Defaults to LOG_USER, only
957 958
    reset if you know what syslog is and have a good reason
    to change it.
959 960 961 962 963 964 965 966

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
967
enabled: Whether to uses queues. Defaults to false.
Evan Prodromou's avatar
Evan Prodromou committed
968
subsystem: Which kind of queueserver to use. Values include "db" for
969 970
    our hacked-together database queuing (no other server
    required) and "stomp" for a stomp server.
Evan Prodromou's avatar
Evan Prodromou committed
971
stomp_server: "broker URI" for stomp server. Something like
972 973 974
    "tcp://hostname:61613". More complicated ones are
    possible; see your stomp server's documentation for
    details.
Evan Prodromou's avatar
Evan Prodromou committed
975
queue_basename: a root name to use for queues (stomp only). Typically
976 977 978 979
    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
980

Evan Prodromou's avatar
Evan Prodromou committed
981
stomp_username: username for connecting to the stomp server; defaults
982
    to null.
Evan Prodromou's avatar
Evan Prodromou committed
983
stomp_password: password for connecting to the stomp server; defaults
984
    to null.
985 986

stomp_persistent: keep items across queue server restart, if enabled.
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
    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.
1007 1008

softlimit: an absolute or relative "soft memory limit"; daemons will
1009 1010 1011
    restart themselves gracefully when they find they've hit
    this amount of memory usage. Defaults to 90% of PHP's global
    memory_limit setting.
1012 1013

inboxes: delivery of messages to receiver's inboxes can be delayed to
1014 1015 1016
    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.
1017 1018

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

1022 1023 1024
        Default will share all queues for all sites within each group.
        Specify as <group>/<queue> or <group>/<queue>/<site>,
        using nickname identifier as site.
1025

1026 1027
        'main/distrib' separate "distrib" queue covering all sites
        'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
1028 1029

max_retries: for stomp, drop messages after N failed attempts to process.
1030
    Defaults to 10.
1031 1032

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

1035 1036 1037 1038 1039 1040
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
1041 1042 1043 1044 1045 1046 1047
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.
1048

1049
type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1050 1051
    (default copyright), or 'private' (for private and confidential
    information).
1052
owner: for 'allrightsreserved' or 'private', an assigned copyright
1053 1054
    holder (for example, an employer for a private site). If
    not specified, will be attributed to 'contributors'.
Evan Prodromou's avatar
Evan Prodromou committed
1055 1056 1057 1058 1059
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
1060 1061
----

Evan Prodromou's avatar
Evan Prodromou committed
1062 1063
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
1064

Evan Prodromou's avatar
Evan Prodromou committed
1065
backend: the backend to use for mail, one of 'mail', 'sendmail', and
1066
    'smtp'. Defaults to PEAR's default, 'mail'.
Evan Prodromou's avatar
Evan Prodromou committed
1067
params: if the mail backend requires any parameters, you can provide
1068
    them in an associative array.
1069

Evan Prodromou's avatar
Evan Prodromou committed
1070 1071 1072 1073 1074 1075
nickname
--------

This is for configuring nicknames in the service.

blacklist: an array of strings for usernames that may not be
1076 1077 1078 1079 1080
    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.
Evan Prodromou's avatar
Evan Prodromou committed
1081
featured: an array of nicknames of 'featured' users of the site.
1082 1083
    Can be useful to draw attention to well-known users, or
    interesting people, or whatever.
Evan Prodromou's avatar
Evan Prodromou committed
1084 1085 1086 1087 1088 1089

avatar
------

For configuring avatar access.

1090
dir: Directory to look for avatar files and to put them into.
1091 1092
    Defaults to avatar subdirectory of install directory; if
    you change it, make sure to change path, too.
1093
path: Path to avatars. Defaults to path for avatar subdirectory,
1094 1095
    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
1096
server: If set, defines another server where avatars are stored in the
1097 1098 1099 1100 1101 1102 1103
    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.
1104 1105
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
1106 1107 1108 1109 1110 1111 1112

public
------

For configuring the public stream.

localonly: If set to true, only messages posted by users of this
1113
    service (rather than other services, filtered through OStatus)
1114
    are shown in the public stream. Default true.
Evan Prodromou's avatar
Evan Prodromou committed
1115
blacklist: An array of IDs of users to hide from the public stream.
1116 1117
    Useful if you have someone making excessive Twitterfeed posts
    to the site, other kinds of automated posts, testing bots, etc.
Evan Prodromou's avatar
Evan Prodromou committed
1118
autosource: Sources of notices that are from automatic posters, and thus
1119
    should be kept off the public timeline. Default empty.
Evan Prodromou's avatar
Evan Prodromou committed
1120 1121 1122 1123 1124

theme
-----

server: Like avatars, you can speed up page loading by pointing the
1125 1126
    theme file lookup to another server (virtual or real).
    Defaults to NULL, meaning to use the site server.
1127
dir: Directory where theme files are stored. Used to determine
1128 1129
    whether to show parts of a theme file. Defaults to the theme
    subdirectory of the install directory.
1130
path: Path part of theme URLs, before the theme name. Relative to the
1131 1132 1133 1134
    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'.
1135
ssl: Whether to use SSL for theme elements. Default is null, which means
1136
    guess based on site SSL settings.
1137 1138 1139
sslserver: SSL server to use when page is HTTPS-encrypted. If
    unspecified, site ssl server and so on will be used.
sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
Evan Prodromou's avatar
Evan Prodromou committed
1140

1141 1142 1143 1144
javascript
----------

server: You can speed up page loading by pointing the
1145 1146
    theme file lookup to another server (virtual or real).
    Defaults to NULL, meaning to use the site server.
1147
path: Path part of Javascript URLs. Defaults to null,
1148
    which means to use the site path + '/js/'.
1149
ssl: Whether to use SSL for JavaScript files. Default is null, which means
1150
    guess based on site SSL settings.
1151 1152 1153
sslserver: SSL server to use when page is HTTPS-encrypted. If
    unspecified, site ssl server and so on will be used.
sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1154 1155 1156
bustframes: If true, all web pages will break out of framesets. If false,
	    can comfortably live in a frame or iframe... probably. Default
	    to true.
1157

Evan Prodromou's avatar
Evan Prodromou committed
1158
xmpp
1159 1160
----

Evan Prodromou's avatar
Evan Prodromou committed
1161 1162 1163 1164 1165
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
1166
    shouldn't need to change.
Evan Prodromou's avatar
Evan Prodromou committed
1167
user: username for the client connection. Users will receive messages
1168
    from 'user'@'server'.
Evan Prodromou's avatar
Evan Prodromou committed
1169
resource: a unique identifier for the connection to the server. This
1170
    is actually used as a prefix for each XMPP component in the system.
Evan Prodromou's avatar
Evan Prodromou committed
1171 1172
password: password for the user account.
host: some XMPP domains are served by machines with a different
1173 1174 1175
    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
1176
encryption: Whether to encrypt the connection between StatusNet and the
1177 1178 1179 1180
    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
1181
debug: if turned on, this will make the XMPP library blurt out all of
1182 1183 1184
    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
1185
public: an array of JIDs to send _all_ notices to. This is useful for
1186
    participating in third-party search and archiving services.
Evan Prodromou's avatar
Evan Prodromou committed
1187

1188 1189 1190 1191 1192 1193 1194
invite
------

For configuring invites.

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

Evan Prodromou's avatar
Evan Prodromou committed
1195 1196 1197 1198 1199 1200
tag
---

Miscellaneous tagging stuff.

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

Evan Prodromou's avatar
Evan Prodromou committed
1204 1205 1206 1207 1208 1209
popular
-------

Settings for the "popular" section of the site.

dropoff: Decay factor for popularity listing, in seconds.
1210 1211
    Defaults to exponential decay over ten days; you can twiddle
    with it to try and get better results for your site.
Evan Prodromou's avatar
Evan Prodromou committed
1212

Evan Prodromou's avatar
Evan Prodromou committed
1213 1214 1215 1216 1217 1218
daemon
------

For daemon processes.

piddir: directory that daemon processes should write their PID file