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