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

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

5 6
StatusNet 0.9.1 ("Everybody Hurts")
28 Mar 2010
7

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

About
=====

Evan Prodromou's avatar
Evan Prodromou committed
17 18 19 20 21 22
StatusNet is a Free and Open Source microblogging platform. It helps
people in a community, company or group to exchange short (140
characters, by default) messages over the Web. Users can choose which
people to "follow" and receive only their friends' or colleagues'
status messages. It provides a similar service to sites like Twitter,
Google Buzz, or Yammer.
23 24 25 26 27

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

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

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

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

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

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

Evan Prodromou's avatar
Evan Prodromou committed
71 72 73 74 75 76 77 78 79
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
================

80 81 82 83 84
This is a minor bug and feature release since version 0.9.0 released 4
March 2010.

Because of fixes to OStatus bugs, it is highly recommended that all
public sites upgrade to the new version immediately.
Evan Prodromou's avatar
Evan Prodromou committed
85

Evan Prodromou's avatar
Evan Prodromou committed
86 87
Notable changes this version:

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
- Twitter bridge truncates and links back to original for long
  notices.
- Changed "Home" link in main menu to "Personal".
- A new memcached plugin (using pecl/memcached versus pecl/memcache)
- Opt-in subscription to update@status.net
- Script to run commands on behalf of a user.
- Better Web UI for long notices.
- A plugin to open external links in their own window or tab
- Fixes to Salmon protocol for compatibility with other systems.
- Updates to latest ActivityStreams definition.
- Twitpic-compatible API for image upload.
- Background deletion of user accounts.
- Better support for HTTP basic authentication with CGI/FastCGI
- Better discovery on OStatus
- Support for PuSH-enabled RSS 2.0 feeds
- OpenID-only mode
- OpenID blacklist/whitelist
- OStatus unit tests

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

109 110 111 112 113 114
Prerequisites
=============

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

Craig Andrews's avatar
Craig Andrews committed
115
- PHP 5.2.3+. It may be possible to run this software on earlier
116
  versions of PHP, but many of the functions used are only available
117 118 119
  in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
  daemons on 64-bit platforms. PHP 5.3.x should work but is known
  to cause some failures for OpenID.
Evan Prodromou's avatar
Evan Prodromou committed
120
- MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
121 122 123 124 125
  server. It has been primarily tested on 5.x servers, although it may
  be possible to install on earlier (or later!) versions. The server
  *must* support the MyISAM storage engine -- the default for most
  MySQL servers -- *and* the InnoDB storage engine.
- A Web server. Preferably, you should have Apache 2.2.x with the
Evan Prodromou's avatar
Evan Prodromou committed
126
  mod_rewrite extension installed and enabled.
127 128 129 130 131 132

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
133
- GD. For scaling down avatar images.
134
- mbstring. For handling Unicode (UTF-8) encoded strings.
Evan Prodromou's avatar
Evan Prodromou committed
135
- gettext. For multiple languages. Default on many PHP installs.
136 137 138 139 140 141 142 143 144

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.
145 146 147
- 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.
148 149
- bcmath or gmp. For Salmon signatures (part of OStatus). Needed
  if you have OStatus configured.
150

151 152 153 154 155 156 157 158 159 160 161 162 163 164
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.
165

Evan Prodromou's avatar
Evan Prodromou committed
166 167
- DB_DataObject http://pear.php.net/package/DB_DataObject
- Validate http://pear.php.net/package/Validate
168
- OpenID from OpenIDEnabled (not the PEAR version!). We decided
Evan Prodromou's avatar
Evan Prodromou committed
169
  to use the openidenabled.com version since it's more widely
170
  implemented, and seems to be better supported.
171
  http://openidenabled.com/php-openid/
172 173 174 175 176 177
- 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
178
- OAuth.php from http://oauth.googlecode.com/svn/code/php/
Evan Prodromou's avatar
Evan Prodromou committed
179
- markdown.php from http://michelf.com/projects/php-markdown/
Evan Prodromou's avatar
Evan Prodromou committed
180
- PEAR Mail, for sending out mail notifications
181
  http://pear.php.net/package/Mail
Evan Prodromou's avatar
Evan Prodromou committed
182
- PEAR Net_SMTP, if you use the SMTP factory for notifications
183
  http://pear.php.net/package/Net_SMTP
Evan Prodromou's avatar
Evan Prodromou committed
184 185
- PEAR Net_Socket, if you use the SMTP factory for notifications
  http://pear.php.net/package/Net_Socket
186 187 188 189 190
- 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
191
  version may render your StatusNet site unable to send or receive XMPP
192
  messages.
Evan Prodromou's avatar
Evan Prodromou committed
193
- Facebook library. Used for the Facebook application.
194 195
- PEAR Services_oEmbed. Used for some multimedia integration.
- PEAR HTTP_Request is an oEmbed dependency.
Evan Prodromou's avatar
Evan Prodromou committed
196 197
- PEAR Validate is an oEmbed dependency.
- PEAR Net_URL2 is an oEmbed dependency.
198
- Console_GetOpt for parsing command-line options.
199 200 201
- libomb. a library for implementing OpenMicroBlogging 0.1, the
  predecessor to OStatus.
- HTTP_Request2, a library for making HTTP requests.
202

Evan Prodromou's avatar
Evan Prodromou committed
203
A design goal of StatusNet is that the basic Web functionality should
204 205 206 207 208 209 210 211 212
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
213
Installing the basic StatusNet Web component is relatively easy,
214 215 216 217
especially if you've previously installed PHP/MySQL packages.

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

219
       tar zxf statusnet-0.9.1.tar.gz
Evan Prodromou's avatar
Evan Prodromou committed
220

221
   ...which will make a statusnet-0.9.1 subdirectory in your current
222 223 224
   directory. (If you don't have shell access on your Web server, you
   may have to unpack the tarball on your local computer and FTP the
   files to the server.)
Evan Prodromou's avatar
Evan Prodromou committed
225

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

229
       mv statusnet-0.9.1 /var/www/statusnet
Evan Prodromou's avatar
Evan Prodromou committed
230

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

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

239
       chmod a+w /var/www/statusnet/
Evan Prodromou's avatar
Evan Prodromou committed
240

241
   On some systems, this will probably work:
Evan Prodromou's avatar
Evan Prodromou committed
242

243
       chgrp www-data /var/www/statusnet/
244
       chmod g+w /var/www/statusnet/
245 246 247

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

250 251 252
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:
253

254 255 256
       chmod a+w /var/www/statusnet/avatar
       chmod a+w /var/www/statusnet/background
       chmod a+w /var/www/statusnet/file
257

258 259
   You can also make the avatar, background, and file directories
   writeable by the Web server group, as noted above.
260 261

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

264
       mysqladmin -u "username" --password="password" create statusnet
Evan Prodromou's avatar
Evan Prodromou committed
265

Evan Prodromou's avatar
Evan Prodromou committed
266
   Note that StatusNet must have its own database; you can't share the
267 268
   database with another program. You can name it whatever you want,
   though.
Evan Prodromou's avatar
Evan Prodromou committed
269

270 271 272 273
   (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
274
6. Create a new database account that StatusNet will use to access the
275 276
   database. If you have shell access, this will probably work from the
   MySQL shell:
Evan Prodromou's avatar
Evan Prodromou committed
277

278 279 280
       GRANT ALL on statusnet.*
       TO 'statusnetuser'@'localhost'
       IDENTIFIED BY 'statusnetpassword';
Evan Prodromou's avatar
Evan Prodromou committed
281

282
   You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
283 284 285
   username and password. You may want to test logging in to MySQL as
   this new user.

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

288
       http://yourserver.example.com/statusnet/install.php
289 290 291 292 293 294 295 296 297 298 299

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

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

301 302 303
Fancy URLs
----------

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

308
    http://example.org/statusnet/index.php/statusnet/fred
309 310 311 312

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

313
    http://example.org/statusnet/index.php?p=statusnet/fred
314 315 316

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

317
    http://example.org/statusnet/fred
318 319

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

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

331
2. Change the "RewriteBase" in the new .htaccess file to be the URL path
Evan Prodromou's avatar
Evan Prodromou committed
332 333
   to your StatusNet installation on your server. Typically this will
   be the path to your StatusNet directory relative to your Web root.
334 335 336 337

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

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

339 340 341
You should now be able to navigate to a "fancy" URL on your server,
like:

342
    http://example.net/statusnet/main/register
343 344 345 346

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

347 348 349 350 351 352
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:

353
    http://httpd.apache.org/docs/2.2/howto/htaccess.html
354 355 356

Also, check that mod_rewrite is installed and enabled:

357
    http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
358

359 360 361
Sphinx
------

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

365 366
    addPlugin('SphinxSearch');
    $config['sphinx']['server'] = 'searchhost.local';
367

368 369 370 371
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.
372

373 374 375
SMS
---

Evan Prodromou's avatar
Evan Prodromou committed
376
StatusNet supports a cheap-and-dirty system for sending update messages
377 378 379 380 381 382 383 384 385
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
386
converted to a notice and stored in the DB.
387 388 389 390

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

394
       mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
395 396 397 398 399 400

   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:

401
       chmod +x scripts/maildaemon.php
Evan Prodromou's avatar
Evan Prodromou committed
402

403 404
   Note that "daemon" is kind of a misnomer here; the script is more
   of a filter than a daemon.
Evan Prodromou's avatar
Evan Prodromou committed
405

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

408
       *: /path/to/statusnet/scripts/maildaemon.php
409 410 411

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

413
       newaliases
Evan Prodromou's avatar
Evan Prodromou committed
414

415 416 417 418 419
   You may need to restart your mail server for the new database to
   take effect.

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

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

422 423
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
424 425
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.
426 427 428 429

XMPP
----

430
XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
431 432 433 434 435 436 437 438
instant-messenger protocol that drives Jabber and GTalk IM. You can
distribute messages via XMPP using the system below; however, you
need to run the XMPP incoming daemon to allow incoming messages as
well.

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

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

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

449 450
3. Configure your site's XMPP variables, as described below in the
   configuration section.
Evan Prodromou's avatar
Evan Prodromou committed
451

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

459 460
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
461
work around this bug in StatusNet; current recommendation is to move
462 463
off of amd64 to another server.

464 465 466 467 468 469 470 471 472 473
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:

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

476 477 478 479 480 481 482 483
(Don't miss those square brackets at the end.) Note that your XMPP
broadcasting must be configured as mentioned above. Although you can
send out messages at "Web time", high-volume sites should strongly
consider setting up queues and daemons.

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

Brion Vibber's avatar
Brion Vibber committed
484
Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
485 486 487 488 489 490 491 492 493 494
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
495
2. If you're using a separate server for queues, install StatusNet
496 497 498 499 500 501 502
   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:

503
       $config['queue']['enabled'] = true;
504 505 506 507 508

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

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

512
This will run the queue handlers:
513

514
* queuedaemon.php - polls for queued items for inbox processing and
Brion Vibber's avatar
Brion Vibber committed
515
  pushing out to OStatus, SMS, XMPP, etc.
516
* xmppdaemon.php - listens for new XMPP messages from users and stores
517 518 519 520 521 522 523
  them as notices in the database; also pulls queued XMPP output from
  queuedaemon.php to push out to clients.

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

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

527
It may be a good idea to use a daemon-monitoring service, like 'monit',
528 529 530 531 532 533
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.

534
Since version 0.8.0, it's now possible to use a STOMP server instead of
Brion Vibber's avatar
Brion Vibber committed
535 536 537 538 539
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
540

541 542 543
Themes
------

Evan Prodromou's avatar
Evan Prodromou committed
544
There are two themes shipped with this version of StatusNet: "identica",
Evan Prodromou's avatar
Evan Prodromou committed
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
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
562
    Explorer 6.
Evan Prodromou's avatar
Evan Prodromou committed
563
ie7.css: a CSS2 file for override styling for fixing up Internet
564
    Explorer 7.
Evan Prodromou's avatar
Evan Prodromou committed
565 566
logo.png: a logo image for the site.
default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
567
    users who don't upload their own.
Evan Prodromou's avatar
Evan Prodromou committed
568 569
default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
570
    listing on profile pages.
Evan Prodromou's avatar
Evan Prodromou committed
571 572 573 574

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

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

579 580 581
Translation
-----------

Evan Prodromou's avatar
Evan Prodromou committed
582
Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
Evan Prodromou's avatar
Evan Prodromou committed
583 584 585 586
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
587
Contributions of translation information to StatusNet are very easy:
588
you can use the Web interface at TranslateWiki.net to add one
589 590 591
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.

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

594 595 596
Backups
-------

Evan Prodromou's avatar
Evan Prodromou committed
597 598
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
599
the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
600 601
and to backup the Web directory, try tar.

602 603 604 605 606 607 608 609
Private
-------

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

Evan Prodromou's avatar
Evan Prodromou committed
610 611 612 613
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.
614

615 616 617 618
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:

619
       mkdir /var/www/statusnet-files
620 621 622 623

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

624
       chmod a+x /var/www/statusnet-files
625 626 627 628

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

629
       $config['attachments']['dir'] = '/var/www/statusnet-files';
630

631 632 633
Upgrading
=========

Evan Prodromou's avatar
Evan Prodromou committed
634
IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
635 636 637 638 639 640
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
641
If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
642 643
been tracking the "git" version of the software, you will probably
want to upgrade and keep your existing data. There is no automated
644
upgrade procedure in StatusNet 0.9.1. Try these step-by-step
645
instructions; read to the end first before trying them.
Evan Prodromou's avatar
Evan Prodromou committed
646

Evan Prodromou's avatar
Evan Prodromou committed
647
0. Download StatusNet and set up all the prerequisites as if you were
Evan Prodromou's avatar
Evan Prodromou committed
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
   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.
664
6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
665
7. Unpack your StatusNet 0.9.1 tarball and move it to "statusnet" or
Evan Prodromou's avatar
Evan Prodromou committed
666 667 668 669 670
   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.
671
10. Rebuild the database. (You can safely skip this step and go to #12
672
    if you're upgrading from another 0.9.x version).
673 674

    NOTE: this step is destructive and cannot be
675 676 677
    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
678 679
    If your database is at version 0.8.0 or above, you can run a
    special upgrade script:
680

681
        mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
682

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

686
        ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
687 688 689

    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
690
    that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
691 692
    your database and rebuilds it; if there is an error you have no
    database. Make sure you have a backup.
693 694 695 696 697
    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
698 699 700 701 702 703
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
704 705
precooked data in the DB. All upgraders should check out the inboxes
options below.
Evan Prodromou's avatar
Evan Prodromou committed
706

707
NOTE: the database definition file, laconica.ini, has been renamed to
708
statusnet.ini (since this is the recommended database name). If you
709 710 711
have a line in your config.php pointing to the old name, you'll need
to update it.

712 713 714
Notice inboxes
--------------

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

718 719 720
UTF-8 Database
--------------

Evan Prodromou's avatar
Evan Prodromou committed
721
StatusNet 0.7.4 introduced a fix for some incorrectly-stored
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
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.

741 742 743
Configuration options
=====================

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

Evan Prodromou's avatar
Evan Prodromou committed
750 751 752 753 754 755 756
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.

757
Starting with version 0.7.1, you can put config files in the
758
/etc/statusnet/ directory on your server, if it exists. Config files
759 760
will be included in this order:

761
* /etc/statusnet/statusnet.php - server-wide config
762 763
* /etc/statusnet/<servername>.php - for a virtual host
* /etc/statusnet/<servername>_<pathname>.php - for a path
764 765
* INSTALLDIR/config.php - for a particular implementation

766 767 768 769
Almost all configuration options are made through a two-dimensional
associative array, cleverly named $config. A typical configuration
line will be:

770
    $config['section']['option'] = value;
771 772 773 774 775 776 777 778 779 780 781

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

854 855 856 857
db
--

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

Evan Prodromou's avatar
Evan Prodromou committed
861
database: a DSN (Data Source Name) for your StatusNet database. This is
862 863 864 865
    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.
866
ini_yourdbname: if your database is not named 'statusnet', you'll need
867 868 869
    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'.
870
db_driver: You can try changing this to 'MDB2' to use the other driver
871 872
    type for DB_DataObject, but note that it breaks the OpenID
    libraries, which only support PEAR::DB.
873
debug: On a database error, you may get a message saying to set this
874 875 876
    value to 5 to see debug messages in the browser. This breaks
    just about all pages, and will also expose the username and
    password
877 878
quote_identifiers: Set this to true if you're using postgresql.
type: either 'mysql' or 'postgresql' (used for some bits of
879
    database-type-specific SQL in the code). Defaults to mysql.
880
mirror: you can set this to an array of DSNs, like the above
881 882 883 884 885 886 887
    '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.
888
utf8: whether to talk to the database in UTF-8 mode. This is the default
889 890 891
    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
892
schemacheck: when to let plugins check the database schema to add
893 894 895 896 897 898 899
    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.
900

901 902 903
syslog
------

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

Evan Prodromou's avatar
Evan Prodromou committed
907
appname: The name that StatusNet uses to log messages. By default it's
908 909 910
    "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
911 912
priority: level to log at. Currently ignored.
facility: what syslog facility to used. Defaults to LOG_USER, only
913 914
    reset if you know what syslog is and have a good reason
    to change it.
915 916 917 918 919 920 921 922

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
923
enabled: Whether to uses queues. Defaults to false.
Evan Prodromou's avatar
Evan Prodromou committed
924
subsystem: Which kind of queueserver to use. Values include "db" for
925 926
    our hacked-together database queuing (no other server
    required) and "stomp" for a stomp server.
Evan Prodromou's avatar
Evan Prodromou committed
927
stomp_server: "broker URI" for stomp server. Something like
928 929 930
    "tcp://hostname:61613". More complicated ones are
    possible; see your stomp server's documentation for
    details.
Evan Prodromou's avatar
Evan Prodromou committed
931
queue_basename: a root name to use for queues (stomp only). Typically
932 933 934 935
    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
936

Evan Prodromou's avatar
Evan Prodromou committed
937
stomp_username: username for connecting to the stomp server; defaults
938
    to null.
Evan Prodromou's avatar
Evan Prodromou committed
939
stomp_password: password for connecting to the stomp server; defaults
940
    to null.
Brion Vibber's avatar
Brion Vibber committed
941 942

stomp_persistent: keep items across queue server restart, if enabled.
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
    Under ActiveMQ, the server configuration determines if and how
    persistent storage is actually saved.

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

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

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

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

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

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

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

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

978 979 980
        Default will share all queues for all sites within each group.
        Specify as <group>/<queue> or <group>/<queue>/<site>,
        using nickname identifier as site.
Brion Vibber's avatar
Brion Vibber committed
981

982 983
        'main/distrib' separate "distrib" queue covering all sites
        'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
Brion Vibber's avatar
Brion Vibber committed
984 985

max_retries: for stomp, drop messages after N failed attempts to process.
986
    Defaults to 10.
Brion Vibber's avatar
Brion Vibber committed
987 988

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

991 992 993 994 995 996
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