]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - README
Merge branch 'candrews-review' into 0.8.x
[quix0rs-gnu-social.git] / README
1 ------
2 README
3 ------
4
5 Laconica 0.8.0 ("Shiny Happy People")
6 8 July 2009
7
8 This is the README file for Laconica, 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 Laconica can be found in the
12 "doc" subdirectory or in the "help" section on-line.
13
14 About
15 =====
16
17 Laconica (pronounced "luh-KAWN-ih-kuh") is a Free and Open Source
18 microblogging platform. It helps people in a community, company or
19 group to exchange short (140 character) messages over the Web. Users
20 can choose which people to "follow" and receive only their friends' or
21 colleagues' status messages. It provides a similar service to sites
22 like Twitter, Jaiku and Plurk.
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 Laconica supports an open standard called OpenMicroBlogging
29 <http://openmicroblogging.org/> that lets users on different Web sites
30 or in different companies subscribe to each others' notices. It
31 enables a distributed social network spread all across the Web.
32
33 Laconica 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 License
41 =======
42
43 This program is free software: you can redistribute it and/or modify
44 it under the terms of the GNU Affero General Public License as
45 published by the Free Software Foundation, either version 3 of the
46 License, or (at your option) any later version.
47
48 This program is distributed in the hope that it will be useful, but
49 WITHOUT ANY WARRANTY; without even the implied warranty of
50 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
51 Affero General Public License for more details.
52
53 You should have received a copy of the GNU Affero General Public
54 License along with this program, in the file "COPYING".  If not, see
55 <http://www.gnu.org/licenses/>.
56
57     IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
58     *different requirements* from the "regular" GPL. In particular, if
59     you make modifications to the Laconica source code on your server,
60     you *MUST MAKE AVAILABLE* the modified version of the source code
61     to your users under the same license. This is a legal requirement
62     of using the software, and if you do not wish to share your
63     modifications, *YOU MAY NOT INSTALL LACONICA*.
64
65 Additional library software has been made available in the 'extlib'
66 directory. All of it is Free Software and can be distributed under
67 liberal terms, but those terms may differ in detail from the AGPL's
68 particulars. See each package's license file in the extlib directory
69 for additional terms.
70
71 New this version
72 ================
73
74 This is a major feature release since version 0.7.4, released May 31
75 2009. Notable changes this version:
76
77 - Support for a hosted service (status network). Multiple sites can
78   share the same codebase but use different databases.
79 - OEmbed. Links to pages that support OEmbed (http://www.oembed.com/)
80   become popup links, and the media are shown in a special lightbox.
81 - File attachments. Users can attach files of the size and type approved
82   by an administrator, and a shortened link will be included in the
83   notice.
84 - Related notices are organized into conversations, with each reply a
85   branch in a tree. Conversations have pages and are linked to from each
86   notice in the conversation.
87 - User designs. Users can specify colours and backgrounds
88   for their profile pages and other "personal" pages.
89 - Group designs. Group administrators can specify similar designs for
90   group profiles and related pages.
91 - Site designs. Site authors can specify a design (background and
92   colors) for the site.
93 - New themes. Five new themes are added to the base release; these show
94   off the flexibility of Laconica's theming system.
95 - Statistics. Public sites will periodically send usage statistics,
96   configuration options, and dependency information to Laconica dev site.
97   This will help us understand how the software is used and plan future
98   versions of the software.
99 - Additional hooks. The hooks and plugins system introduced in 0.7.x was
100   expanded with additional points of access.
101 - Facebook Connect. A new plugin allows logging in with Facebook Connect
102   (http://developers.facebook.com/connect.php).
103 - A session handler. A new optional session handler class to manage PHP
104   sessions reliably and quickly for large sites.
105 - STOMP queuing. Queue management for offline daemons has been
106   abstracted with three concrete instances. A new interface that should
107   work with STOMP servers like ActiveMQ and RabbitMQ is available, which
108   should make things scale better.
109 - Group block. Group admins can block users from joining or posting to
110   a group.
111 - Group aliases. Groups can be referred to with aliases, additional
112   names. For example, "!yul" and "!montreal" can be the same group.
113 - Bidirectional Twitter bridge. Users can read the tweets their Twitter
114   friends post on Twitter.
115 - Adaptation of WordPress.com Terms of Service (http://en.wordpress.com/tos/)
116   as default TOS for Laconica sites.
117 - Better command-line handling for scripts, including standard options
118   and ability to set hostname and path from the command line.
119 - Many, many bug fixes.
120
121 Prerequisites
122 =============
123
124 The following software packages are *required* for this software to
125 run correctly.
126
127 - PHP 5.2.x. It may be possible to run this software on earlier
128   versions of PHP, but many of the functions used are only available
129   in PHP 5.2 or above.
130 - MySQL 5.x. The Laconica database is stored, by default, in a MySQL
131   server. It has been primarily tested on 5.x servers, although it may
132   be possible to install on earlier (or later!) versions. The server
133   *must* support the MyISAM storage engine -- the default for most
134   MySQL servers -- *and* the InnoDB storage engine.
135 - A Web server. Preferably, you should have Apache 2.2.x with the
136   mod_rewrite extension installed and enabled.
137
138 Your PHP installation must include the following PHP extensions:
139
140 - Curl. This is for fetching files by HTTP.
141 - XMLWriter. This is for formatting XML and HTML output.
142 - MySQL. For accessing the database.
143 - GD. For scaling down avatar images.
144 - mbstring. For handling Unicode (UTF-8) encoded strings.
145 - gettext. For multiple languages. Default on many PHP installs.
146
147 For some functionality, you will also need the following extensions:
148
149 - Memcache. A client for the memcached server, which caches database
150   information in volatile memory. This is important for adequate
151   performance on high-traffic sites. You will also need a memcached
152   server to store the data in.
153 - Mailparse. Efficient parsing of email requires this extension.
154   Submission by email or SMS-over-email uses this extension.
155 - Sphinx Search. A client for the sphinx server, an alternative
156   to MySQL or Postgresql fulltext search. You will also need a
157   Sphinx server to serve the search queries.
158
159 You will almost definitely get 2-3 times better performance from your
160 site if you install a PHP bytecode cache/accelerator. Some well-known
161 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
162 is a proprietary accelerator installed on some hosting sites.
163
164 External libraries
165 ------------------
166
167 A number of external PHP libraries are used to provide basic
168 functionality and optional functionality for your system. For your
169 convenience, they are available in the "extlib" directory of this
170 package, and you do not have to download and install them. However,
171 you may want to keep them up-to-date with the latest upstream version,
172 and the URLs are listed here for your convenience.
173
174 - DB_DataObject http://pear.php.net/package/DB_DataObject
175 - Validate http://pear.php.net/package/Validate
176 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
177   to use the openidenabled.com version since it's more widely
178   implemented, and seems to be better supported.
179   http://openidenabled.com/php-openid/
180 - PEAR DB. Although this is an older data access system (new
181   packages should probably use PHP DBO), the OpenID libraries
182   depend on PEAR DB so we use it here, too. DB_DataObject can
183   also use PEAR MDB2, which may give you better performance
184   but won't work with OpenID.
185   http://pear.php.net/package/DB
186 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
187 - markdown.php from http://michelf.com/projects/php-markdown/
188 - PEAR Mail, for sending out mail notifications
189   http://pear.php.net/package/Mail
190 - PEAR Net_SMTP, if you use the SMTP factory for notifications
191   http://pear.php.net/package/Net_SMTP
192 - PEAR Net_Socket, if you use the SMTP factory for notifications
193   http://pear.php.net/package/Net_Socket
194 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
195   library available for PHP. http://xmpphp.googlecode.com/. Note that
196   as of this writing the version of this library that is available in
197   the extlib directory is *significantly different* from the upstream
198   version (patches have been submitted). Upgrading to the upstream
199   version may render your Laconica site unable to send or receive XMPP
200   messages.
201 - Facebook library. Used for the Facebook application.
202 - PEAR Services_oEmbed. Used for some multimedia integration.
203 - PEAR HTTP_Request is an oEmbed dependency.
204 - PEAR Validate is an oEmbed dependency.
205 - PEAR Net_URL2 is an oEmbed dependency.
206 - Console_GetOpt for parsing command-line options.
207
208 A design goal of Laconica is that the basic Web functionality should
209 work on even the most restrictive commercial hosting services.
210 However, additional functionality, such as receiving messages by
211 Jabber/GTalk, require that you be able to run long-running processes
212 on your account. In addition, posting by email or from SMS require
213 that you be able to install a mail filter in your mail server.
214
215 Installation
216 ============
217
218 Installing the basic Laconica Web component is relatively easy,
219 especially if you've previously installed PHP/MySQL packages.
220
221 1. Unpack the tarball you downloaded on your Web server. Usually a
222    command like this will work:
223
224            tar zxf laconica-0.8.0.tar.gz
225
226    ...which will make a laconica-0.8.0 subdirectory in your current
227    directory. (If you don't have shell access on your Web server, you
228    may have to unpack the tarball on your local computer and FTP the
229    files to the server.)
230
231 2. Move the tarball to a directory of your choosing in your Web root
232    directory. Usually something like this will work:
233
234            mv laconica-0.8.0 /var/www/mublog
235
236    This will make your Laconica instance available in the mublog path of
237    your server, like "http://example.net/mublog". "microblog" or
238    "laconica" might also be good path names. If you know how to
239    configure virtual hosts on your web server, you can try setting up
240    "http://micro.example.net/" or the like.
241
242 3. Make your target directory writeable by the Web server.
243
244           chmod a+w /var/www/mublog/
245
246    On some systems, this will probably work:
247
248            chgrp www-data /var/www/mublog/
249            chmod g+w /var/www/mublog/
250
251    If your Web server runs as another user besides "www-data", try
252    that user's default group instead. As a last resort, you can create
253    a new group like "mublog" and add the Web server's user to the group.
254
255 4. You should also take this moment to make your avatar subdirectory
256    writeable by the Web server. An insecure way to do this is:
257
258           chmod a+w /var/www/mublog/avatar
259
260    You can also make the avatar directory writeable by the Web server
261    group, as noted above.
262
263 5. Create a database to hold your microblog data. Something like this
264    should work:
265
266           mysqladmin -u "username" --password="password" create laconica
267
268    Note that Laconica must have its own database; you can't share the
269    database with another program. You can name it whatever you want,
270    though.
271
272    (If you don't have shell access to your server, you may need to use
273    a tool like PHPAdmin to create a database. Check your hosting
274    service's documentation for how to create a new MySQL database.)
275
276 6. Create a new database account that Laconica will use to access the
277    database. If you have shell access, this will probably work from the
278    MySQL shell:
279
280           GRANT ALL on laconica.*
281           TO 'lacuser'@'localhost'
282           IDENTIFIED BY 'lacpassword';
283
284    You should change 'lacuser' and 'lacpassword' to your preferred new
285    username and password. You may want to test logging in to MySQL as
286    this new user.
287
288 7. In a browser, navigate to the Laconica install script; something like:
289
290            http://yourserver.example.com/mublog/install.php
291
292    Enter the database connection information and your site name. The
293    install program will configure your site and install the initial,
294    almost-empty database.
295
296 8. You should now be able to navigate to your microblog's main directory
297    and see the "Public Timeline", which will be empty. If not, magic
298    has happened! You can now register a new user, post some notices,
299    edit your profile, etc. However, you may want to wait to do that stuff
300    if you think you can set up "fancy URLs" (see below), since some
301    URLs are stored in the database.
302
303 Fancy URLs
304 ----------
305
306 By default, Laconica will use URLs that include the main PHP program's
307 name in them. For example, a user's home profile might be
308 found at:
309
310     http://example.org/mublog/index.php/mublog/fred
311
312 On certain systems that don't support this kind of syntax, they'll
313 look like this:
314
315     http://example.org/mublog/index.php?p=mublog/fred
316
317 It's possible to configure the software so it looks like this instead:
318
319     http://example.org/mublog/fred
320
321 These "fancy URLs" are more readable and memorable for users. To use
322 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
323 mod_redirect enabled, -OR- know how to configure "url redirection" in
324 your server.
325
326 1. Copy the htaccess.sample file to .htaccess in your Laconica
327    directory. Note: if you have control of your server's httpd.conf or
328    similar configuration files, it can greatly improve performance to
329    import the .htaccess file into your conf file instead. If you're
330    not sure how to do it, you may save yourself a lot of headache by
331    just leaving the .htaccess file.
332
333 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
334    to your Laconica installation on your server. Typically this will
335    be the path to your Laconica directory relative to your Web root.
336
337 3. Add or uncomment or change a line in your config.php file so it says:
338
339        $config['site']['fancy'] = true;
340
341 You should now be able to navigate to a "fancy" URL on your server,
342 like:
343
344      http://example.net/mublog/main/register
345
346 If you changed your HTTP server configuration, you may need to restart
347 the server first.
348
349 Sphinx
350 ------
351
352 To use a Sphinx server to search users and notices, you also need
353 to install, compile and enable the sphinx pecl extension for php on the
354 client side, which itself depends on the sphinx development files.
355 "pecl install sphinx" should take care of that. Add "extension=sphinx.so"
356 to your php.ini and reload apache to enable it.
357
358 You can update your MySQL or Postgresql databases to drop their fulltext
359 search indexes, since they're now provided by sphinx.
360
361 On the sphinx server side, a script reads the main database and build
362 the keyword index. A cron job reads the database and keeps the sphinx
363 indexes up to date. scripts/sphinx-cron.sh should be called by cron
364 every 5 minutes, for example. scripts/sphinx.sh is an init.d script
365 to start and stop the sphinx search daemon.
366
367 SMS
368 ---
369
370 Laconica supports a cheap-and-dirty system for sending update messages
371 to mobile phones and for receiving updates from the mobile. Instead of
372 sending through the SMS network itself, which is costly and requires
373 buy-in from the wireless carriers, it simply piggybacks on the email
374 gateways that many carriers provide to their customers. So, SMS
375 configuration is essentially email configuration.
376
377 Each user sends to a made-up email address, which they keep a secret.
378 Incoming email that is "From" the user's SMS email address, and "To"
379 the users' secret email address on the site's domain, will be
380 converted to a notice and stored in the DB.
381
382 For this to work, there *must* be a domain or sub-domain for which all
383 (or most) incoming email can pass through the incoming mail filter.
384
385 1. Run the SQL script carrier.sql in your Laconica database. This will
386    usually work:
387
388            mysql -u "lacuser" --password="lacpassword" laconica < db/carrier.sql
389
390    This will populate your database with a list of wireless carriers
391    that support email SMS gateways.
392
393 2. Make sure the maildaemon.php file is executable:
394
395         chmod +x scripts/maildaemon.php
396
397    Note that "daemon" is kind of a misnomer here; the script is more
398    of a filter than a daemon.
399
400 2. Edit /etc/aliases on your mail server and add the following line:
401
402       *: /path/to/laconica/scripts/maildaemon.php
403
404 3. Run whatever code you need to to update your aliases database. For
405    many mail servers (Postfix, Exim, Sendmail), this should work:
406
407       newaliases
408
409    You may need to restart your mail server for the new database to
410    take effect.
411
412 4. Set the following in your config.php file:
413
414    $config['mail']['domain'] = 'yourdomain.example.net';
415
416 At this point, post-by-email and post-by-SMS-gateway should work. Note
417 that if your mail server is on a different computer from your email
418 server, you'll need to have a full installation of Laconica, a working
419 config.php, and access to the Laconica database from the mail server.
420
421 XMPP
422 ----
423
424 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
425 instant-messenger protocol that drives Jabber and GTalk IM. You can
426 distribute messages via XMPP using the system below; however, you
427 need to run the XMPP incoming daemon to allow incoming messages as
428 well.
429
430 1. You may want to strongly consider setting up your own XMPP server.
431    Ejabberd, OpenFire, and JabberD are all Open Source servers.
432    Jabber, Inc. provides a high-performance commercial server.
433
434 2. You must register a Jabber ID (JID) with your new server. It helps
435    to choose a name like "update@example.com" or "notice" or something
436    similar.  Alternately, your "update JID" can be registered on a
437    publicly-available XMPP service, like jabber.org or GTalk.
438
439    Laconica will not register the JID with your chosen XMPP server;
440    you need to do this manually, with an XMPP client like Gajim,
441    Telepathy, or Pidgin.im.
442
443 3. Configure your site's XMPP variables, as described below in the
444    configuration section.
445
446 On a default installation, your site can broadcast messages using
447 XMPP. Users won't be able to post messages using XMPP unless you've
448 got the XMPP daemon running.  See 'Queues and daemons' below for how
449 to set that up. Also, once you have a sizable number of users, sending
450 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
451 can really slow down your site; it may cause posting to timeout.
452
453 NOTE: stream_select(), a crucial function for network programming, is
454 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
455 work around this bug in Laconica; current recommendation is to move
456 off of amd64 to another server.
457
458 Public feed
459 -----------
460
461 You can send *all* messages from your microblogging site to a
462 third-party service using XMPP. This can be useful for providing
463 search, indexing, bridging, or other cool services.
464
465 To configure a downstream site to receive your public stream, add
466 their "JID" (Jabber ID) to your config.php as follows:
467
468       $config['xmpp']['public'][] = 'downstream@example.net';
469
470 (Don't miss those square brackets at the end.) Note that your XMPP
471 broadcasting must be configured as mentioned above. Although you can
472 send out messages at "Web time", high-volume sites should strongly
473 consider setting up queues and daemons.
474
475 Queues and daemons
476 ------------------
477
478 Some activities that Laconica needs to do, like broadcast OMB, SMS,
479 and XMPP messages, can be 'queued' and done by off-line bots instead.
480 For this to work, you must be able to run long-running offline
481 processes, either on your main Web server or on another server you
482 control. (Your other server will still need all the above
483 prerequisites, with the exception of Apache.) Installing on a separate
484 server is probably a good idea for high-volume sites.
485
486 1. You'll need the "CLI" (command-line interface) version of PHP
487    installed on whatever server you use.
488
489 2. If you're using a separate server for queues, install Laconica
490    somewhere on the server. You don't need to worry about the
491    .htaccess file, but make sure that your config.php file is close
492    to, or identical to, your Web server's version.
493
494 3. In your config.php files (both the Web server and the queues
495    server!), set the following variable:
496
497    $config['queue']['enabled'] = true;
498
499    You may also want to look at the 'daemon' section of this file for
500    more daemon options. Note that if you set the 'user' and/or 'group'
501    options, you'll need to create that user and/or group by hand.
502    They're not created automatically.
503
504 4. On the queues server, run the command scripts/startdaemons.sh. It
505    needs as a parameter the install path; if you run it from the
506    Laconica dir, "." should suffice.
507
508 This will run eight (for now) queue handlers:
509
510 * xmppdaemon.php - listens for new XMPP messages from users and stores
511   them as notices in the database.
512 * jabberqueuehandler.php - sends queued notices in the database to
513   registered users who should receive them.
514 * publicqueuehandler.php - sends queued notices in the database to
515   public feed listeners.
516 * ombqueuehandler.php - sends queued notices to OpenMicroBlogging
517   recipients on foreign servers.
518 * smsqueuehandler.php - sends queued notices to SMS-over-email addresses
519   of registered users.
520 * xmppconfirmhandler.php - sends confirmation messages to registered
521   users.
522 * twitterqueuehandler.php - sends queued notices to Twitter for user
523   who have opted to set up Twitter bridging.
524 * facebookqueuehandler.php - sends queued notices to Facebook for users
525   of the built-in Facebook application.
526
527 Note that these queue daemons are pretty raw, and need your care. In
528 particular, they leak memory, and you may want to restart them on a
529 regular (daily or so) basis with a cron job. Also, if they lose
530 the connection to the XMPP server for too long, they'll simply die. It
531 may be a good idea to use a daemon-monitoring service, like 'monit',
532 to check their status and keep them running.
533
534 All the daemons write their process IDs (pids) to /var/run/ by
535 default. This can be useful for starting, stopping, and monitoring the
536 daemons.
537
538 Twitter Friends Syncing
539 -----------------------
540
541 As of Laconica 0.6.3, users may set a flag in their settings ("Subscribe
542 to my Twitter friends here" under the Twitter tab) to have Laconica
543 attempt to locate and subscribe to "friends" (people they "follow") on
544 Twitter who also have accounts on your Laconica system, and who have
545 previously set up a link for automatically posting notices to Twitter.
546
547 Optionally, there is a script (./scripts/synctwitterfriends.php), meant
548 to be run periodically from a job scheduler (e.g.: cron under Unix), to
549 look for new additions to users' friends lists. Note that the friends
550 syncing only subscribes users to each other, it does not unsubscribe
551 users when they stop following each other on Twitter.
552
553 Sample cron job:
554
555 # Update Twitter friends subscriptions every half hour
556 0,30 * * * * /path/to/php /path/to/laconica/scripts/synctwitterfriends.php>&/dev/null
557
558 Built-in Facebook Application
559 -----------------------------
560
561 Laconica's Facebook application allows your users to automatically
562 update their Facebook statuses with their latest notices, invite
563 their friends to use the app (and thus your site), view their notice
564 timelines, and post notices -- all from within Facebook. The application
565 is built into Laconica and runs on your host.  For automatic Facebook
566 status updating to work you will need to enable queuing and run the
567 facebookqueuehandler.php daemon (see the "Queues and daemons" section
568 above).
569
570 Quick setup instructions*:
571
572 Install the Facebook Developer application on Facebook:
573
574     http://www.facebook.com/developers/
575
576 Use it to create a new application and generate an API key and secret.
577 Uncomment the Facebook app section of your config.php and copy in the
578 key and secret, e.g.:
579
580     # Config section for the built-in Facebook application
581     $config['facebook']['apikey'] = 'APIKEY';
582     $config['facebook']['secret'] = 'SECRET';
583
584 In Facebook's application editor, specify the following URLs for your app:
585
586 - Callback URL: http://example.net/mublog/facebook/
587 - Post-Remove URL: http://example.net/mublog/facebook/remove
588 - Post-Add Redirect URL: http://apps.facebook.com/yourapp/
589 - Canvas URL: http://apps.facebook.com/yourapp/
590
591 (Replace 'example.net' with your host's URL, 'mublog' with the path
592 to your Laconica installation, and 'yourapp' with the name of the
593 Facebook application you created.)
594
595 Additionally, Choose "Web" for Application type in the Advanced tab.
596 In the "Canvas setting" section, choose the "FBML" for Render Method,
597 "Smart Size" for IFrame size, and "Full width (760px)" for Canvas Width.
598 Everything else can be left with default values.
599
600 *For more detailed instructions please see the installation guide on the
601 Laconica wiki:
602
603     http://laconi.ca/trac/wiki/FacebookApplication
604
605 Sitemaps
606 --------
607
608 Sitemap files <http://sitemaps.org/> are a very nice way of telling
609 search engines and other interested bots what's available on your site
610 and what's changed recently. You can generate sitemap files for your
611 Laconica instance.
612
613 1. Choose your sitemap URL layout. Laconica creates a number of
614    sitemap XML files for different parts of your site. You may want to
615    put these in a sub-directory of your Laconica directory to avoid
616    clutter. The sitemap index file tells the search engines and other
617    bots where to find all the sitemap files; it *must* be in the main
618    installation directory or higher. Both types of file must be
619    available through HTTP.
620
621 2. To generate your sitemaps, run the following command on your server:
622
623    php scripts/sitemap.php -f index-file-path -d sitemap-directory -u URL-prefix-for-sitemaps
624
625    Here, index-file-path is the full path to the sitemap index file,
626    like './sitemapindex.xml'. sitemap-directory is the directory where
627    you want the sitemaps stored, like './sitemaps/' (make sure the dir
628    exists). URL-prefix-for-sitemaps is the full URL for the sitemap dir,
629    typically something like <http://example.net/mublog/sitemaps/>.
630
631 You can use several methods for submitting your sitemap index to
632 search engines to get your site indexed. One is to add a line like the
633 following to your robots.txt file:
634
635    Sitemap: /mublog/sitemapindex.xml
636
637 This is a good idea for letting *all* Web spiders know about your
638 sitemap. You can also submit sitemap files to major search engines
639 using their respective "Webmaster centres"; see sitemaps.org for links
640 to these resources.
641
642 Themes
643 ------
644
645 There are two themes shipped with this version of Laconica: "identica",
646 which is what the Identi.ca site uses, and "default", which is a good
647 basis for other sites.
648
649 As of right now, your ability to change the theme is site-wide; users
650 can't choose their own theme. Additionally, the only thing you can
651 change in the theme is CSS stylesheets and some image files; you can't
652 change the HTML output, like adding or removing menu items.
653
654 You can choose a theme using the $config['site']['theme'] element in
655 the config.php file. See below for details.
656
657 You can add your own theme by making a sub-directory of the 'theme'
658 subdirectory with the name of your theme. Each theme can have the
659 following files:
660
661 display.css: a CSS2 file for "default" styling for all browsers.
662 ie6.css: a CSS2 file for override styling for fixing up Internet
663          Explorer 6.
664 ie7.css: a CSS2 file for override styling for fixing up Internet
665          Explorer 7.
666 logo.png: a logo image for the site.
667 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
668                             users who don't upload their own.
669 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
670 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
671                          listing on profile pages.
672
673 You may want to start by copying the files from the default theme to
674 your own directory.
675
676 NOTE: the HTML generated by Laconica changed *radically* between
677 version 0.6.x and 0.7.x. Older themes will need signification
678 modification to use the new output format.
679
680 Translation
681 -----------
682
683 Translations in Laconica use the gettext system <http://www.gnu.org/software/gettext/>.
684 Theoretically, you can add your own sub-directory to the locale/
685 subdirectory to add a new language to your system. You'll need to
686 compile the ".po" files into ".mo" files, however.
687
688 Contributions of translation information to Laconica are very easy:
689 you can use the Web interface at http://laconi.ca/pootle/ to add one
690 or a few or lots of new translations -- or even new languages. You can
691 also download more up-to-date .po files there, if you so desire.
692
693 Backups
694 -------
695
696 There is no built-in system for doing backups in Laconica. You can make
697 backups of a working Laconica system by backing up the database and
698 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
699 and to backup the Web directory, try tar.
700
701 Private
702 -------
703
704 The administrator can set the "private" flag for a site so that it's
705 not visible to non-logged-in users. This might be useful for
706 workgroups who want to share a microblogging site for project
707 management, but host it on a public server.
708
709 Note that this is an experimental feature; total privacy is not
710 guaranteed or ensured. Also, privacy is all-or-nothing for a site; you
711 can't have some accounts or notices private, and others public.
712 Finally, the interaction of private sites with OpenMicroBlogging is
713 undefined. Remote users won't be able to subscribe to users on a
714 private site, but users of the private site may be able to subscribe
715 to users on a remote site. (Or not... it's not well tested.) The
716 "proper behaviour" hasn't been defined here, so handle with care.
717
718 Upgrading
719 =========
720
721 IMPORTANT NOTE: Laconica 0.7.4 introduced a fix for some
722 incorrectly-stored international characters ("UTF-8"). For new
723 installations, it will now store non-ASCII characters correctly.
724 However, older installations will have the incorrect storage, and will
725 consequently show up "wrong" in browsers. See below for how to deal
726 with this situation.
727
728 If you've been using Laconica 0.7, 0.6, 0.5 or lower, or if you've
729 been tracking the "git" version of the software, you will probably
730 want to upgrade and keep your existing data. There is no automated
731 upgrade procedure in Laconica 0.8.0. Try these step-by-step
732 instructions; read to the end first before trying them.
733
734 0. Download Laconica and set up all the prerequisites as if you were
735    doing a new install.
736 1. Make backups of both your database and your Web directory. UNDER NO
737    CIRCUMSTANCES should you try to do an upgrade without a known-good
738    backup. You have been warned.
739 2. Shut down Web access to your site, either by turning off your Web
740    server or by redirecting all pages to a "sorry, under maintenance"
741    page.
742 3. Shut down XMPP access to your site, typically by shutting down the
743    xmppdaemon.php process and all other daemons that you're running.
744    If you've got "monit" or "cron" automatically restarting your
745    daemons, make sure to turn that off, too.
746 4. Shut down SMS and email access to your site. The easy way to do
747    this is to comment out the line piping incoming email to your
748    maildaemon.php file, and running something like "newaliases".
749 5. Once all writing processes to your site are turned off, make a
750    final backup of the Web directory and database.
751 6. Move your Laconica directory to a backup spot, like "mublog.bak".
752 7. Unpack your Laconica 0.8.0 tarball and move it to "mublog" or
753    wherever your code used to be.
754 8. Copy the config.php file and avatar directory from your old
755    directory to your new directory.
756 9. Copy htaccess.sample to .htaccess in the new directory. Change the
757    RewriteBase to use the correct path.
758 10. Rebuild the database. NOTE: this step is destructive and cannot be
759     reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
760     do it without a known-good backup!
761
762     If your database is at version 0.7.4, you can run a special upgrade
763     script:
764
765     mysql -u<rootuser> -p<rootpassword> <database> db/074to080.sql
766
767     Otherwise, go to your Laconica directory and AFTER YOU MAKE A
768     BACKUP run the rebuilddb.sh script like this:
769
770     ./scripts/rebuilddb.sh rootuser rootpassword database db/laconica.sql
771
772     Here, rootuser and rootpassword are the username and password for a
773     user who can drop and create databases as well as tables; typically
774     that's _not_ the user Laconica runs as. Note that rebuilddb.sh drops
775     your database and rebuilds it; if there is an error you have no
776     database. Make sure you have a backup.
777     For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
778     which operates slightly differently. Read the documentation in that
779     script before running it.
780 11. Use mysql or psql client to log into your database and make sure that
781     the notice, user, profile, subscription etc. tables are non-empty.
782 12. Turn back on the Web server, and check that things still work.
783 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
784     bots have changed since version 0.5; see above for details.
785
786 If you're upgrading from very old versions, you may want to look at
787 the fixup_* scripts in the scripts directories. These will store some
788 precooked data in the DB. All upgraders should check out the inboxes
789 options below.
790
791 NOTE: the database definition file, stoica.ini, has been renamed to
792 laconica.ini (since this is the recommended database name). If you
793 have a line in your config.php pointing to the old name, you'll need
794 to update it.
795
796 Notice inboxes
797 --------------
798
799 Before version 0.6.2, the page showing all notices from people the
800 user is subscribed to ("so-and-so with friends") was calculated at run
801 time. Starting with 0.6.2, we have a new data structure for holding a
802 user's "notice inbox". (Note: distinct from the "message inbox", which
803 is the "inbox" tab in the UI. The notice inbox appears under the
804 "Personal" tab.)
805
806 Notices are added to the inbox when they're created. This speeds up
807 the query considerably, and also allows us the opportunity, in the
808 future, to add different kind of notices to an inbox -- like @-replies
809 or subscriptions to search terms or hashtags.
810
811 Notice inboxes are enabled by default for new installations. If you
812 are upgrading an existing site, this means that your users will see
813 empty "Personal" pages. The following steps will help you fix the
814 problem.
815
816 0. $config['inboxes']['enabled'] can be set to one of three values. If
817    you set it to 'false', the site will work as before. Support for this
818    will probably be dropped in future versions.
819 1. Setting the flag to 'transitional' means that you're in transition.
820    In this mode, the code will run the "new query" or the "old query"
821    based on whether the user's inbox has been updated.
822 2. After setting the flag to "transitional", you can run the
823    fixup_inboxes.php script to create the inboxes. You may want to set
824    the memory limit high. You can re-run it without ill effect.
825 3. When fixup_inboxes is finished, you can set the enabled flag to
826    'true'.
827
828 NOTE: we will drop support for non-inboxed sites in the 0.9.x version
829 of Laconica. It's time to switch now!
830
831 UTF-8 Database
832 --------------
833
834 Laconica 0.7.4 introduced a fix for some incorrectly-stored
835 international characters ("UTF-8"). This fix is not
836 backwards-compatible; installations from before 0.7.4 will show
837 non-ASCII characters of old notices incorrectly. This section explains
838 what to do.
839
840 0. You can disable the new behaviour by setting the 'db''utf8' config
841    option to "false". You should only do this until you're ready to
842    convert your DB to the new format.
843 1. When you're ready to convert, you can run the fixup_utf8.php script
844    in the scripts/ subdirectory. If you've had the "new behaviour"
845    enabled (probably a good idea), you can give the ID of the first
846    "new" notice as a parameter, and only notices before that one will
847    be converted. Notices are converted in reverse chronological order,
848    so the most recent (and visible) ones will be converted first. The
849    script should work whether or not you have the 'db''utf8' config
850    option enabled.
851 2. When you're ready, set $config['db']['utf8'] to true, so that
852    new notices will be stored correctly.
853
854 Configuration options
855 =====================
856
857 The main configuration file for Laconica (excepting configurations for
858 dependency software) is config.php in your Laconica directory. If you
859 edit any other file in the directory, like lib/common.php (where most
860 of the defaults are defined), you will lose your configuration options
861 in any upgrade, and you will wish that you had been more careful.
862
863 Starting with version 0.7.1, you can put config files in the
864 /etc/laconica/ directory on your server, if it exists. Config files
865 will be included in this order:
866
867 * /etc/laconica/laconica.php - server-wide config
868 * /etc/laconica/<servername>.php - for a virtual host
869 * /etc/laconica/<servername>_<pathname>.php - for a path
870 * INSTALLDIR/config.php - for a particular implementation
871
872 Almost all configuration options are made through a two-dimensional
873 associative array, cleverly named $config. A typical configuration
874 line will be:
875
876      $config['section']['option'] = value;
877
878 For brevity, the following documentation describes each section and
879 option.
880
881 site
882 ----
883
884 This section is a catch-all for site-wide variables.
885
886 name: the name of your site, like 'YourCompany Microblog'.
887 server: the server part of your site's URLs, like 'example.net'.
888 path: The path part of your site's URLs, like 'mublog' or ''
889       (installed in root).
890 fancy: whether or not your site uses fancy URLs (see Fancy URLs
891        section above). Default is false.
892 logfile: full path to a file for Laconica to save logging
893          information to. You may want to use this if you don't have
894          access to syslog.
895 locale_path: full path to the directory for locale data. Unless you
896              store all your locale data in one place, you probably
897              don't need to use this.
898 language: default language for your site. Defaults to US English.
899 languages: A list of languages supported on your site. Typically you'd
900            only change this if you wanted to disable support for one
901            or another language:
902            "unset($config['site']['languages']['de'])" will disable
903            support for German.
904 theme: Theme for your site (see Theme section). Two themes are
905        provided by default: 'default' and 'stoica' (the one used by
906        Identi.ca). It's appreciated if you don't use the 'stoica' theme
907        except as the basis for your own.
908 email: contact email address for your site. By default, it's extracted
909        from your Web server environment; you may want to customize it.
910 broughtbyurl: name of an organization or individual who provides the
911            service. Each page will include a link to this name in the
912            footer. A good way to link to the blog, forum, wiki,
913            corporate portal, or whoever is making the service available.
914 broughtby: text used for the "brought by" link.
915 timezone: default timezone for message display. Users can set their
916           own time zone. Defaults to 'UTC', which is a pretty good default.
917 closed: If set to 'true', will disallow registration on your site.
918         This is a cheap way to restrict accounts to only one
919         individual or group; just register the accounts you want on
920         the service, *then* set this variable to 'true'.
921 inviteonly: If set to 'true', will only allow registration if the user
922             was invited by an existing user.
923 private: If set to 'true', anonymous users will be redirected to the
924          'login' page. Also, API methods that normally require no
925          authentication will require it. Note that this does not turn
926          off registration; use 'closed' or 'inviteonly' for the
927          behaviour you want.
928 notice: A plain string that will appear on every page. A good place
929         to put introductory information about your service, or info about
930         upgrades and outages, or other community info. Any HTML will
931         be escaped.
932 dupelimit: Time in which it's not OK for the same person to post the
933            same notice; default = 60 seconds.
934 logo: URL of an image file to use as the logo for the site. Overrides
935       the logo in the theme, if any.
936 ssl: Whether to use SSL and https:// URLs for some or all pages.
937      Possible values are 'always' (use it for all pages), 'never'
938      (don't use it for any pages), or 'sometimes' (use it for
939      sensitive pages that include passwords like login and registration,
940      but not for regular pages). Default to 'never'.
941 sslserver: use an alternate server name for SSL URLs, like
942            'secure.example.org'. You should be careful to set cookie
943            parameters correctly so that both the SSL server and the
944            "normal" server can access the session cookie and
945            preferably other cookies as well.
946 shorturllength: Length of URL at which URLs in a message exceeding 140
947                 characters will be sent to the user's chosen
948                 shortening service.
949
950 db
951 --
952
953 This section is a reference to the configuration options for
954 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
955 set are listed below for clarity.
956
957 database: a DSN (Data Source Name) for your Laconica database. This is
958           in the format 'protocol://username:password@hostname/databasename',
959           where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
960           really know what you're doing), 'username' is the username,
961           'password' is the password, and etc.
962 ini_yourdbname: if your database is not named 'laconica', you'll need
963                 to set this to point to the location of the
964                 laconica.ini file. Note that the real name of your database
965                 should go in there, not literally 'yourdbname'.
966 db_driver: You can try changing this to 'MDB2' to use the other driver
967            type for DB_DataObject, but note that it breaks the OpenID
968            libraries, which only support PEAR::DB.
969 debug: On a database error, you may get a message saying to set this
970        value to 5 to see debug messages in the browser. This breaks
971        just about all pages, and will also expose the username and
972        password
973 quote_identifiers: Set this to true if you're using postgresql.
974 type: either 'mysql' or 'postgresql' (used for some bits of
975       database-type-specific SQL in the code). Defaults to mysql.
976 mirror: you can set this to an array of DSNs, like the above
977         'database' value. If it's set, certain read-only actions will
978         use a random value out of this array for the database, rather
979         than the one in 'database' (actually, 'database' is overwritten).
980         You can offload a busy DB server by setting up MySQL replication
981         and adding the slaves to this array. Note that if you want some
982         requests to go to the 'database' (master) server, you'll need
983         to include it in this array, too.
984 utf8: whether to talk to the database in UTF-8 mode. This is the default
985       with new installations, but older sites may want to turn it off
986       until they get their databases fixed up. See "UTF-8 database"
987       above for details.
988
989 syslog
990 ------
991
992 By default, Laconica sites log error messages to the syslog facility.
993 (You can override this using the 'logfile' parameter described above).
994
995 appname: The name that Laconica uses to log messages. By default it's
996          "laconica", but if you have more than one installation on the
997          server, you may want to change the name for each instance so
998          you can track log messages more easily.
999
1000 queue
1001 -----
1002
1003 You can configure the software to queue time-consuming tasks, like
1004 sending out SMS email or XMPP messages, for off-line processing. See
1005 'Queues and daemons' above for how to set this up.
1006
1007 enabled: Whether to uses queues. Defaults to false.
1008
1009 license
1010 -------
1011
1012 The default license to use for your users notices. The default is the
1013 Creative Commons Attribution 3.0 license, which is probably the right
1014 choice for any public site. Note that some other servers will not
1015 accept notices if you apply a stricter license than this.
1016
1017 url: URL of the license, used for links.
1018 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1019 image: A button shown on each page for the license.
1020
1021 mail
1022 ----
1023
1024 This is for configuring out-going email. We use PEAR's Mail module,
1025 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1026
1027 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1028          'smtp'. Defaults to PEAR's default, 'mail'.
1029 params: if the mail backend requires any parameters, you can provide
1030         them in an associative array.
1031
1032 nickname
1033 --------
1034
1035 This is for configuring nicknames in the service.
1036
1037 blacklist: an array of strings for usernames that may not be
1038            registered. A default array exists for strings that are
1039            used by Laconica (e.g. 'doc', 'main', 'avatar', 'theme')
1040            but you may want to add others if you have other software
1041            installed in a subdirectory of Laconica or if you just
1042            don't want certain words used as usernames.
1043 featured: an array of nicknames of 'featured' users of the site.
1044           Can be useful to draw attention to well-known users, or
1045           interesting people, or whatever.
1046
1047 avatar
1048 ------
1049
1050 For configuring avatar access.
1051
1052 dir:    Directory to look for avatar files and to put them into.
1053         Defaults to avatar subdirectory of install directory; if
1054         you change it, make sure to change path, too.
1055 path:   Path to avatars. Defaults to path for avatar subdirectory,
1056         but you can change it if you wish. Note that this will
1057         be included with the avatar server, too.
1058 server: If set, defines another server where avatars are stored in the
1059         root directory. Note that the 'avatar' subdir still has to be
1060         writeable. You'd typically use this to split HTTP requests on
1061         the client to speed up page loading, either with another
1062         virtual server or with an NFS or SAMBA share. Clients
1063         typically only make 2 connections to a single server at a
1064         time <http://ur1.ca/6ih>, so this can parallelize the job.
1065         Defaults to null.
1066
1067 public
1068 ------
1069
1070 For configuring the public stream.
1071
1072 localonly: If set to true, only messages posted by users of this
1073            service (rather than other services, filtered through OMB)
1074            are shown in the public stream. Default true.
1075 blacklist: An array of IDs of users to hide from the public stream.
1076            Useful if you have someone making excessive Twitterfeed posts
1077            to the site, other kinds of automated posts, testing bots, etc.
1078
1079 theme
1080 -----
1081
1082 server: Like avatars, you can speed up page loading by pointing the
1083         theme file lookup to another server (virtual or real).
1084         Defaults to NULL, meaning to use the site server.
1085 dir:    Directory where theme files are stored. Used to determine
1086         whether to show parts of a theme file. Defaults to the theme
1087         subdirectory of the install directory.
1088 path:   Path part of theme URLs, before the theme name. Relative to the
1089         theme server. It may make sense to change this path when upgrading,
1090         (using version numbers as the path) to make sure that all files are
1091         reloaded by caching clients or proxies. Defaults to null,
1092         which means to use the site path + '/theme'.
1093
1094 xmpp
1095 ----
1096
1097 For configuring the XMPP sub-system.
1098
1099 enabled: Whether to accept and send messages by XMPP. Default false.
1100 server: server part of XMPP ID for update user.
1101 port: connection port for clients. Default 5222, which you probably
1102       shouldn't need to change.
1103 user: username for the client connection. Users will receive messages
1104       from 'user'@'server'.
1105 resource: a unique identifier for the connection to the server. This
1106           is actually used as a prefix for each XMPP component in the system.
1107 password: password for the user account.
1108 host: some XMPP domains are served by machines with a different
1109       hostname. (For example, @gmail.com GTalk users connect to
1110       talk.google.com). Set this to the correct hostname if that's the
1111       case with your server.
1112 encryption: Whether to encrypt the connection between Laconica and the
1113             XMPP server. Defaults to true, but you can get
1114             considerably better performance turning it off if you're
1115             connecting to a server on the same machine or on a
1116             protected network.
1117 debug: if turned on, this will make the XMPP library blurt out all of
1118        the incoming and outgoing messages as XML stanzas. Use as a
1119        last resort, and never turn it on if you don't have queues
1120        enabled, since it will spit out sensitive data to the browser.
1121 public: an array of JIDs to send _all_ notices to. This is useful for
1122         participating in third-party search and archiving services.
1123
1124 invite
1125 ------
1126
1127 For configuring invites.
1128
1129 enabled: Whether to allow users to send invites. Default true.
1130
1131 tag
1132 ---
1133
1134 Miscellaneous tagging stuff.
1135
1136 dropoff: Decay factor for tag listing, in seconds.
1137          Defaults to exponential decay over ten days; you can twiddle
1138          with it to try and get better results for your site.
1139
1140 daemon
1141 ------
1142
1143 For daemon processes.
1144
1145 piddir: directory that daemon processes should write their PID file
1146         (process ID) to. Defaults to /var/run/, which is where this
1147         stuff should usually go on Unix-ish systems.
1148 user: If set, the daemons will try to change their effective user ID
1149       to this user before running. Probably a good idea, especially if
1150       you start the daemons as root. Note: user name, like 'daemon',
1151       not 1001.
1152 group: If set, the daemons will try to change their effective group ID
1153        to this named group. Again, a name, not a numerical ID.
1154
1155 memcached
1156 ---------
1157
1158 You can get a significant boost in performance by caching some
1159 database data in memcached <http://www.danga.com/memcached/>.
1160
1161 enabled: Set to true to enable. Default false.
1162 server: a string with the hostname of the memcached server. Can also
1163         be an array of hostnames, if you've got more than one server.
1164 base: memcached uses key-value pairs to store data. We build long,
1165       funny-looking keys to make sure we don't have any conflicts. The
1166       base of the key is usually a simplified version of the site name
1167       (like "Identi.ca" => "identica"), but you can overwrite this if
1168       you need to. You can safely ignore it if you only have one
1169       Laconica site using your memcached server.
1170 port: Port to connect to; defaults to 11211.
1171
1172 sphinx
1173 ------
1174
1175 You can get a significant boost in performance using Sphinx Search
1176 instead of your database server to search for users and notices.
1177 <http://sphinxsearch.com/>.
1178
1179 enabled: Set to true to enable. Default false.
1180 server: a string with the hostname of the sphinx server.
1181 port: an integer with the port number of the sphinx server.
1182
1183 integration
1184 -----------
1185
1186 A catch-all for integration with other systems.
1187
1188 source: The name to use for the source of posts to Twitter. Defaults
1189         to 'laconica', but if you request your own source name from
1190         Twitter <http://twitter.com/help/request_source>, you can use
1191         that here instead. Status updates on Twitter will then have
1192         links to your site.
1193
1194 inboxes
1195 -------
1196
1197 For notice inboxes.
1198
1199 enabled: A three-valued flag for whether to use notice inboxes (see
1200          upgrading info above for notes about this change). Can be
1201          'false', 'true', or '"transitional"'.
1202
1203 throttle
1204 --------
1205
1206 For notice-posting throttles.
1207
1208 enabled: Whether to throttle posting. Defaults to false.
1209 count: Each user can make this many posts in 'timespan' seconds. So, if count
1210        is 100 and timespan is 3600, then there can be only 100 posts
1211        from a user every hour.
1212 timespan: see 'count'.
1213
1214 profile
1215 -------
1216
1217 Profile management.
1218
1219 banned: an array of usernames and/or profile IDs of 'banned' profiles.
1220         The site will reject any notices by these users -- they will
1221         not be accepted at all. (Compare with blacklisted users above,
1222         whose posts just won't show up in the public stream.)
1223
1224 newuser
1225 -------
1226
1227 Options with new users.
1228
1229 default: nickname of a user account to automatically subscribe new
1230          users to. Typically this would be system account for e.g.
1231          service updates or announcements. Users are able to unsub
1232          if they want. Default is null; no auto subscribe.
1233 welcome: nickname of a user account that sends welcome messages to new
1234          users. Can be the same as 'default' account, although on
1235          busy servers it may be a good idea to keep that one just for
1236          'urgent' messages. Default is null; no message.
1237
1238 If either of these special user accounts are specified, the users should
1239 be created before the configuration is updated.
1240
1241 snapshot
1242 --------
1243
1244 The software will, by default, send statistical snapshots about the
1245 local installation to a stats server on the laconi.ca Web site. This
1246 data is used by the developers to prioritize development decisions. No
1247 identifying data about users or organizations is collected. The data
1248 is available to the public for review. Participating in this survey
1249 helps Laconica developers take your needs into account when updating
1250 the software.
1251
1252 run: string indicating when to run the statistics. Values can be 'web'
1253      (run occasionally at Web time), 'cron' (run from a cron script),
1254      or 'never' (don't ever run). If you set it to 'cron', remember to
1255      schedule the script to run on a regular basis.
1256 frequency: if run value is 'web', how often to report statistics.
1257            Measured in Web hits; depends on how active your site is.
1258            Default is 10000 -- that is, one report every 10000 Web hits,
1259            on average.
1260 reporturl: URL to post statistics to. Defaults to Laconica developers'
1261            report system, but if they go evil or disappear you may
1262            need to update this to another value. Note: if you
1263            don't want to report stats, it's much better to
1264            set 'run' to 'never' than to set this value to something
1265            nonsensical.
1266
1267 attachments
1268 -----------
1269
1270 The software lets users upload files with their notices. You can configure
1271 the types of accepted files by mime types and a trio of quota options:
1272 per file, per user (total), per user per month.
1273
1274 We suggest the use of the pecl file_info extension to handle mime type
1275 detection.
1276
1277 supported: an array of mime types you accept to store and distribute,
1278            like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1279            setup your server to properly reckognize the types you want to
1280            support.
1281 uploads:   false to disable uploading files with notices (true by default).
1282 filecommand: The required MIME_Type library may need to use the 'file'
1283              command. It tries the one in the Web server's path, but if
1284              you're having problems with uploads, try setting this to the
1285              correct value. Note: 'file' must accept '-b' and '-i' options.
1286
1287 For quotas, be sure you've set the upload_max_filesize and post_max_size
1288 in php.ini to be large enough to handle your upload. In httpd.conf
1289 (if you're using apache), check that the LimitRequestBody directive isn't
1290 set too low (it's optional, so it may not be there at all).
1291
1292 file_quota: maximum size for a single file upload in bytes. A user can send
1293             any amount of notices with attachments as long as each attachment
1294             is smaller than file_quota.
1295 user_quota: total size in bytes a user can store on this server. Each user
1296             can store any number of files as long as their total size does
1297             not exceed the user_quota.
1298 monthly_quota: total size permitted in the current month. This is the total
1299             size in bytes that a user can upload each month.
1300
1301 group
1302 -----
1303
1304 Options for group functionality.
1305
1306 maxaliases: maximum number of aliases a group can have. Default 3. Set
1307             to 0 or less to prevent aliases in a group.
1308
1309 oohembed
1310 --------
1311
1312 oEmbed endpoint for multimedia attachments (links in posts).
1313
1314 endpoint: oohembed endpoint using http://oohembed.com/ software.
1315
1316 search
1317 ------
1318
1319 Some stuff for search.
1320
1321 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1322       be 'fulltext' (default) or 'like'. The former is faster and more efficient
1323       but requires the lame old MyISAM engine for MySQL. The latter
1324       will work with InnoDB but could be miserably slow on large
1325       systems. We'll probably add another type sometime in the future,
1326       with our own indexing system (maybe like MediaWiki's).
1327
1328 sessions
1329 --------
1330
1331 Session handling.
1332
1333 handle: boolean. Whether we should register our own PHP session-handling
1334         code (using the database and memcache if enabled). Defaults to false.
1335         Setting this to true makes some sense on large or multi-server
1336         sites, but it probably won't hurt for smaller ones, either.
1337 debug: whether to output debugging info for session storage. Can help
1338        with weird session bugs, sometimes. Default false.
1339
1340 Troubleshooting
1341 ===============
1342
1343 The primary output for Laconica is syslog, unless you configured a
1344 separate logfile. This is probably the first place to look if you're
1345 getting weird behaviour from Laconica.
1346
1347 If you're tracking the unstable version of Laconica in the git
1348 repository (see below), and you get a compilation error ("unexpected
1349 T_STRING") in the browser, check to see that you don't have any
1350 conflicts in your code.
1351
1352 If you upgraded to Laconica 0.7.4 without reading the "Notice inboxes"
1353 section above, and all your users' 'Personal' tabs are empty, read the
1354 "Notice inboxes" section above.
1355
1356 Myths
1357 =====
1358
1359 These are some myths you may see on the Web about Laconica.
1360 Documentation from the core team about Laconica has been pretty
1361 sparse, so some backtracking and guesswork resulted in some incorrect
1362 assumptions.
1363
1364 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1365   extremely bad idea. It's a tool built into DB_DataObject that will
1366   emit oodles of print lines directly to the browser of your users.
1367   Among these lines will be your database username and password. Do
1368   not enable this option on a production Web site for any reason.
1369
1370 - "Edit dataobject.ini with the following settings..." dataobject.ini
1371   is a development file for the DB_DataObject framework and is not
1372   used by the running software. It was removed from the Laconica
1373   distribution because its presence was confusing. Do not bother
1374   configuring dataobject.ini, and do not put your database username
1375   and password into the file on a production Web server; unscrupulous
1376   persons may try to read it to get your passwords.
1377
1378 Unstable version
1379 ================
1380
1381 If you're adventurous or impatient, you may want to install the
1382 development version of Laconica. To get it, use the git version
1383 control tool <http://git-scm.com/> like so:
1384
1385         git clone http://laconi.ca/software/laconica.git
1386
1387 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1388
1389 Further information
1390 ===================
1391
1392 There are several ways to get more information about Laconica.
1393
1394 * There is a mailing list for Laconica developers and admins at
1395   http://mail.laconi.ca/mailman/listinfo/laconica-dev
1396 * The #laconica IRC channel on freenode.net <http://www.freenode.net/>.
1397 * The Laconica wiki, http://laconi.ca/trac/
1398
1399 Feedback
1400 ========
1401
1402 * Microblogging messages to http://identi.ca/evan are very welcome.
1403 * Laconica's Trac server has a bug tracker for any defects you may find,
1404   or ideas for making things better. http://laconi.ca/trac/
1405 * e-mail to evan@identi.ca will usually be read and responded to very
1406   quickly, unless the question is really hard.
1407
1408 Credits
1409 =======
1410
1411 The following is an incomplete list of developers who've worked on
1412 Laconi.ca. Apologies for any oversight; please let evan@identi.ca know
1413 if anyone's been overlooked in error.
1414
1415 * Evan Prodromou, founder and lead developer, Control Yourself, Inc.
1416 * Zach Copley, Control Yourself, Inc.
1417 * Earle Martin, Control Yourself, Inc.
1418 * Marie-Claude Doyon, designer, Control Yourself, Inc.
1419 * Sarven Capadisli, Control Yourself, Inc.
1420 * Robin Millette, Control Yourself, Inc.
1421 * Ciaran Gultnieks
1422 * Michael Landers
1423 * Ori Avtalion
1424 * Garret Buell
1425 * Mike Cochrane
1426 * Matthew Gregg
1427 * Florian Biree
1428 * Erik Stambaugh
1429 * 'drry'
1430 * Gina Haeussge
1431 * Tryggvi Björgvinsson
1432 * Adrian Lang
1433 * Ori Avtalion
1434 * Meitar Moscovitz
1435 * Ken Sheppardson (Trac server, man-about-town)
1436 * Tiago 'gouki' Faria (i18n manager)
1437 * Sean Murphy
1438 * Leslie Michael Orchard
1439 * Eric Helgeson
1440 * Ken Sedgwick
1441 * Brian Hendrickson
1442 * Tobias Diekershoff
1443 * Dan Moore
1444 * Fil
1445 * Jeff Mitchell
1446 * Brenda Wallace
1447 * Jeffery To
1448 * Federico Marani
1449
1450 Thanks also to the developers of our upstream library code and to the
1451 thousands of people who have tried out Identi.ca, installed Laconi.ca,
1452 told their friends, and built the Open Microblogging network to what
1453 it is today.