]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - README
* fix some i18n and L10n issues
[quix0rs-gnu-social.git] / README
1 ------
2 README
3 ------
4
5 StatusNet 0.9.6 "Man on the Moon"
6 29 October 2010
7
8 This is the README file for StatusNet, the Open Source microblogging
9 platform. It includes installation instructions, descriptions of
10 options you can set, warnings, tips, and general info for
11 administrators. Information on using StatusNet can be found in the
12 "doc" subdirectory or in the "help" section on-line.
13
14 About
15 =====
16
17 StatusNet is a Free and Open Source microblogging platform. It helps
18 people in a community, company or group to exchange short (140
19 characters, by default) messages over the Web. Users can choose which
20 people to "follow" and receive only their friends' or colleagues'
21 status messages. It provides a similar service to sites like Twitter,
22 Google Buzz, or Yammer.
23
24 With a little work, status messages can be sent to mobile phones,
25 instant messenger programs (GTalk/Jabber), and specially-designed
26 desktop clients that support the Twitter API.
27
28 StatusNet supports an open standard called OStatus
29 <http://ostatus.org/> that lets users in different networks follow
30 each other. It enables a distributed social network spread all across
31 the Web.
32
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 Web service, requiring no installation on your part. See
42 <http://status.net/signup> for details. The software run
43 on status.net is identical to the software available for download, so
44 you can move back and forth between a hosted version or a version
45 installed on your own servers.
46
47 A commercial software subscription is available from StatusNet Inc. It
48 includes 24-hour technical support and developer support. More
49 information at http://status.net/contact or email sales@status.net.
50
51 License
52 =======
53
54 This program is free software: you can redistribute it and/or modify
55 it under the terms of the GNU Affero General Public License as
56 published by the Free Software Foundation, either version 3 of the
57 License, or (at your option) any later version.
58
59 This program is distributed in the hope that it will be useful, but
60 WITHOUT ANY WARRANTY; without even the implied warranty of
61 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
62 Affero General Public License for more details.
63
64 You should have received a copy of the GNU Affero General Public
65 License along with this program, in the file "COPYING".  If not, see
66 <http://www.gnu.org/licenses/>.
67
68     IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
69     *different requirements* from the "regular" GPL. In particular, if
70     you make modifications to the StatusNet source code on your server,
71     you *MUST MAKE AVAILABLE* the modified version of the source code
72     to your users under the same license. This is a legal requirement
73     of using the software, and if you do not wish to share your
74     modifications, *YOU MAY NOT INSTALL STATUSNET*.
75
76 Documentation in the /doc-src/ directory is available under the
77 Creative Commons Attribution 3.0 Unported license, with attribution to
78 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
79
80 CSS and images in the /theme/ directory are available under the
81 Creative Commons Attribution 3.0 Unported license, with attribution to
82 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
83
84 Our understanding and intention is that if you add your own theme that
85 uses only CSS and images, those files are not subject to the copyleft
86 requirements of the Affero General Public License 3.0. See
87 http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
88 legal advice; consult your lawyer.
89
90 Additional library software has been made available in the 'extlib'
91 directory. All of it is Free Software and can be distributed under
92 liberal terms, but those terms may differ in detail from the AGPL's
93 particulars. See each package's license file in the extlib directory
94 for additional terms.
95
96 New this version
97 ================
98
99 This is a security, bug and feature release since version 0.9.5 released on
100 10 September 2010.
101
102 For best compatibility with client software and site federation, and a lot of
103 bug fixes, it is highly recommended that all public sites upgrade to the new
104 version.
105
106 Notable changes this version:
107
108 - Site moderators can now delete groups.
109 - New themes: clean, shiny, mnml, victorian
110 - New YammerImport plugin allows site admins to import non-private profiles and
111   message from an authenticated Yammer site.
112 - New experimental plugins: AnonFavorites, SlicedFavorites, GroupFavorited,
113   ForceGroup, ShareNotice
114 - OAuth upgraded to 1.0a
115 - Localization updates now include plugins, thanks to translatewiki.net!
116 - SSL link generation should be more consistent; alternate SSL URLs can be
117   set in the admin UI for more parts of the system.
118 - Experimental backupuser.php, restoreuser.php command-line scripts to
119   dump/restore a user's complete activity stream. Can be used to transfer
120   accounts manually between sites, or to save a backup before deleting.
121 - Unicode fixes for OStatus notices
122 - Header metadata on notice pages to aid in manual reposting on Facebook
123 - Lots of little fixes...
124
125 Changes from 0.9.6 release candidate 1:
126 - fix for broken group pages when logged out
127 - fix for stuck ping queue entries when bad profile
128 - fix for bogus single-user nickname config entry error
129 - i18n updates
130 - nofollow updates
131 - SSL-only mode secure cookie fix
132 - experimental ApiLogger plugin for usage data gathering
133 - experimental follow-everyone plugin
134
135 A full changelog is available at http://status.net/wiki/StatusNet_0.9.6.
136
137 Prerequisites
138 =============
139
140 The following software packages are *required* for this software to
141 run correctly.
142
143 - PHP 5.2.3+. It may be possible to run this software on earlier
144   versions of PHP, but many of the functions used are only available
145   in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
146   daemons on 64-bit platforms. PHP 5.3.x should work correctly in this
147   release, but problems with some plugins are possible.
148 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
149   server. It has been primarily tested on 5.x servers, although it may
150   be possible to install on earlier (or later!) versions. The server
151   *must* support the MyISAM storage engine -- the default for most
152   MySQL servers -- *and* the InnoDB storage engine.
153 - A Web server. Preferably, you should have Apache 2.2.x with the
154   mod_rewrite extension installed and enabled.
155
156 Your PHP installation must include the following PHP extensions:
157
158 - Curl. This is for fetching files by HTTP.
159 - XMLWriter. This is for formatting XML and HTML output.
160 - MySQL. For accessing the database.
161 - GD. For scaling down avatar images.
162 - mbstring. For handling Unicode (UTF-8) encoded strings.
163
164 For some functionality, you will also need the following extensions:
165
166 - Memcache. A client for the memcached server, which caches database
167   information in volatile memory. This is important for adequate
168   performance on high-traffic sites. You will also need a memcached
169   server to store the data in.
170 - Mailparse. Efficient parsing of email requires this extension.
171   Submission by email or SMS-over-email uses this extension.
172 - Sphinx Search. A client for the sphinx server, an alternative
173   to MySQL or Postgresql fulltext search. You will also need a
174   Sphinx server to serve the search queries.
175 - bcmath or gmp. For Salmon signatures (part of OStatus). Needed
176   if you have OStatus configured.
177 - gettext. For multiple languages. Default on many PHP installs;
178   will be emulated if not present.
179
180 You will almost definitely get 2-3 times better performance from your
181 site if you install a PHP bytecode cache/accelerator. Some well-known
182 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
183 is a proprietary accelerator installed on some hosting sites.
184
185 External libraries
186 ------------------
187
188 A number of external PHP libraries are used to provide basic
189 functionality and optional functionality for your system. For your
190 convenience, they are available in the "extlib" directory of this
191 package, and you do not have to download and install them. However,
192 you may want to keep them up-to-date with the latest upstream version,
193 and the URLs are listed here for your convenience.
194
195 - DB_DataObject http://pear.php.net/package/DB_DataObject
196 - Validate http://pear.php.net/package/Validate
197 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
198   to use the openidenabled.com version since it's more widely
199   implemented, and seems to be better supported.
200   http://openidenabled.com/php-openid/
201 - PEAR DB. Although this is an older data access system (new
202   packages should probably use PHP DBO), the OpenID libraries
203   depend on PEAR DB so we use it here, too. DB_DataObject can
204   also use PEAR MDB2, which may give you better performance
205   but won't work with OpenID.
206   http://pear.php.net/package/DB
207 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
208 - markdown.php from http://michelf.com/projects/php-markdown/
209 - PEAR Mail, for sending out mail notifications
210   http://pear.php.net/package/Mail
211 - PEAR Net_SMTP, if you use the SMTP factory for notifications
212   http://pear.php.net/package/Net_SMTP
213 - PEAR Net_Socket, if you use the SMTP factory for notifications
214   http://pear.php.net/package/Net_Socket
215 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
216   library available for PHP. http://xmpphp.googlecode.com/. Note that
217   as of this writing the version of this library that is available in
218   the extlib directory is *significantly different* from the upstream
219   version (patches have been submitted). Upgrading to the upstream
220   version may render your StatusNet site unable to send or receive XMPP
221   messages.
222 - Facebook library. Used for the Facebook application.
223 - PEAR Validate is used for URL and email validation.
224 - Console_GetOpt for parsing command-line options.
225 - libomb. a library for implementing OpenMicroBlogging 0.1, the
226   predecessor to OStatus.
227 - HTTP_Request2, a library for making HTTP requests.
228 - PEAR Net_URL2 is an HTTP_Request2 dependency.
229
230 A design goal of StatusNet is that the basic Web functionality should
231 work on even the most restrictive commercial hosting services.
232 However, additional functionality, such as receiving messages by
233 Jabber/GTalk, require that you be able to run long-running processes
234 on your account. In addition, posting by email or from SMS require
235 that you be able to install a mail filter in your mail server.
236
237 Installation
238 ============
239
240 Installing the basic StatusNet Web component is relatively easy,
241 especially if you've previously installed PHP/MySQL packages.
242
243 1. Unpack the tarball you downloaded on your Web server. Usually a
244    command like this will work:
245
246        tar zxf statusnet-0.9.6.tar.gz
247
248    ...which will make a statusnet-0.9.6 subdirectory in your current
249    directory. (If you don't have shell access on your Web server, you
250    may have to unpack the tarball on your local computer and FTP the
251    files to the server.)
252
253 2. Move the tarball to a directory of your choosing in your Web root
254    directory. Usually something like this will work:
255
256        mv statusnet-0.9.6 /var/www/statusnet
257
258    This will make your StatusNet instance available in the statusnet path of
259    your server, like "http://example.net/statusnet". "microblog" or
260    "statusnet" might also be good path names. If you know how to
261    configure virtual hosts on your web server, you can try setting up
262    "http://micro.example.net/" or the like.
263
264 3. Make your target directory writeable by the Web server.
265
266        chmod a+w /var/www/statusnet/
267
268    On some systems, this will probably work:
269
270        chgrp www-data /var/www/statusnet/
271        chmod g+w /var/www/statusnet/
272
273    If your Web server runs as another user besides "www-data", try
274    that user's default group instead. As a last resort, you can create
275    a new group like "statusnet" and add the Web server's user to the group.
276
277 4. You should also take this moment to make your avatar, background, and
278    file subdirectories writeable by the Web server. An insecure way to do
279    this is:
280
281        chmod a+w /var/www/statusnet/avatar
282        chmod a+w /var/www/statusnet/background
283        chmod a+w /var/www/statusnet/file
284
285    You can also make the avatar, background, and file directories
286    writeable by the Web server group, as noted above.
287
288 5. Create a database to hold your microblog data. Something like this
289    should work:
290
291        mysqladmin -u "username" --password="password" create statusnet
292
293    Note that StatusNet must have its own database; you can't share the
294    database with another program. You can name it whatever you want,
295    though.
296
297    (If you don't have shell access to your server, you may need to use
298    a tool like PHPAdmin to create a database. Check your hosting
299    service's documentation for how to create a new MySQL database.)
300
301 6. Create a new database account that StatusNet will use to access the
302    database. If you have shell access, this will probably work from the
303    MySQL shell:
304
305        GRANT ALL on statusnet.*
306        TO 'statusnetuser'@'localhost'
307        IDENTIFIED BY 'statusnetpassword';
308
309    You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
310    username and password. You may want to test logging in to MySQL as
311    this new user.
312
313 7. In a browser, navigate to the StatusNet install script; something like:
314
315        http://yourserver.example.com/statusnet/install.php
316
317    Enter the database connection information and your site name. The
318    install program will configure your site and install the initial,
319    almost-empty database.
320
321 8. You should now be able to navigate to your microblog's main directory
322    and see the "Public Timeline", which will be empty. If not, magic
323    has happened! You can now register a new user, post some notices,
324    edit your profile, etc. However, you may want to wait to do that stuff
325    if you think you can set up "fancy URLs" (see below), since some
326    URLs are stored in the database.
327
328 Fancy URLs
329 ----------
330
331 By default, StatusNet will use URLs that include the main PHP program's
332 name in them. For example, a user's home profile might be
333 found at:
334
335     http://example.org/statusnet/index.php/statusnet/fred
336
337 On certain systems that don't support this kind of syntax, they'll
338 look like this:
339
340     http://example.org/statusnet/index.php?p=statusnet/fred
341
342 It's possible to configure the software so it looks like this instead:
343
344     http://example.org/statusnet/fred
345
346 These "fancy URLs" are more readable and memorable for users. To use
347 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
348 mod_rewrite enabled, -OR- know how to configure "url redirection" in
349 your server.
350
351 1. Copy the htaccess.sample file to .htaccess in your StatusNet
352    directory. Note: if you have control of your server's httpd.conf or
353    similar configuration files, it can greatly improve performance to
354    import the .htaccess file into your conf file instead. If you're
355    not sure how to do it, you may save yourself a lot of headache by
356    just leaving the .htaccess file.
357
358 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
359    to your StatusNet installation on your server. Typically this will
360    be the path to your StatusNet directory relative to your Web root.
361
362 3. Add or uncomment or change a line in your config.php file so it says:
363
364        $config['site']['fancy'] = true;
365
366 You should now be able to navigate to a "fancy" URL on your server,
367 like:
368
369     http://example.net/statusnet/main/register
370
371 If you changed your HTTP server configuration, you may need to restart
372 the server first.
373
374 If it doesn't work, double-check that AllowOverride for the StatusNet
375 directory is 'All' in your Apache configuration file. This is usually
376 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
377 /etc/apache2/sites-available/default. See the Apache documentation for
378 .htaccess files for more details:
379
380     http://httpd.apache.org/docs/2.2/howto/htaccess.html
381
382 Also, check that mod_rewrite is installed and enabled:
383
384     http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
385
386 Sphinx
387 ------
388
389 To use a Sphinx server to search users and notices, you'll need to
390 enable the SphinxSearch plugin. Add to your config.php:
391
392     addPlugin('SphinxSearch');
393     $config['sphinx']['server'] = 'searchhost.local';
394
395 You also need to install, compile and enable the sphinx pecl extension for
396 php on the client side, which itself depends on the sphinx development files.
397
398 See plugins/SphinxSearch/README for more details and server setup.
399
400 SMS
401 ---
402
403 StatusNet supports a cheap-and-dirty system for sending update messages
404 to mobile phones and for receiving updates from the mobile. Instead of
405 sending through the SMS network itself, which is costly and requires
406 buy-in from the wireless carriers, it simply piggybacks on the email
407 gateways that many carriers provide to their customers. So, SMS
408 configuration is essentially email configuration.
409
410 Each user sends to a made-up email address, which they keep a secret.
411 Incoming email that is "From" the user's SMS email address, and "To"
412 the users' secret email address on the site's domain, will be
413 converted to a notice and stored in the DB.
414
415 For this to work, there *must* be a domain or sub-domain for which all
416 (or most) incoming email can pass through the incoming mail filter.
417
418 1. Run the SQL script carrier.sql in your StatusNet database. This will
419    usually work:
420
421        mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
422
423    This will populate your database with a list of wireless carriers
424    that support email SMS gateways.
425
426 2. Make sure the maildaemon.php file is executable:
427
428        chmod +x scripts/maildaemon.php
429
430    Note that "daemon" is kind of a misnomer here; the script is more
431    of a filter than a daemon.
432
433 2. Edit /etc/aliases on your mail server and add the following line:
434
435        *: /path/to/statusnet/scripts/maildaemon.php
436
437 3. Run whatever code you need to to update your aliases database. For
438    many mail servers (Postfix, Exim, Sendmail), this should work:
439
440        newaliases
441
442    You may need to restart your mail server for the new database to
443    take effect.
444
445 4. Set the following in your config.php file:
446
447        $config['mail']['domain'] = 'yourdomain.example.net';
448
449 At this point, post-by-email and post-by-SMS-gateway should work. Note
450 that if your mail server is on a different computer from your email
451 server, you'll need to have a full installation of StatusNet, a working
452 config.php, and access to the StatusNet database from the mail server.
453
454 XMPP
455 ----
456
457 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
458 instant-messenger protocol that drives Jabber and GTalk IM. You can
459 distribute messages via XMPP using the system below; however, you
460 need to run the XMPP incoming daemon to allow incoming messages as
461 well.
462
463 1. You may want to strongly consider setting up your own XMPP server.
464    Ejabberd, OpenFire, and JabberD are all Open Source servers.
465    Jabber, Inc. provides a high-performance commercial server.
466
467 2. You must register a Jabber ID (JID) with your new server. It helps
468    to choose a name like "update@example.com" or "notice" or something
469    similar.  Alternately, your "update JID" can be registered on a
470    publicly-available XMPP service, like jabber.org or GTalk.
471
472    StatusNet will not register the JID with your chosen XMPP server;
473    you need to do this manually, with an XMPP client like Gajim,
474    Telepathy, or Pidgin.im.
475
476 3. Configure your site's XMPP variables, as described below in the
477    configuration section.
478
479 On a default installation, your site can broadcast messages using
480 XMPP. Users won't be able to post messages using XMPP unless you've
481 got the XMPP daemon running.  See 'Queues and daemons' below for how
482 to set that up. Also, once you have a sizable number of users, sending
483 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
484 can really slow down your site; it may cause posting to timeout.
485
486 NOTE: stream_select(), a crucial function for network programming, is
487 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
488 work around this bug in StatusNet; current recommendation is to move
489 off of amd64 to another server.
490
491 Public feed
492 -----------
493
494 You can send *all* messages from your microblogging site to a
495 third-party service using XMPP. This can be useful for providing
496 search, indexing, bridging, or other cool services.
497
498 To configure a downstream site to receive your public stream, add
499 their "JID" (Jabber ID) to your config.php as follows:
500
501     $config['xmpp']['public'][] = 'downstream@example.net';
502
503 (Don't miss those square brackets at the end.) Note that your XMPP
504 broadcasting must be configured as mentioned above. Although you can
505 send out messages at "Web time", high-volume sites should strongly
506 consider setting up queues and daemons.
507
508 Queues and daemons
509 ------------------
510
511 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
512 and XMPP messages, can be 'queued' and done by off-line bots instead.
513 For this to work, you must be able to run long-running offline
514 processes, either on your main Web server or on another server you
515 control. (Your other server will still need all the above
516 prerequisites, with the exception of Apache.) Installing on a separate
517 server is probably a good idea for high-volume sites.
518
519 1. You'll need the "CLI" (command-line interface) version of PHP
520    installed on whatever server you use.
521
522 2. If you're using a separate server for queues, install StatusNet
523    somewhere on the server. You don't need to worry about the
524    .htaccess file, but make sure that your config.php file is close
525    to, or identical to, your Web server's version.
526
527 3. In your config.php files (both the Web server and the queues
528    server!), set the following variable:
529
530        $config['queue']['enabled'] = true;
531
532    You may also want to look at the 'daemon' section of this file for
533    more daemon options. Note that if you set the 'user' and/or 'group'
534    options, you'll need to create that user and/or group by hand.
535    They're not created automatically.
536
537 4. On the queues server, run the command scripts/startdaemons.sh.
538
539 This will run the queue handlers:
540
541 * queuedaemon.php - polls for queued items for inbox processing and
542   pushing out to OStatus, SMS, XMPP, etc.
543 * xmppdaemon.php - listens for new XMPP messages from users and stores
544   them as notices in the database; also pulls queued XMPP output from
545   queuedaemon.php to push out to clients.
546
547 These two daemons will automatically restart in most cases of failure
548 including memory leaks (if a memory_limit is set), but may still die
549 or behave oddly if they lose connections to the XMPP or queue servers.
550
551 Additional daemons may be also started by this script for certain
552 plugins, such as the Twitter bridge.
553
554 It may be a good idea to use a daemon-monitoring service, like 'monit',
555 to check their status and keep them running.
556
557 All the daemons write their process IDs (pids) to /var/run/ by
558 default. This can be useful for starting, stopping, and monitoring the
559 daemons.
560
561 Since version 0.8.0, it's now possible to use a STOMP server instead of
562 our kind of hacky home-grown DB-based queue solution. This is strongly
563 recommended for best response time, especially when using XMPP.
564
565 See the "queues" config section below for how to configure to use STOMP.
566 As of this writing, the software has been tested with ActiveMQ 5.3.
567
568 Themes
569 ------
570
571 There are two themes shipped with this version of StatusNet: "identica",
572 which is what the Identi.ca site uses, and "default", which is a good
573 basis for other sites.
574
575 As of right now, your ability to change the theme is site-wide; users
576 can't choose their own theme. Additionally, the only thing you can
577 change in the theme is CSS stylesheets and some image files; you can't
578 change the HTML output, like adding or removing menu items.
579
580 You can choose a theme using the $config['site']['theme'] element in
581 the config.php file. See below for details.
582
583 You can add your own theme by making a sub-directory of the 'theme'
584 subdirectory with the name of your theme. Each theme can have the
585 following files:
586
587 display.css: a CSS2 file for "default" styling for all browsers.
588 ie6.css: a CSS2 file for override styling for fixing up Internet
589     Explorer 6.
590 ie7.css: a CSS2 file for override styling for fixing up Internet
591     Explorer 7.
592 logo.png: a logo image for the site.
593 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
594     users who don't upload their own.
595 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
596 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
597     listing on profile pages.
598
599 You may want to start by copying the files from the default theme to
600 your own directory.
601
602 NOTE: the HTML generated by StatusNet changed *radically* between
603 version 0.6.x and 0.7.x. Older themes will need signification
604 modification to use the new output format.
605
606 Translation
607 -----------
608
609 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
610 Theoretically, you can add your own sub-directory to the locale/
611 subdirectory to add a new language to your system. You'll need to
612 compile the ".po" files into ".mo" files, however.
613
614 Contributions of translation information to StatusNet are very easy:
615 you can use the Web interface at translatewiki.net to add one
616 or a few or lots of new translations -- or even new languages. You can
617 also download more up-to-date .po files there, if you so desire.
618
619 For info on helping with translations, see http://status.net/wiki/Translations
620
621 Backups
622 -------
623
624 There is no built-in system for doing backups in StatusNet. You can make
625 backups of a working StatusNet system by backing up the database and
626 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
627 and to backup the Web directory, try tar.
628
629 Private
630 -------
631
632 The administrator can set the "private" flag for a site so that it's
633 not visible to non-logged-in users. This might be useful for
634 workgroups who want to share a microblogging site for project
635 management, but host it on a public server.
636
637 Total privacy is not guaranteed or ensured. Also, privacy is
638 all-or-nothing for a site; you can't have some accounts or notices
639 private, and others public. The interaction of private sites
640 with OStatus is undefined.
641
642 Access to file attachments can also be restricted to logged-in users only.
643 1. Add a directory outside the web root where your file uploads will be
644    stored. Usually a command like this will work:
645
646        mkdir /var/www/statusnet-files
647
648 2. Make the file uploads directory writeable by the web server. An
649    insecure way to do this is:
650
651        chmod a+x /var/www/statusnet-files
652
653 3. Tell StatusNet to use this directory for file uploads. Add a line
654    like this to your config.php:
655
656        $config['attachments']['dir'] = '/var/www/statusnet-files';
657
658 Upgrading
659 =========
660
661 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
662 incorrectly-stored international characters ("UTF-8"). For new
663 installations, it will now store non-ASCII characters correctly.
664 However, older installations will have the incorrect storage, and will
665 consequently show up "wrong" in browsers. See below for how to deal
666 with this situation.
667
668 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
669 been tracking the "git" version of the software, you will probably
670 want to upgrade and keep your existing data. There is no automated
671 upgrade procedure in StatusNet 0.9.6. Try these step-by-step
672 instructions; read to the end first before trying them.
673
674 0. Download StatusNet and set up all the prerequisites as if you were
675    doing a new install.
676 1. Make backups of both your database and your Web directory. UNDER NO
677    CIRCUMSTANCES should you try to do an upgrade without a known-good
678    backup. You have been warned.
679 2. Shut down Web access to your site, either by turning off your Web
680    server or by redirecting all pages to a "sorry, under maintenance"
681    page.
682 3. Shut down XMPP access to your site, typically by shutting down the
683    xmppdaemon.php process and all other daemons that you're running.
684    If you've got "monit" or "cron" automatically restarting your
685    daemons, make sure to turn that off, too.
686 4. Shut down SMS and email access to your site. The easy way to do
687    this is to comment out the line piping incoming email to your
688    maildaemon.php file, and running something like "newaliases".
689 5. Once all writing processes to your site are turned off, make a
690    final backup of the Web directory and database.
691 6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
692 7. Unpack your StatusNet 0.9.6 tarball and move it to "statusnet" or
693    wherever your code used to be.
694 8. Copy the config.php file and the contents of the avatar/, background/,
695    file/, and local/ subdirectories from your old directory to your new
696    directory.
697 9. Copy htaccess.sample to .htaccess in the new directory. Change the
698    RewriteBase to use the correct path.
699 10. Rebuild the database. (You can safely skip this step and go to #12
700     if you're upgrading from another 0.9.x version).
701
702     NOTE: this step is destructive and cannot be
703     reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
704     do it without a known-good backup!
705
706     If your database is at version 0.8.0 or above, you can run a
707     special upgrade script:
708
709         mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
710
711     Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
712     BACKUP run the rebuilddb.sh script like this:
713
714         ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
715
716     Here, rootuser and rootpassword are the username and password for a
717     user who can drop and create databases as well as tables; typically
718     that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
719     your database and rebuilds it; if there is an error you have no
720     database. Make sure you have a backup.
721     For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
722     which operates slightly differently. Read the documentation in that
723     script before running it.
724 11. Use mysql or psql client to log into your database and make sure that
725     the notice, user, profile, subscription etc. tables are non-empty.
726 12. Turn back on the Web server, and check that things still work.
727 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
728     bots have changed since version 0.5; see above for details.
729
730 If you're upgrading from very old versions, you may want to look at
731 the fixup_* scripts in the scripts directories. These will store some
732 precooked data in the DB. All upgraders should check out the inboxes
733 options below.
734
735 NOTE: the database definition file, laconica.ini, has been renamed to
736 statusnet.ini (since this is the recommended database name). If you
737 have a line in your config.php pointing to the old name, you'll need
738 to update it.
739
740 Notice inboxes
741 --------------
742
743 Notice inboxes are now required. If you don't have inboxes enabled,
744 StatusNet will no longer run.
745
746 UTF-8 Database
747 --------------
748
749 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
750 international characters ("UTF-8"). This fix is not
751 backwards-compatible; installations from before 0.7.4 will show
752 non-ASCII characters of old notices incorrectly. This section explains
753 what to do.
754
755 0. You can disable the new behaviour by setting the 'db''utf8' config
756    option to "false". You should only do this until you're ready to
757    convert your DB to the new format.
758 1. When you're ready to convert, you can run the fixup_utf8.php script
759    in the scripts/ subdirectory. If you've had the "new behaviour"
760    enabled (probably a good idea), you can give the ID of the first
761    "new" notice as a parameter, and only notices before that one will
762    be converted. Notices are converted in reverse chronological order,
763    so the most recent (and visible) ones will be converted first. The
764    script should work whether or not you have the 'db''utf8' config
765    option enabled.
766 2. When you're ready, set $config['db']['utf8'] to true, so that
767    new notices will be stored correctly.
768
769 Configuration options
770 =====================
771
772 The main configuration file for StatusNet (excepting configurations for
773 dependency software) is config.php in your StatusNet directory. If you
774 edit any other file in the directory, like lib/default.php (where most
775 of the defaults are defined), you will lose your configuration options
776 in any upgrade, and you will wish that you had been more careful.
777
778 Starting with version 0.9.0, a Web based configuration panel has been
779 added to StatusNet. The preferred method for changing config options is
780 to use this panel.
781
782 A command-line script, setconfig.php, can be used to set individual
783 configuration options. It's in the scripts/ directory.
784
785 Starting with version 0.7.1, you can put config files in the
786 /etc/statusnet/ directory on your server, if it exists. Config files
787 will be included in this order:
788
789 * /etc/statusnet/statusnet.php - server-wide config
790 * /etc/statusnet/<servername>.php - for a virtual host
791 * /etc/statusnet/<servername>_<pathname>.php - for a path
792 * INSTALLDIR/config.php - for a particular implementation
793
794 Almost all configuration options are made through a two-dimensional
795 associative array, cleverly named $config. A typical configuration
796 line will be:
797
798     $config['section']['option'] = value;
799
800 For brevity, the following documentation describes each section and
801 option.
802
803 site
804 ----
805
806 This section is a catch-all for site-wide variables.
807
808 name: the name of your site, like 'YourCompany Microblog'.
809 server: the server part of your site's URLs, like 'example.net'.
810 path: The path part of your site's URLs, like 'statusnet' or ''
811     (installed in root).
812 fancy: whether or not your site uses fancy URLs (see Fancy URLs
813     section above). Default is false.
814 logfile: full path to a file for StatusNet to save logging
815     information to. You may want to use this if you don't have
816     access to syslog.
817 logdebug: whether to log additional debug info like backtraces on
818     hard errors. Default false.
819 locale_path: full path to the directory for locale data. Unless you
820     store all your locale data in one place, you probably
821     don't need to use this.
822 language: default language for your site. Defaults to US English.
823     Note that this is overridden if a user is logged in and has
824     selected a different language. It is also overridden if the
825     user is NOT logged in, but their browser requests a different
826     langauge. Since pretty much everybody's browser requests a
827     language, that means that changing this setting has little or
828     no effect in practice.
829 languages: A list of languages supported on your site. Typically you'd
830     only change this if you wanted to disable support for one
831     or another language:
832     "unset($config['site']['languages']['de'])" will disable
833     support for German.
834 theme: Theme for your site (see Theme section). Two themes are
835     provided by default: 'default' and 'stoica' (the one used by
836     Identi.ca). It's appreciated if you don't use the 'stoica' theme
837     except as the basis for your own.
838 email: contact email address for your site. By default, it's extracted
839     from your Web server environment; you may want to customize it.
840 broughtbyurl: name of an organization or individual who provides the
841     service. Each page will include a link to this name in the
842     footer. A good way to link to the blog, forum, wiki,
843     corporate portal, or whoever is making the service available.
844 broughtby: text used for the "brought by" link.
845 timezone: default timezone for message display. Users can set their
846     own time zone. Defaults to 'UTC', which is a pretty good default.
847 closed: If set to 'true', will disallow registration on your site.
848     This is a cheap way to restrict accounts to only one
849     individual or group; just register the accounts you want on
850     the service, *then* set this variable to 'true'.
851 inviteonly: If set to 'true', will only allow registration if the user
852     was invited by an existing user.
853 private: If set to 'true', anonymous users will be redirected to the
854     'login' page. Also, API methods that normally require no
855     authentication will require it. Note that this does not turn
856     off registration; use 'closed' or 'inviteonly' for the
857     behaviour you want.
858 notice: A plain string that will appear on every page. A good place
859     to put introductory information about your service, or info about
860     upgrades and outages, or other community info. Any HTML will
861     be escaped.
862 logo: URL of an image file to use as the logo for the site. Overrides
863     the logo in the theme, if any.
864 ssllogo: URL of an image file to use as the logo on SSL pages. If unset,
865     theme logo is used instead.
866 ssl: Whether to use SSL and https:// URLs for some or all pages.
867     Possible values are 'always' (use it for all pages), 'never'
868     (don't use it for any pages), or 'sometimes' (use it for
869     sensitive pages that include passwords like login and registration,
870     but not for regular pages). Default to 'never'.
871 sslserver: use an alternate server name for SSL URLs, like
872     'secure.example.org'. You should be careful to set cookie
873     parameters correctly so that both the SSL server and the
874     "normal" server can access the session cookie and
875     preferably other cookies as well.
876 shorturllength: Length of URL at which URLs in a message exceeding 140
877     characters will be sent to the user's chosen
878     shortening service.
879 dupelimit: minimum time allowed for one person to say the same thing
880     twice. Default 60s. Anything lower is considered a user
881     or UI error.
882 textlimit: default max size for texts in the site. Defaults to 140.
883     0 means no limit. Can be fine-tuned for notices, messages,
884     profile bios and group descriptions.
885
886 db
887 --
888
889 This section is a reference to the configuration options for
890 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
891 set are listed below for clarity.
892
893 database: a DSN (Data Source Name) for your StatusNet database. This is
894     in the format 'protocol://username:password@hostname/databasename',
895     where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
896     really know what you're doing), 'username' is the username,
897     'password' is the password, and etc.
898 ini_yourdbname: if your database is not named 'statusnet', you'll need
899     to set this to point to the location of the
900     statusnet.ini file. Note that the real name of your database
901     should go in there, not literally 'yourdbname'.
902 db_driver: You can try changing this to 'MDB2' to use the other driver
903     type for DB_DataObject, but note that it breaks the OpenID
904     libraries, which only support PEAR::DB.
905 debug: On a database error, you may get a message saying to set this
906     value to 5 to see debug messages in the browser. This breaks
907     just about all pages, and will also expose the username and
908     password
909 quote_identifiers: Set this to true if you're using postgresql.
910 type: either 'mysql' or 'postgresql' (used for some bits of
911     database-type-specific SQL in the code). Defaults to mysql.
912 mirror: you can set this to an array of DSNs, like the above
913     'database' value. If it's set, certain read-only actions will
914     use a random value out of this array for the database, rather
915     than the one in 'database' (actually, 'database' is overwritten).
916     You can offload a busy DB server by setting up MySQL replication
917     and adding the slaves to this array. Note that if you want some
918     requests to go to the 'database' (master) server, you'll need
919     to include it in this array, too.
920 utf8: whether to talk to the database in UTF-8 mode. This is the default
921     with new installations, but older sites may want to turn it off
922     until they get their databases fixed up. See "UTF-8 database"
923     above for details.
924 schemacheck: when to let plugins check the database schema to add
925     tables or update them. Values can be 'runtime' (default)
926     or 'script'. 'runtime' can be costly (plugins check the
927     schema on every hit, adding potentially several db
928     queries, some quite long), but not everyone knows how to
929     run a script. If you can, set this to 'script' and run
930     scripts/checkschema.php whenever you install or upgrade a
931     plugin.
932
933 syslog
934 ------
935
936 By default, StatusNet sites log error messages to the syslog facility.
937 (You can override this using the 'logfile' parameter described above).
938
939 appname: The name that StatusNet uses to log messages. By default it's
940     "statusnet", but if you have more than one installation on the
941     server, you may want to change the name for each instance so
942     you can track log messages more easily.
943 priority: level to log at. Currently ignored.
944 facility: what syslog facility to used. Defaults to LOG_USER, only
945     reset if you know what syslog is and have a good reason
946     to change it.
947
948 queue
949 -----
950
951 You can configure the software to queue time-consuming tasks, like
952 sending out SMS email or XMPP messages, for off-line processing. See
953 'Queues and daemons' above for how to set this up.
954
955 enabled: Whether to uses queues. Defaults to false.
956 subsystem: Which kind of queueserver to use. Values include "db" for
957     our hacked-together database queuing (no other server
958     required) and "stomp" for a stomp server.
959 stomp_server: "broker URI" for stomp server. Something like
960     "tcp://hostname:61613". More complicated ones are
961     possible; see your stomp server's documentation for
962     details.
963 queue_basename: a root name to use for queues (stomp only). Typically
964     something like '/queue/sitename/' makes sense. If running
965     multiple instances on the same server, make sure that
966     either this setting or $config['site']['nickname'] are
967     unique for each site to keep them separate.
968
969 stomp_username: username for connecting to the stomp server; defaults
970     to null.
971 stomp_password: password for connecting to the stomp server; defaults
972     to null.
973
974 stomp_persistent: keep items across queue server restart, if enabled.
975     Under ActiveMQ, the server configuration determines if and how
976     persistent storage is actually saved.
977
978     If using a message queue server other than ActiveMQ, you may
979     need to disable this if it does not support persistence.
980
981 stomp_transactions: use transactions to aid in error detection.
982     A broken transaction will be seen quickly, allowing a message
983     to be redelivered immediately if a daemon crashes.
984
985     If using a message queue server other than ActiveMQ, you may
986     need to disable this if it does not support transactions.
987
988 stomp_acks: send acknowledgements to aid in flow control.
989     An acknowledgement of successful processing tells the server
990     we're ready for more and can help keep things moving smoothly.
991
992     This should *not* be turned off when running with ActiveMQ, but
993     if using another message queue server that does not support
994     acknowledgements you might need to disable this.
995
996 softlimit: an absolute or relative "soft memory limit"; daemons will
997     restart themselves gracefully when they find they've hit
998     this amount of memory usage. Defaults to 90% of PHP's global
999     memory_limit setting.
1000
1001 inboxes: delivery of messages to receiver's inboxes can be delayed to
1002     queue time for best interactive performance on the sender.
1003     This may however be annoyingly slow when using the DB queues,
1004     so you can set this to false if it's causing trouble.
1005
1006 breakout: for stomp, individual queues are by default grouped up for
1007     best scalability. If some need to be run by separate daemons,
1008     etc they can be manually adjusted here.
1009
1010         Default will share all queues for all sites within each group.
1011         Specify as <group>/<queue> or <group>/<queue>/<site>,
1012         using nickname identifier as site.
1013
1014         'main/distrib' separate "distrib" queue covering all sites
1015         'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
1016
1017 max_retries: for stomp, drop messages after N failed attempts to process.
1018     Defaults to 10.
1019
1020 dead_letter_dir: for stomp, optional directory to dump data on failed
1021     queue processing events after discarding them.
1022
1023 stomp_no_transactions: for stomp, the server does not support transactions,
1024     so do not try to user them. This is needed for http://www.morbidq.com/.
1025
1026 stomp_no_acks: for stomp, the server does not support acknowledgements.
1027     so do not try to user them. This is needed for http://www.morbidq.com/.
1028
1029 license
1030 -------
1031
1032 The default license to use for your users notices. The default is the
1033 Creative Commons Attribution 3.0 license, which is probably the right
1034 choice for any public site. Note that some other servers will not
1035 accept notices if you apply a stricter license than this.
1036
1037 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1038     (default copyright), or 'private' (for private and confidential
1039     information).
1040 owner: for 'allrightsreserved' or 'private', an assigned copyright
1041     holder (for example, an employer for a private site). If
1042     not specified, will be attributed to 'contributors'.
1043 url: URL of the license, used for links.
1044 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1045 image: A button shown on each page for the license.
1046
1047 mail
1048 ----
1049
1050 This is for configuring out-going email. We use PEAR's Mail module,
1051 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1052
1053 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1054     'smtp'. Defaults to PEAR's default, 'mail'.
1055 params: if the mail backend requires any parameters, you can provide
1056     them in an associative array.
1057
1058 nickname
1059 --------
1060
1061 This is for configuring nicknames in the service.
1062
1063 blacklist: an array of strings for usernames that may not be
1064     registered. A default array exists for strings that are
1065     used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1066     but you may want to add others if you have other software
1067     installed in a subdirectory of StatusNet or if you just
1068     don't want certain words used as usernames.
1069 featured: an array of nicknames of 'featured' users of the site.
1070     Can be useful to draw attention to well-known users, or
1071     interesting people, or whatever.
1072
1073 avatar
1074 ------
1075
1076 For configuring avatar access.
1077
1078 dir: Directory to look for avatar files and to put them into.
1079     Defaults to avatar subdirectory of install directory; if
1080     you change it, make sure to change path, too.
1081 path: Path to avatars. Defaults to path for avatar subdirectory,
1082     but you can change it if you wish. Note that this will
1083     be included with the avatar server, too.
1084 server: If set, defines another server where avatars are stored in the
1085     root directory. Note that the 'avatar' subdir still has to be
1086     writeable. You'd typically use this to split HTTP requests on
1087     the client to speed up page loading, either with another
1088     virtual server or with an NFS or SAMBA share. Clients
1089     typically only make 2 connections to a single server at a
1090     time <http://ur1.ca/6ih>, so this can parallelize the job.
1091     Defaults to null.
1092 ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
1093     to guess based on site-wide SSL settings.
1094
1095 public
1096 ------
1097
1098 For configuring the public stream.
1099
1100 localonly: If set to true, only messages posted by users of this
1101     service (rather than other services, filtered through OMB)
1102     are shown in the public stream. Default true.
1103 blacklist: An array of IDs of users to hide from the public stream.
1104     Useful if you have someone making excessive Twitterfeed posts
1105     to the site, other kinds of automated posts, testing bots, etc.
1106 autosource: Sources of notices that are from automatic posters, and thus
1107     should be kept off the public timeline. Default empty.
1108
1109 theme
1110 -----
1111
1112 server: Like avatars, you can speed up page loading by pointing the
1113     theme file lookup to another server (virtual or real).
1114     Defaults to NULL, meaning to use the site server.
1115 dir: Directory where theme files are stored. Used to determine
1116     whether to show parts of a theme file. Defaults to the theme
1117     subdirectory of the install directory.
1118 path: Path part of theme URLs, before the theme name. Relative to the
1119     theme server. It may make sense to change this path when upgrading,
1120     (using version numbers as the path) to make sure that all files are
1121     reloaded by caching clients or proxies. Defaults to null,
1122     which means to use the site path + '/theme'.
1123 ssl: Whether to use SSL for theme elements. Default is null, which means
1124     guess based on site SSL settings.
1125 sslserver: SSL server to use when page is HTTPS-encrypted. If
1126     unspecified, site ssl server and so on will be used.
1127 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1128
1129 javascript
1130 ----------
1131
1132 server: You can speed up page loading by pointing the
1133     theme file lookup to another server (virtual or real).
1134     Defaults to NULL, meaning to use the site server.
1135 path: Path part of Javascript URLs. Defaults to null,
1136     which means to use the site path + '/js/'.
1137 ssl: Whether to use SSL for JavaScript files. Default is null, which means
1138     guess based on site SSL settings.
1139 sslserver: SSL server to use when page is HTTPS-encrypted. If
1140     unspecified, site ssl server and so on will be used.
1141 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1142
1143 xmpp
1144 ----
1145
1146 For configuring the XMPP sub-system.
1147
1148 enabled: Whether to accept and send messages by XMPP. Default false.
1149 server: server part of XMPP ID for update user.
1150 port: connection port for clients. Default 5222, which you probably
1151     shouldn't need to change.
1152 user: username for the client connection. Users will receive messages
1153     from 'user'@'server'.
1154 resource: a unique identifier for the connection to the server. This
1155     is actually used as a prefix for each XMPP component in the system.
1156 password: password for the user account.
1157 host: some XMPP domains are served by machines with a different
1158     hostname. (For example, @gmail.com GTalk users connect to
1159     talk.google.com). Set this to the correct hostname if that's the
1160     case with your server.
1161 encryption: Whether to encrypt the connection between StatusNet and the
1162     XMPP server. Defaults to true, but you can get
1163     considerably better performance turning it off if you're
1164     connecting to a server on the same machine or on a
1165     protected network.
1166 debug: if turned on, this will make the XMPP library blurt out all of
1167     the incoming and outgoing messages as XML stanzas. Use as a
1168     last resort, and never turn it on if you don't have queues
1169     enabled, since it will spit out sensitive data to the browser.
1170 public: an array of JIDs to send _all_ notices to. This is useful for
1171     participating in third-party search and archiving services.
1172
1173 invite
1174 ------
1175
1176 For configuring invites.
1177
1178 enabled: Whether to allow users to send invites. Default true.
1179
1180 tag
1181 ---
1182
1183 Miscellaneous tagging stuff.
1184
1185 dropoff: Decay factor for tag listing, in seconds.
1186     Defaults to exponential decay over ten days; you can twiddle
1187     with it to try and get better results for your site.
1188
1189 popular
1190 -------
1191
1192 Settings for the "popular" section of the site.
1193
1194 dropoff: Decay factor for popularity listing, in seconds.
1195     Defaults to exponential decay over ten days; you can twiddle
1196     with it to try and get better results for your site.
1197
1198 daemon
1199 ------
1200
1201 For daemon processes.
1202
1203 piddir: directory that daemon processes should write their PID file
1204     (process ID) to. Defaults to /var/run/, which is where this
1205     stuff should usually go on Unix-ish systems.
1206 user: If set, the daemons will try to change their effective user ID
1207     to this user before running. Probably a good idea, especially if
1208     you start the daemons as root. Note: user name, like 'daemon',
1209     not 1001.
1210 group: If set, the daemons will try to change their effective group ID
1211     to this named group. Again, a name, not a numerical ID.
1212
1213 memcached
1214 ---------
1215
1216 You can get a significant boost in performance by caching some
1217 database data in memcached <http://www.danga.com/memcached/>.
1218
1219 enabled: Set to true to enable. Default false.
1220 server: a string with the hostname of the memcached server. Can also
1221     be an array of hostnames, if you've got more than one server.
1222 base: memcached uses key-value pairs to store data. We build long,
1223     funny-looking keys to make sure we don't have any conflicts. The
1224     base of the key is usually a simplified version of the site name
1225     (like "Identi.ca" => "identica"), but you can overwrite this if
1226     you need to. You can safely ignore it if you only have one
1227     StatusNet site using your memcached server.
1228 port: Port to connect to; defaults to 11211.
1229
1230 emailpost
1231 ---------
1232
1233 For post-by-email.
1234
1235 enabled: Whether to enable post-by-email. Defaults to true. You will
1236     also need to set up maildaemon.php.
1237
1238 sms
1239 ---
1240
1241 For SMS integration.
1242
1243 enabled: Whether to enable SMS integration. Defaults to true. Queues
1244     should also be enabled.
1245
1246 integration
1247 -----------
1248
1249 A catch-all for integration with other systems.
1250
1251 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1252
1253 inboxes
1254 -------
1255
1256 For notice inboxes.
1257
1258 enabled: No longer used. If you set this to something other than true,
1259     StatusNet will no longer run.
1260
1261 throttle
1262 --------
1263
1264 For notice-posting throttles.
1265
1266 enabled: Whether to throttle posting. Defaults to false.
1267 count: Each user can make this many posts in 'timespan' seconds. So, if count
1268     is 100 and timespan is 3600, then there can be only 100 posts
1269     from a user every hour.
1270 timespan: see 'count'.
1271
1272 profile
1273 -------
1274
1275 Profile management.
1276
1277 biolimit: max character length of bio; 0 means no limit; null means to use
1278     the site text limit default.
1279 backup: whether users can backup their own profiles. Defaults to true.
1280 restore: whether users can restore their profiles from backup files. Defaults
1281          to true.
1282 delete: whether users can delete their own accounts. Defaults to true.
1283 move: whether users can move their accounts to another server. Defaults
1284       to true.   
1285
1286 newuser
1287 -------
1288
1289 Options with new users.
1290
1291 default: nickname of a user account to automatically subscribe new
1292     users to. Typically this would be system account for e.g.
1293     service updates or announcements. Users are able to unsub
1294     if they want. Default is null; no auto subscribe.
1295 welcome: nickname of a user account that sends welcome messages to new
1296     users. Can be the same as 'default' account, although on
1297     busy servers it may be a good idea to keep that one just for
1298     'urgent' messages. Default is null; no message.
1299
1300 If either of these special user accounts are specified, the users should
1301 be created before the configuration is updated.
1302
1303 snapshot
1304 --------
1305
1306 The software will, by default, send statistical snapshots about the
1307 local installation to a stats server on the status.net Web site. This
1308 data is used by the developers to prioritize development decisions. No
1309 identifying data about users or organizations is collected. The data
1310 is available to the public for review. Participating in this survey
1311 helps StatusNet developers take your needs into account when updating
1312 the software.
1313
1314 run: string indicating when to run the statistics. Values can be 'web'
1315     (run occasionally at Web time), 'cron' (run from a cron script),
1316     or 'never' (don't ever run). If you set it to 'cron', remember to
1317     schedule the script to run on a regular basis.
1318 frequency: if run value is 'web', how often to report statistics.
1319     Measured in Web hits; depends on how active your site is.
1320     Default is 10000 -- that is, one report every 10000 Web hits,
1321     on average.
1322 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1323     report system, but if they go evil or disappear you may
1324     need to update this to another value. Note: if you
1325     don't want to report stats, it's much better to
1326     set 'run' to 'never' than to set this value to something
1327     nonsensical.
1328
1329 attachments
1330 -----------
1331
1332 The software lets users upload files with their notices. You can configure
1333 the types of accepted files by mime types and a trio of quota options:
1334 per file, per user (total), per user per month.
1335
1336 We suggest the use of the pecl file_info extension to handle mime type
1337 detection.
1338
1339 supported: an array of mime types you accept to store and distribute,
1340     like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1341     setup your server to properly recognize the types you want to
1342     support.
1343 uploads: false to disable uploading files with notices (true by default).
1344 filecommand: The required MIME_Type library may need to use the 'file'
1345     command. It tries the one in the Web server's path, but if
1346     you're having problems with uploads, try setting this to the
1347     correct value. Note: 'file' must accept '-b' and '-i' options.
1348
1349 For quotas, be sure you've set the upload_max_filesize and post_max_size
1350 in php.ini to be large enough to handle your upload. In httpd.conf
1351 (if you're using apache), check that the LimitRequestBody directive isn't
1352 set too low (it's optional, so it may not be there at all).
1353
1354 file_quota: maximum size for a single file upload in bytes. A user can send
1355     any amount of notices with attachments as long as each attachment
1356     is smaller than file_quota.
1357 user_quota: total size in bytes a user can store on this server. Each user
1358     can store any number of files as long as their total size does
1359     not exceed the user_quota.
1360 monthly_quota: total size permitted in the current month. This is the total
1361     size in bytes that a user can upload each month.
1362 dir: directory accessible to the Web process where uploads should go.
1363     Defaults to the 'file' subdirectory of the install directory, which
1364     should be writeable by the Web user.
1365 server: server name to use when creating URLs for uploaded files.
1366     Defaults to null, meaning to use the default Web server. Using
1367     a virtual server here can speed up Web performance.
1368 path: URL path, relative to the server, to find files. Defaults to
1369     main path + '/file/'.
1370 ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
1371     guess based on other SSL settings.
1372 filecommand: command to use for determining the type of a file. May be
1373     skipped if fileinfo extension is installed. Defaults to
1374     '/usr/bin/file'.
1375 sslserver: if specified, this server will be used when creating HTTPS
1376     URLs. Otherwise, the site SSL server will be used, with /file/ path.
1377 sslpath: if this and the sslserver are specified, this path will be used
1378     when creating HTTPS URLs. Otherwise, the attachments|path value
1379     will be used.
1380
1381 group
1382 -----
1383
1384 Options for group functionality.
1385
1386 maxaliases: maximum number of aliases a group can have. Default 3. Set
1387     to 0 or less to prevent aliases in a group.
1388 desclimit: maximum number of characters to allow in group descriptions.
1389     null (default) means to use the site-wide text limits. 0
1390     means no limit.
1391
1392 oohembed
1393 --------
1394
1395 oEmbed endpoint for multimedia attachments (links in posts).
1396
1397 endpoint: oohembed endpoint using http://oohembed.com/ software.
1398
1399 search
1400 ------
1401
1402 Some stuff for search.
1403
1404 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1405     be 'fulltext' (default) or 'like'. The former is faster and more efficient
1406     but requires the lame old MyISAM engine for MySQL. The latter
1407     will work with InnoDB but could be miserably slow on large
1408     systems. We'll probably add another type sometime in the future,
1409     with our own indexing system (maybe like MediaWiki's).
1410
1411 sessions
1412 --------
1413
1414 Session handling.
1415
1416 handle: boolean. Whether we should register our own PHP session-handling
1417     code (using the database and memcache if enabled). Defaults to false.
1418     Setting this to true makes some sense on large or multi-server
1419     sites, but it probably won't hurt for smaller ones, either.
1420 debug: whether to output debugging info for session storage. Can help
1421     with weird session bugs, sometimes. Default false.
1422
1423 background
1424 ----------
1425
1426 Users can upload backgrounds for their pages; this section defines
1427 their use.
1428
1429 server: the server to use for background. Using a separate (even
1430     virtual) server for this can speed up load times. Default is
1431     null; same as site server.
1432 dir: directory to write backgrounds too. Default is '/background/'
1433     subdir of install dir.
1434 path: path to backgrounds. Default is sub-path of install path; note
1435     that you may need to change this if you change site-path too.
1436 sslserver: SSL server to use when page is HTTPS-encrypted. If
1437     unspecified, site ssl server and so on will be used.
1438 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1439
1440 ping
1441 ----
1442
1443 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1444 notify third-party servers of updates.
1445
1446 notify: an array of URLs for ping endpoints. Default is the empty
1447     array (no notification).
1448
1449 design
1450 ------
1451
1452 Default design (colors and background) for the site. Actual appearance
1453 depends on the theme.  Null values mean to use the theme defaults.
1454
1455 backgroundcolor: Hex color of the site background.
1456 contentcolor: Hex color of the content area background.
1457 sidebarcolor: Hex color of the sidebar background.
1458 textcolor: Hex color of all non-link text.
1459 linkcolor: Hex color of all links.
1460 backgroundimage: Image to use for the background.
1461 disposition: Flags for whether or not to tile the background image.
1462
1463 notice
1464 ------
1465
1466 Configuration options specific to notices.
1467
1468 contentlimit: max length of the plain-text content of a notice.
1469     Default is null, meaning to use the site-wide text limit.
1470     0 means no limit.
1471
1472 message
1473 -------
1474
1475 Configuration options specific to messages.
1476
1477 contentlimit: max length of the plain-text content of a message.
1478     Default is null, meaning to use the site-wide text limit.
1479     0 means no limit.
1480
1481 logincommand
1482 ------------
1483
1484 Configuration options for the login command.
1485
1486 disabled: whether to enable this command. If enabled, users who send
1487     the text 'login' to the site through any channel will
1488     receive a link to login to the site automatically in return.
1489     Possibly useful for users who primarily use an XMPP or SMS
1490     interface and can't be bothered to remember their site
1491     password. Note that the security implications of this are
1492     pretty serious and have not been thoroughly tested. You
1493     should enable it only after you've convinced yourself that
1494     it is safe. Default is 'false'.
1495
1496 singleuser
1497 ----------
1498
1499 If an installation has only one user, this can simplify a lot of the
1500 interface. It also makes the user's profile the root URL.
1501
1502 enabled: Whether to run in "single user mode". Default false.
1503 nickname: nickname of the single user. If no nickname is specified,
1504           the site owner account will be used (if present).
1505
1506 robotstxt
1507 ---------
1508
1509 We put out a default robots.txt file to guide the processing of
1510 Web crawlers. See http://www.robotstxt.org/ for more information
1511 on the format of this file.
1512
1513 crawldelay: if non-empty, this value is provided as the Crawl-Delay:
1514     for the robots.txt file. see http://ur1.ca/l5a0
1515     for more information. Default is zero, no explicit delay.
1516 disallow: Array of (virtual) directories to disallow. Default is 'main',
1517     'search', 'message', 'settings', 'admin'. Ignored when site
1518     is private, in which case the entire site ('/') is disallowed.
1519
1520 api
1521 ---
1522
1523 Options for the Twitter-like API.
1524
1525 realm: HTTP Basic Auth realm (see http://tools.ietf.org/html/rfc2617
1526     for details). Some third-party tools like ping.fm want this to be
1527     'Identi.ca API', so set it to that if you want to. default = null,
1528     meaning 'something based on the site name'.
1529
1530 nofollow
1531 --------
1532
1533 We optionally put 'rel="nofollow"' on some links in some pages. The
1534 following configuration settings let you fine-tune how or when things
1535 are nofollowed. See http://en.wikipedia.org/wiki/Nofollow for more
1536 information on what 'nofollow' means.
1537
1538 subscribers: whether to nofollow links to subscribers on the profile
1539     and personal pages. Default is true.
1540 members: links to members on the group page. Default true.
1541 peopletag: links to people listed in the peopletag page. Default true.
1542 external: external links in notices. One of three values: 'sometimes',
1543     'always', 'never'. If 'sometimes', then external links are not
1544     nofollowed on profile, notice, and favorites page. Default is
1545     'sometimes'.
1546
1547 router
1548 ------
1549
1550 We use a router class for mapping URLs to code. This section controls
1551 how that router works.
1552
1553 cache: whether to cache the router in memcache (or another caching
1554     mechanism). Defaults to true, but may be set to false for
1555     developers (who might be actively adding pages, so won't want the
1556     router cached) or others who see strange behavior. You're unlikely
1557     to need this unless you're a developer.
1558
1559 http
1560 ----
1561
1562 Settings for the HTTP client.
1563
1564 ssl_cafile: location of the CA file for SSL. If not set, won't verify
1565             SSL peers. Default unset.
1566 curl: Use cURL <http://curl.haxx.se/> for doing HTTP calls. You must
1567       have the PHP curl extension installed for this to work.
1568 proxy_host: Host to use for proxying HTTP requests. If unset, doesn't
1569             do any HTTP proxy stuff. Default unset.
1570 proxy_port: Port to use to connect to HTTP proxy host. Default null.
1571 proxy_user: Username to use for authenticating to the HTTP proxy. Default null.
1572 proxy_password: Password to use for authenticating to the HTTP proxy. Default null.
1573 proxy_auth_scheme: Scheme to use for authenticating to the HTTP proxy. Default null.
1574
1575 Plugins
1576 =======
1577
1578 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1579 powerful plugin architecture. Important events in the code are named,
1580 like 'StartNoticeSave', and other software can register interest
1581 in those events. When the events happen, the other software is called
1582 and has a choice of accepting or rejecting the events.
1583
1584 In the simplest case, you can add a function to config.php and use the
1585 Event::addHandler() function to hook an event:
1586
1587     function AddGoogleLink($action)
1588     {
1589         $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1590         return true;
1591     }
1592
1593     Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1594
1595 This adds a menu item to the end of the main navigation menu. You can
1596 see the list of existing events, and parameters that handlers must
1597 implement, in EVENTS.txt.
1598
1599 The Plugin class in lib/plugin.php makes it easier to write more
1600 complex plugins. Sub-classes can just create methods named
1601 'onEventName', where 'EventName' is the name of the event (case
1602 matters!). These methods will be automatically registered as event
1603 handlers by the Plugin constructor (which you must call from your own
1604 class's constructor).
1605
1606 Several example plugins are included in the plugins/ directory. You
1607 can enable a plugin with the following line in config.php:
1608
1609     addPlugin('Example', array('param1' => 'value1',
1610                                'param2' => 'value2'));
1611
1612 This will look for and load files named 'ExamplePlugin.php' or
1613 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1614 plugins that ship with StatusNet) or in the local/ directory (for
1615 plugins you write yourself or that you get from somewhere else) or
1616 local/plugins/.
1617
1618 Plugins are documented in their own directories.
1619
1620 Troubleshooting
1621 ===============
1622
1623 The primary output for StatusNet is syslog, unless you configured a
1624 separate logfile. This is probably the first place to look if you're
1625 getting weird behaviour from StatusNet.
1626
1627 If you're tracking the unstable version of StatusNet in the git
1628 repository (see below), and you get a compilation error ("unexpected
1629 T_STRING") in the browser, check to see that you don't have any
1630 conflicts in your code.
1631
1632 If you upgraded to StatusNet 0.9.x without reading the "Notice
1633 inboxes" section above, and all your users' 'Personal' tabs are empty,
1634 read the "Notice inboxes" section above.
1635
1636 Myths
1637 =====
1638
1639 These are some myths you may see on the Web about StatusNet.
1640 Documentation from the core team about StatusNet has been pretty
1641 sparse, so some backtracking and guesswork resulted in some incorrect
1642 assumptions.
1643
1644 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1645   extremely bad idea. It's a tool built into DB_DataObject that will
1646   emit oodles of print lines directly to the browser of your users.
1647   Among these lines will be your database username and password. Do
1648   not enable this option on a production Web site for any reason.
1649
1650 - "Edit dataobject.ini with the following settings..." dataobject.ini
1651   is a development file for the DB_DataObject framework and is not
1652   used by the running software. It was removed from the StatusNet
1653   distribution because its presence was confusing. Do not bother
1654   configuring dataobject.ini, and do not put your database username
1655   and password into the file on a production Web server; unscrupulous
1656   persons may try to read it to get your passwords.
1657
1658 Unstable version
1659 ================
1660
1661 If you're adventurous or impatient, you may want to install the
1662 development version of StatusNet. To get it, use the git version
1663 control tool <http://git-scm.com/> like so:
1664
1665     git clone git@gitorious.org:statusnet/mainline.git
1666
1667 This is the version of the software that runs on Identi.ca and the
1668 status.net hosted service. Using it is a mixed bag. On the positive
1669 side, it usually includes the latest security and bug fix patches. On
1670 the downside, it may also include changes that require admin
1671 intervention (like running a script or even raw SQL!) that may not be
1672 documented yet. It may be a good idea to test this version before
1673 installing it on your production machines.
1674
1675 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1676
1677 Further information
1678 ===================
1679
1680 There are several ways to get more information about StatusNet.
1681
1682 * There is a mailing list for StatusNet developers and admins at
1683   http://mail.status.net/mailman/listinfo/statusnet-dev
1684 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1685 * The StatusNet wiki, http://status.net/wiki/
1686 * The StatusNet blog, http://status.net/blog/
1687 * The StatusNet status update, <http://status.status.net/> (!)
1688
1689 Feedback
1690 ========
1691
1692 * Microblogging messages to http://support.status.net/ are very welcome.
1693 * The microblogging group http://identi.ca/group/statusnet is a good
1694   place to discuss the software.
1695 * StatusNet has a bug tracker for any defects you may find, or ideas for
1696   making things better. http://status.net/bugs
1697
1698 Credits
1699 =======
1700
1701 The following is an incomplete list of developers who've worked on
1702 StatusNet. Apologies for any oversight; please let evan@status.net know
1703 if anyone's been overlooked in error.
1704
1705 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1706 * Zach Copley, StatusNet, Inc.
1707 * Earle Martin, StatusNet, Inc.
1708 * Marie-Claude Doyon, designer, StatusNet, Inc.
1709 * Sarven Capadisli, StatusNet, Inc.
1710 * Robin Millette, StatusNet, Inc.
1711 * Ciaran Gultnieks
1712 * Michael Landers
1713 * Ori Avtalion
1714 * Garret Buell
1715 * Mike Cochrane
1716 * Matthew Gregg
1717 * Florian Biree
1718 * Erik Stambaugh
1719 * 'drry'
1720 * Gina Haeussge
1721 * Tryggvi Björgvinsson
1722 * Adrian Lang
1723 * Ori Avtalion
1724 * Meitar Moscovitz
1725 * Ken Sheppardson (Trac server, man-about-town)
1726 * Tiago 'gouki' Faria (i18n manager)
1727 * Sean Murphy
1728 * Leslie Michael Orchard
1729 * Eric Helgeson
1730 * Ken Sedgwick
1731 * Brian Hendrickson
1732 * Tobias Diekershoff
1733 * Dan Moore
1734 * Fil
1735 * Jeff Mitchell
1736 * Brenda Wallace
1737 * Jeffery To
1738 * Federico Marani
1739 * Craig Andrews
1740 * mEDI
1741 * Brett Taylor
1742 * Brigitte Schuster
1743 * Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
1744 * Brion Vibber, StatusNet, Inc.
1745 * James Walker, StatusNet, Inc.
1746 * Samantha Doherty, designer, StatusNet, Inc.
1747
1748 Thanks also to the developers of our upstream library code and to the
1749 thousands of people who have tried out Identi.ca, installed StatusNet,
1750 told their friends, and built the Open Microblogging network to what
1751 it is today.