]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - README
Merge branch '0.8.x' of git://gitorious.org/laconica/dev into 0.8.x
[quix0rs-gnu-social.git] / README
1 ------
2 README
3 ------
4
5 Laconica 0.7.3 ("You Are The Everything")
6 7 April 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 minor bug-fix and feature release since version 0.7.2.1,
75 released Mar 11 2009. Notable changes this version:
76
77 - A plugin to allow a templating language for customization
78 - A plugin for Piwik Analytics engine
79 - A bookmarklet for posting a notice about a Web page you're reading
80 - A welcome notice ('welcomebot') and default subscription for new users
81 - Support for SSL for some or all pages on the site
82 - Better handling of empty notice lists on many pages
83 - Major improvements to the Twitter friend-sync offline processing
84 - subscribers, subscriptions, groups are listed on the Personal page.
85 - "Invite" link restored to main menu
86 - Better memory handling in FOAF output
87 - Fix for SUP support (FriendFeed)
88 - Correct and intelligent redirect HTTP status codes
89 - Fix DB collations for search and sort
90 - Better H1s and Titles using user full names
91 - Fixes to make the linkback plugin operational
92 - Better indication that a notice is being published by Ajax (spinner)
93 - Better and unified Atom output
94 - Hiding "register" and "join now" messages when site is closed
95 - ping, twitter and facebook queuehandlers working better
96 - Updated RPM spec
97
98 Prerequisites
99 =============
100
101 The following software packages are *required* for this software to
102 run correctly.
103
104 - PHP 5.2.x. It may be possible to run this software on earlier
105   versions of PHP, but many of the functions used are only available
106   in PHP 5.2 or above.
107 - MySQL 5.x. The Laconica database is stored, by default, in a MySQL
108   server. It has been primarily tested on 5.x servers, although it may
109   be possible to install on earlier (or later!) versions. The server
110   *must* support the MyISAM storage engine -- the default for most
111   MySQL servers -- *and* the InnoDB storage engine.
112 - A Web server. Preferably, you should have Apache 2.2.x with the
113   mod_rewrite extension installed and enabled.
114
115 Your PHP installation must include the following PHP extensions:
116
117 - Curl. This is for fetching files by HTTP.
118 - XMLWriter. This is for formatting XML and HTML output.
119 - MySQL. For accessing the database.
120 - GD. For scaling down avatar images.
121 - mbstring. For handling Unicode (UTF-8) encoded strings.
122 - gettext. For multiple languages. Default on many PHP installs.
123
124 For some functionality, you will also need the following extensions:
125
126 - Memcache. A client for the memcached server, which caches database
127   information in volatile memory. This is important for adequate
128   performance on high-traffic sites. You will also need a memcached
129   server to store the data in.
130 - Mailparse. Efficient parsing of email requires this extension.
131   Submission by email or SMS-over-email uses this extension.
132 - Sphinx Search. A client for the sphinx server, an alternative
133   to MySQL or Postgresql fulltext search. You will also need a
134   Sphinx server to serve the search queries.
135
136 You will almost definitely get 2-3 times better performance from your
137 site if you install a PHP bytecode cache/accelerator. Some well-known
138 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
139 is a proprietary accelerator installed on some hosting sites.
140
141 External libraries
142 ------------------
143
144 A number of external PHP libraries are used to provide basic
145 functionality and optional functionality for your system. For your
146 convenience, they are available in the "extlib" directory of this
147 package, and you do not have to download and install them. However,
148 you may want to keep them up-to-date with the latest upstream version,
149 and the URLs are listed here for your convenience.
150
151 - DB_DataObject http://pear.php.net/package/DB_DataObject
152 - Validate http://pear.php.net/package/Validate
153 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
154   to use the openidenabled.com version since it's more widely
155   implemented, and seems to be better supported.
156   http://openidenabled.com/php-openid/
157 - PEAR DB. Although this is an older data access system (new
158   packages should probably use PHP DBO), the OpenID libraries
159   depend on PEAR DB so we use it here, too. DB_DataObject can
160   also use PEAR MDB2, which may give you better performance
161   but won't work with OpenID.
162   http://pear.php.net/package/DB
163 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
164 - markdown.php from http://michelf.com/projects/php-markdown/
165 - PEAR Mail, for sending out mail notifications
166   http://pear.php.net/package/Mail
167 - PEAR Net_SMTP, if you use the SMTP factory for notifications
168   http://pear.php.net/package/Net_SMTP
169 - PEAR Net_Socket, if you use the SMTP factory for notifications
170   http://pear.php.net/package/Net_Socket
171 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
172   library available for PHP. http://xmpphp.googlecode.com/. Note that
173   as of this writing the version of this library that is available in
174   the extlib directory is *significantly different* from the upstream
175   version (patches have been submitted). Upgrading to the upstream
176   version may render your Laconica site unable to send or receive XMPP
177   messages.
178 - Facebook library. Used for the Facebook application.
179 - PEAR Services_oEmbed. Used for some multimedia integration.
180 - PEAR HTTP_Request is an oEmbed dependency.
181 - PEAR Validat is an oEmbed dependency.e
182 - PEAR Net_URL is an oEmbed dependency.2
183
184 A design goal of Laconica is that the basic Web functionality should
185 work on even the most restrictive commercial hosting services.
186 However, additional functionality, such as receiving messages by
187 Jabber/GTalk, require that you be able to run long-running processes
188 on your account. In addition, posting by email or from SMS require
189 that you be able to install a mail filter in your mail server.
190
191 Installation
192 ============
193
194 Installing the basic Laconica Web component is relatively easy,
195 especially if you've previously installed PHP/MySQL packages.
196
197 1. Unpack the tarball you downloaded on your Web server. Usually a
198    command like this will work:
199
200            tar zxf laconica-0.7.3.tar.gz
201
202    ...which will make a laconica-0.7.3 subdirectory in your current
203    directory. (If you don't have shell access on your Web server, you
204    may have to unpack the tarball on your local computer and FTP the
205    files to the server.)
206
207 2. Move the tarball to a directory of your choosing in your Web root
208    directory. Usually something like this will work:
209
210            mv laconica-0.7.3 /var/www/mublog
211
212    This will make your Laconica instance available in the mublog path of
213    your server, like "http://example.net/mublog". "microblog" or
214    "laconica" might also be good path names. If you know how to
215    configure virtual hosts on your web server, you can try setting up
216    "http://micro.example.net/" or the like.
217
218 3. Make your target directory writeable by the Web server.
219
220           chmod a+w /var/www/mublog/
221
222    On some systems, this will probably work:
223
224            chgrp www-data /var/www/mublog/
225            chmod g+w /var/www/mublog/
226
227    If your Web server runs as another user besides "www-data", try
228    that user's default group instead. As a last resort, you can create
229    a new group like "mublog" and add the Web server's user to the group.
230
231 4. You should also take this moment to make your avatar subdirectory
232    writeable by the Web server. An insecure way to do this is:
233
234           chmod a+w /var/www/mublog/avatar
235
236    You can also make the avatar directory writeable by the Web server
237    group, as noted above.
238
239 5. Create a database to hold your microblog data. Something like this
240    should work:
241
242           mysqladmin -u "username" --password="password" create laconica
243
244    Note that Laconica must have its own database; you can't share the
245    database with another program. You can name it whatever you want,
246    though.
247
248    (If you don't have shell access to your server, you may need to use
249    a tool like PHPAdmin to create a database. Check your hosting
250    service's documentation for how to create a new MySQL database.)
251
252 6. Create a new database account that Laconica will use to access the
253    database. If you have shell access, this will probably work from the
254    MySQL shell:
255
256           GRANT ALL on laconica.*
257           TO 'lacuser'@'localhost'
258           IDENTIFIED BY 'lacpassword';
259
260    You should change 'lacuser' and 'lacpassword' to your preferred new
261    username and password. You may want to test logging in to MySQL as
262    this new user.
263
264 7. In a browser, navigate to the Laconica install script; something like:
265
266            http://yourserver.example.com/mublog/install.php
267
268    Enter the database connection information and your site name. The
269    install program will configure your site and install the initial,
270    almost-empty database.
271
272 8. You should now be able to navigate to your microblog's main directory
273    and see the "Public Timeline", which will be empty. If not, magic
274    has happened! You can now register a new user, post some notices,
275    edit your profile, etc. However, you may want to wait to do that stuff
276    if you think you can set up "fancy URLs" (see below), since some
277    URLs are stored in the database.
278
279 Fancy URLs
280 ----------
281
282 By default, Laconica will use URLs that include the main PHP program's
283 name in them. For example, a user's home profile might be
284 found at:
285
286     http://example.org/mublog/index.php/mublog/fred
287
288 On certain systems that don't support this kind of syntax, they'll
289 look like this:
290
291     http://example.org/mublog/index.php?p=mublog/fred
292
293 It's possible to configure the software so it looks like this instead:
294
295     http://example.org/mublog/fred
296
297 These "fancy URLs" are more readable and memorable for users. To use
298 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
299 mod_redirect enabled, -OR- know how to configure "url redirection" in
300 your server.
301
302 1. Copy the htaccess.sample file to .htaccess in your Laconica
303    directory. Note: if you have control of your server's httpd.conf or
304    similar configuration files, it can greatly improve performance to
305    import the .htaccess file into your conf file instead. If you're
306    not sure how to do it, you may save yourself a lot of headache by
307    just leaving the .htaccess file.
308
309 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
310    to your Laconica installation on your server. Typically this will
311    be the path to your Laconica directory relative to your Web root.
312
313 3. Add or uncomment or change a line in your config.php file so it says:
314
315        $config['site']['fancy'] = true;
316
317 You should now be able to navigate to a "fancy" URL on your server,
318 like:
319
320      http://example.net/mublog/main/register
321
322 If you changed your HTTP server configuration, you may need to restart
323 the server first.
324
325 Sphinx
326 ------
327
328 To use a Sphinx server to search users and notices, you also need
329 to install, compile and enable the sphinx pecl extension for php on the
330 client side, which itself depends on the sphinx development files.
331 "pecl install sphinx" should take care of that. Add "extension=sphinx.so"
332 to your php.ini and reload apache to enable it.
333
334 You can update your MySQL or Postgresql databases to drop their fulltext
335 search indexes, since they're now provided by sphinx.
336
337 On the sphinx server side, a script reads the main database and build
338 the keyword index. A cron job reads the database and keeps the sphinx
339 indexes up to date. scripts/sphinx-cron.sh should be called by cron
340 every 5 minutes, for example. scripts/sphinx.sh is an init.d script
341 to start and stop the sphinx search daemon.
342
343 SMS
344 ---
345
346 Laconica supports a cheap-and-dirty system for sending update messages
347 to mobile phones and for receiving updates from the mobile. Instead of
348 sending through the SMS network itself, which is costly and requires
349 buy-in from the wireless carriers, it simply piggybacks on the email
350 gateways that many carriers provide to their customers. So, SMS
351 configuration is essentially email configuration.
352
353 Each user sends to a made-up email address, which they keep a secret.
354 Incoming email that is "From" the user's SMS email address, and "To"
355 the users' secret email address on the site's domain, will be
356 converted to a notice and stored in the DB.
357
358 For this to work, there *must* be a domain or sub-domain for which all
359 (or most) incoming email can pass through the incoming mail filter.
360
361 1. Run the SQL script carrier.sql in your Laconica database. This will
362    usually work:
363
364            mysql -u "lacuser" --password="lacpassword" laconica < db/carrier.sql
365
366    This will populate your database with a list of wireless carriers
367    that support email SMS gateways.
368
369 2. Make sure the maildaemon.php file is executable:
370
371         chmod +x scripts/maildaemon.php
372
373    Note that "daemon" is kind of a misnomer here; the script is more
374    of a filter than a daemon.
375
376 2. Edit /etc/aliases on your mail server and add the following line:
377
378       *: /path/to/laconica/scripts/maildaemon.php
379
380 3. Run whatever code you need to to update your aliases database. For
381    many mail servers (Postfix, Exim, Sendmail), this should work:
382
383       newaliases
384
385    You may need to restart your mail server for the new database to
386    take effect.
387
388 4. Set the following in your config.php file:
389
390    $config['mail']['domain'] = 'yourdomain.example.net';
391
392 At this point, post-by-email and post-by-SMS-gateway should work. Note
393 that if your mail server is on a different computer from your email
394 server, you'll need to have a full installation of Laconica, a working
395 config.php, and access to the Laconica database from the mail server.
396
397 XMPP
398 ----
399
400 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
401 instant-messenger protocol that drives Jabber and GTalk IM. You can
402 distribute messages via XMPP using the system below; however, you
403 need to run the XMPP incoming daemon to allow incoming messages as
404 well.
405
406 1. You may want to strongly consider setting up your own XMPP server.
407    Ejabberd, OpenFire, and JabberD are all Open Source servers.
408    Jabber, Inc. provides a high-performance commercial server.
409
410 2. You must register a Jabber ID (JID) with your new server. It helps
411    to choose a name like "update@example.com" or "notice" or something
412    similar.  Alternately, your "update JID" can be registered on a
413    publicly-available XMPP service, like jabber.org or GTalk.
414
415    Laconica will not register the JID with your chosen XMPP server;
416    you need to do this manually, with an XMPP client like Gajim,
417    Telepathy, or Pidgin.im.
418
419 3. Configure your site's XMPP variables, as described below in the
420    configuration section.
421
422 On a default installation, your site can broadcast messages using
423 XMPP. Users won't be able to post messages using XMPP unless you've
424 got the XMPP daemon running.  See 'Queues and daemons' below for how
425 to set that up. Also, once you have a sizable number of users, sending
426 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
427 can really slow down your site; it may cause posting to timeout.
428
429 NOTE: stream_select(), a crucial function for network programming, is
430 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
431 work around this bug in Laconica; current recommendation is to move
432 off of amd64 to another server.
433
434 Public feed
435 -----------
436
437 You can send *all* messages from your microblogging site to a
438 third-party service using XMPP. This can be useful for providing
439 search, indexing, bridging, or other cool services.
440
441 To configure a downstream site to receive your public stream, add
442 their "JID" (Jabber ID) to your config.php as follows:
443
444       $config['xmpp']['public'][] = 'downstream@example.net';
445
446 (Don't miss those square brackets at the end.) Note that your XMPP
447 broadcasting must be configured as mentioned above. Although you can
448 send out messages at "Web time", high-volume sites should strongly
449 consider setting up queues and daemons.
450
451 Queues and daemons
452 ------------------
453
454 Some activities that Laconica needs to do, like broadcast OMB, SMS,
455 and XMPP messages, can be 'queued' and done by off-line bots instead.
456 For this to work, you must be able to run long-running offline
457 processes, either on your main Web server or on another server you
458 control. (Your other server will still need all the above
459 prerequisites, with the exception of Apache.) Installing on a separate
460 server is probably a good idea for high-volume sites.
461
462 1. You'll need the "CLI" (command-line interface) version of PHP
463    installed on whatever server you use.
464
465 2. If you're using a separate server for queues, install Laconica
466    somewhere on the server. You don't need to worry about the
467    .htaccess file, but make sure that your config.php file is close
468    to, or identical to, your Web server's version.
469
470 3. In your config.php files (both the Web server and the queues
471    server!), set the following variable:
472
473    $config['queue']['enabled'] = true;
474
475    You may also want to look at the 'daemon' section of this file for
476    more daemon options. Note that if you set the 'user' and/or 'group'
477    options, you'll need to create that user and/or group by hand.
478    They're not created automatically.
479
480 4. On the queues server, run the command scripts/startdaemons.sh. It
481    needs as a parameter the install path; if you run it from the
482    Laconica dir, "." should suffice.
483
484 This will run eight (for now) queue handlers:
485
486 * xmppdaemon.php - listens for new XMPP messages from users and stores
487   them as notices in the database.
488 * jabberqueuehandler.php - sends queued notices in the database to
489   registered users who should receive them.
490 * publicqueuehandler.php - sends queued notices in the database to
491   public feed listeners.
492 * ombqueuehandler.php - sends queued notices to OpenMicroBlogging
493   recipients on foreign servers.
494 * smsqueuehandler.php - sends queued notices to SMS-over-email addresses
495   of registered users.
496 * xmppconfirmhandler.php - sends confirmation messages to registered
497   users.
498 * twitterqueuehandler.php - sends queued notices to Twitter for user
499   who have opted to set up Twitter bridging.
500 * facebookqueuehandler.php - sends queued notices to Facebook for users
501   of the built-in Facebook application.
502
503 Note that these queue daemons are pretty raw, and need your care. In
504 particular, they leak memory, and you may want to restart them on a
505 regular (daily or so) basis with a cron job. Also, if they lose
506 the connection to the XMPP server for too long, they'll simply die. It
507 may be a good idea to use a daemon-monitoring service, like 'monit',
508 to check their status and keep them running.
509
510 All the daemons write their process IDs (pids) to /var/run/ by
511 default. This can be useful for starting, stopping, and monitoring the
512 daemons.
513
514 Twitter Friends Syncing
515 -----------------------
516
517 As of Laconica 0.6.3, users may set a flag in their settings ("Subscribe
518 to my Twitter friends here" under the Twitter tab) to have Laconica
519 attempt to locate and subscribe to "friends" (people they "follow") on
520 Twitter who also have accounts on your Laconica system, and who have
521 previously set up a link for automatically posting notices to Twitter.
522
523 Optionally, there is a script (./scripts/synctwitterfriends.php), meant
524 to be run periodically from a job scheduler (e.g.: cron under Unix), to
525 look for new additions to users' friends lists. Note that the friends
526 syncing only subscribes users to each other, it does not unsubscribe
527 users when they stop following each other on Twitter.
528
529 Sample cron job:
530
531 # Update Twitter friends subscriptions every half hour
532 0,30 * * * * /path/to/php /path/to/laconica/scripts/synctwitterfriends.php>&/dev/null
533
534 Built-in Facebook Application
535 -----------------------------
536
537 Laconica's Facebook application allows your users to automatically
538 update their Facebook statuses with their latest notices, invite
539 their friends to use the app (and thus your site), view their notice
540 timelines, and post notices -- all from within Facebook. The application
541 is built into Laconica and runs on your host.  For automatic Facebook
542 status updating to work you will need to enable queuing and run the
543 facebookqueuehandler.php daemon (see the "Queues and daemons" section
544 above).
545
546 Quick setup instructions*:
547
548 Install the Facebook Developer application on Facebook:
549
550     http://www.facebook.com/developers/
551
552 Use it to create a new application and generate an API key and secret.
553 Uncomment the Facebook app section of your config.php and copy in the
554 key and secret, e.g.:
555
556     # Config section for the built-in Facebook application
557     $config['facebook']['apikey'] = 'APIKEY';
558     $config['facebook']['secret'] = 'SECRET';
559
560 In Facebook's application editor, specify the following URLs for your app:
561
562 - Callback URL: http://example.net/mublog/facebook/
563 - Post-Remove URL: http://example.net/mublog/facebook/remove
564 - Post-Add Redirect URL: http://apps.facebook.com/yourapp/
565 - Canvas URL: http://apps.facebook.com/yourapp/
566
567 (Replace 'example.net' with your host's URL, 'mublog' with the path
568 to your Laconica installation, and 'yourapp' with the name of the
569 Facebook application you created.)
570
571 Additionally, Choose "Web" for Application type in the Advanced tab.
572 In the "Canvas setting" section, choose the "FBML" for Render Method,
573 "Smart Size" for IFrame size, and "Full width (760px)" for Canvas Width.
574 Everything else can be left with default values.
575
576 *For more detailed instructions please see the installation guide on the
577 Laconica wiki:
578
579     http://laconi.ca/trac/wiki/FacebookApplication
580
581 Sitemaps
582 --------
583
584 Sitemap files <http://sitemaps.org/> are a very nice way of telling
585 search engines and other interested bots what's available on your site
586 and what's changed recently. You can generate sitemap files for your
587 Laconica instance.
588
589 1. Choose your sitemap URL layout. Laconica creates a number of
590    sitemap XML files for different parts of your site. You may want to
591    put these in a sub-directory of your Laconica directory to avoid
592    clutter. The sitemap index file tells the search engines and other
593    bots where to find all the sitemap files; it *must* be in the main
594    installation directory or higher. Both types of file must be
595    available through HTTP.
596
597 2. To generate your sitemaps, run the following command on your server:
598
599    php scripts/sitemap.php -f index-file-path -d sitemap-directory -u URL-prefix-for-sitemaps
600
601    Here, index-file-path is the full path to the sitemap index file,
602    like './sitemapindex.xml'. sitemap-directory is the directory where
603    you want the sitemaps stored, like './sitemaps/' (make sure the dir
604    exists). URL-prefix-for-sitemaps is the full URL for the sitemap dir,
605    typically something like <http://example.net/mublog/sitemaps/>.
606
607 You can use several methods for submitting your sitemap index to
608 search engines to get your site indexed. One is to add a line like the
609 following to your robots.txt file:
610
611    Sitemap: /mublog/sitemapindex.xml
612
613 This is a good idea for letting *all* Web spiders know about your
614 sitemap. You can also submit sitemap files to major search engines
615 using their respective "Webmaster centres"; see sitemaps.org for links
616 to these resources.
617
618 Themes
619 ------
620
621 There are two themes shipped with this version of Laconica: "identica",
622 which is what the Identi.ca site uses, and "default", which is a good
623 basis for other sites.
624
625 As of right now, your ability to change the theme is site-wide; users
626 can't choose their own theme. Additionally, the only thing you can
627 change in the theme is CSS stylesheets and some image files; you can't
628 change the HTML output, like adding or removing menu items.
629
630 You can choose a theme using the $config['site']['theme'] element in
631 the config.php file. See below for details.
632
633 You can add your own theme by making a sub-directory of the 'theme'
634 subdirectory with the name of your theme. Each theme can have the
635 following files:
636
637 display.css: a CSS2 file for "default" styling for all browsers.
638 ie6.css: a CSS2 file for override styling for fixing up Internet
639          Explorer 6.
640 ie7.css: a CSS2 file for override styling for fixing up Internet
641          Explorer 7.
642 logo.png: a logo image for the site.
643 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
644                             users who don't upload their own.
645 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
646 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
647                          listing on profile pages.
648
649 You may want to start by copying the files from the default theme to
650 your own directory.
651
652 NOTE: the HTML generated by Laconica changed *radically* between
653 version 0.6.x and 0.7.x. Older themes will need signification
654 modification to use the new output format.
655
656 Translation
657 -----------
658
659 Translations in Laconica use the gettext system <http://www.gnu.org/software/gettext/>.
660 Theoretically, you can add your own sub-directory to the locale/
661 subdirectory to add a new language to your system. You'll need to
662 compile the ".po" files into ".mo" files, however.
663
664 Contributions of translation information to Laconica are very easy:
665 you can use the Web interface at http://laconi.ca/pootle/ to add one
666 or a few or lots of new translations -- or even new languages. You can
667 also download more up-to-date .po files there, if you so desire.
668
669 Backups
670 -------
671
672 There is no built-in system for doing backups in Laconica. You can make
673 backups of a working Laconica system by backing up the database and
674 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
675 and to backup the Web directory, try tar.
676
677 Private
678 -------
679
680 The administrator can set the "private" flag for a site so that it's
681 not visible to non-logged-in users. This might be useful for
682 workgroups who want to share a microblogging site for project
683 management, but host it on a public server.
684
685 Note that this is an experimental feature; total privacy is not
686 guaranteed or ensured. Also, privacy is all-or-nothing for a site; you
687 can't have some accounts or notices private, and others public.
688 Finally, the interaction of private sites with OpenMicroBlogging is
689 undefined. Remote users won't be able to subscribe to users on a
690 private site, but users of the private site may be able to subscribe
691 to users on a remote site. (Or not... it's not well tested.) The
692 "proper behaviour" hasn't been defined here, so handle with care.
693
694 Upgrading
695 =========
696
697 If you've been using Laconica 0.6, 0.5 or lower, or if you've been
698 tracking the "git" version of the software, you will probably want
699 to upgrade and keep your existing data. There is no automated upgrade
700 procedure in Laconica 0.7.3. Try these step-by-step instructions; read
701 to the end first before trying them.
702
703 0. Download Laconica and set up all the prerequisites as if you were
704    doing a new install.
705 1. Make backups of both your database and your Web directory. UNDER NO
706    CIRCUMSTANCES should you try to do an upgrade without a known-good
707    backup. You have been warned.
708 2. Shut down Web access to your site, either by turning off your Web
709    server or by redirecting all pages to a "sorry, under maintenance"
710    page.
711 3. Shut down XMPP access to your site, typically by shutting down the
712    xmppdaemon.php process and all other daemons that you're running.
713    If you've got "monit" or "cron" automatically restarting your
714    daemons, make sure to turn that off, too.
715 4. Shut down SMS and email access to your site. The easy way to do
716    this is to comment out the line piping incoming email to your
717    maildaemon.php file, and running something like "newaliases".
718 5. Once all writing processes to your site are turned off, make a
719    final backup of the Web directory and database.
720 6. Move your Laconica directory to a backup spot, like "mublog.bak".
721 7. Unpack your Laconica 0.6 tarball and move it to "mublog" or
722    wherever your code used to be.
723 8. Copy the config.php file and avatar directory from your old
724    directory to your new directory.
725 9. Copy htaccess.sample to .htaccess in the new directory. Change the
726    RewriteBase to use the correct path.
727 10. Rebuild the database. For MySQL, go to your Laconica directory and
728     run the rebuilddb.sh script like this:
729
730     ./scripts/rebuilddb.sh rootuser rootpassword database db/laconica.sql
731
732     Here, rootuser and rootpassword are the username and password for a
733     user who can drop and create databases as well as tables; typically
734     that's _not_ the user Laconica runs as.
735     For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
736     which operates slightly differently. Read the documentation in that
737     script before running it.
738 11. Use mysql or psql client to log into your database and make sure that
739     the notice, user, profile, subscription etc. tables are non-empty.
740 12. Turn back on the Web server, and check that things still work.
741 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
742     bots have changed since version 0.5; see above for details.
743
744 If you're upgrading from very old versions, you may want to look at
745 the fixup_* scripts in the scripts directories. These will store some
746 precooked data in the DB. All upgraders should check out the inboxes
747 options below.
748
749 NOTE: the database definition file, stoica.ini, has been renamed to
750 laconica.ini (since this is the recommended database name). If you
751 have a line in your config.php pointing to the old name, you'll need
752 to update it.
753
754 Notice inboxes
755 --------------
756
757 Before version 0.6.2, the page showing all notices from people the
758 user is subscribed to ("so-and-so with friends") was calculated at run
759 time. Starting with 0.6.2, we have a new data structure for holding a
760 user's "notice inbox". (Note: distinct from the "message inbox", which
761 is the "inbox" tab in the UI. The notice inbox appears under the
762 "Personal" tab.)
763
764 Notices are added to the inbox when they're created. This speeds up
765 the query considerably, and also allows us the opportunity, in the
766 future, to add different kind of notices to an inbox -- like @-replies
767 or subscriptions to search terms or hashtags.
768
769 Notice inboxes are enabled by default for new installations. If you
770 are upgrading an existing site, this means that your users will see
771 empty "Personal" pages. The following steps will help you fix the
772 problem.
773
774 0. $config['inboxes']['enabled'] can be set to one of three values. If
775    you set it to 'false', the site will work as before. Support for this
776    will probably be dropped in future versions.
777 1. Setting the flag to 'transitional' means that you're in transition.
778    In this mode, the code will run the "new query" or the "old query"
779    based on whether the user's inbox has been updated.
780 2. After setting the flag to "transitional", you can run the
781    fixup_inboxes.php script to create the inboxes. You may want to set
782    the memory limit high. You can re-run it without ill effect.
783 3. When fixup_inboxes is finished, you can set the enabled flag to
784    'true'.
785
786 Configuration options
787 =====================
788
789 The sole configuration file for Laconica (excepting configurations for
790 dependency software) is config.php in your Laconica directory. If you
791 edit any other file in the directory, like lib/common.php (where most
792 of the defaults are defined), you will lose your configuration options
793 in any upgrade, and you will wish that you had been more careful.
794
795 Starting with version 0.7.1, you can put config files in the
796 /etc/laconica/ directory on your server, if it exists. Config files
797 will be included in this order:
798
799 * /etc/laconica/laconica.php - server-wide config
800 * /etc/laconica/<servername>.php - for a virtual host
801 * /etc/laconica/<servername>_<pathname>.php - for a path
802 * INSTALLDIR/config.php - for a particular implementation
803
804 Almost all configuration options are made through a two-dimensional
805 associative array, cleverly named $config. A typical configuration
806 line will be:
807
808      $config['section']['option'] = value;
809
810 For brevity, the following documentation describes each section and
811 option.
812
813 site
814 ----
815
816 This section is a catch-all for site-wide variables.
817
818 name: the name of your site, like 'YourCompany Microblog'.
819 server: the server part of your site's URLs, like 'example.net'.
820 path: The path part of your site's URLs, like 'mublog' or ''
821       (installed in root).
822 fancy: whether or not your site uses fancy URLs (see Fancy URLs
823        section above). Default is false.
824 logfile: full path to a file for Laconica to save logging
825          information to. You may want to use this if you don't have
826          access to syslog.
827 locale_path: full path to the directory for locale data. Unless you
828              store all your locale data in one place, you probably
829              don't need to use this.
830 language: default language for your site. Defaults to US English.
831 languages: A list of languages supported on your site. Typically you'd
832            only change this if you wanted to disable support for one
833            or another language:
834            "unset($config['site']['languages']['de'])" will disable
835            support for German.
836 theme: Theme for your site (see Theme section). Two themes are
837        provided by default: 'default' and 'stoica' (the one used by
838        Identi.ca). It's appreciated if you don't use the 'stoica' theme
839        except as the basis for your own.
840 email: contact email address for your site. By default, it's extracted
841        from your Web server environment; you may want to customize it.
842 broughtbyurl: name of an organization or individual who provides the
843            service. Each page will include a link to this name in the
844            footer. A good way to link to the blog, forum, wiki,
845            corporate portal, or whoever is making the service available.
846 broughtby: text used for the "brought by" link.
847 timezone: default timezone for message display. Users can set their
848           own time zone. Defaults to 'UTC', which is a pretty good default.
849 closed: If set to 'true', will disallow registration on your site.
850         This is a cheap way to restrict accounts to only one
851         individual or group; just register the accounts you want on
852         the service, *then* set this variable to 'true'.
853 inviteonly: If set to 'true', will only allow registration if the user
854             was invited by an existing user.
855 private: If set to 'true', anonymous users will be redirected to the
856          'login' page. Also, API methods that normally require no
857          authentication will require it. Note that this does not turn
858          off registration; use 'closed' or 'inviteonly' for the
859          behaviour you want.
860 notice: A plain string that will appear on every page. A good place
861         to put introductory information about your service, or info about
862         upgrades and outages, or other community info. Any HTML will
863         be escaped.
864 dupelimit: Time in which it's not OK for the same person to post the
865            same notice; default = 60 seconds.
866 logo: URL of an image file to use as the logo for the site. Overrides
867       the logo in the theme, if any.
868 ssl: Whether to use SSL and https:// URLs for some or all pages.
869      Possible values are 'always' (use it for all pages), 'never'
870      (don't use it for any pages), or 'sometimes' (use it for
871      sensitive pages that include passwords like login and registration,
872      but not for regular pages). Default to 'never'.
873 sslserver: use an alternate server name for SSL URLs, like
874            'secure.example.org'. You should be careful to set cookie
875            parameters correctly so that both the SSL server and the
876            "normal" server can access the session cookie and
877            preferably other cookies as well.
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 Laconica 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 'laconica', you'll need
892                 to set this to point to the location of the
893                 laconica.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
914 syslog
915 ------
916
917 By default, Laconica sites log error messages to the syslog facility.
918 (You can override this using the 'logfile' parameter described above).
919
920 appname: The name that Laconica uses to log messages. By default it's
921          "laconica", but if you have more than one installation on the
922          server, you may want to change the name for each instance so
923          you can track log messages more easily.
924
925 queue
926 -----
927
928 You can configure the software to queue time-consuming tasks, like
929 sending out SMS email or XMPP messages, for off-line processing. See
930 'Queues and daemons' above for how to set this up.
931
932 enabled: Whether to uses queues. Defaults to false.
933
934 license
935 -------
936
937 The default license to use for your users notices. The default is the
938 Creative Commons Attribution 3.0 license, which is probably the right
939 choice for any public site. Note that some other servers will not
940 accept notices if you apply a stricter license than this.
941
942 url: URL of the license, used for links.
943 title: Title for the license, like 'Creative Commons Attribution 3.0'.
944 image: A button shown on each page for the license.
945
946 mail
947 ----
948
949 This is for configuring out-going email. We use PEAR's Mail module,
950 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
951
952 backend: the backend to use for mail, one of 'mail', 'sendmail', and
953          'smtp'. Defaults to PEAR's default, 'mail'.
954 params: if the mail backend requires any parameters, you can provide
955         them in an associative array.
956
957 nickname
958 --------
959
960 This is for configuring nicknames in the service.
961
962 blacklist: an array of strings for usernames that may not be
963            registered. A default array exists for strings that are
964            used by Laconica (e.g. 'doc', 'main', 'avatar', 'theme')
965            but you may want to add others if you have other software
966            installed in a subdirectory of Laconica or if you just
967            don't want certain words used as usernames.
968 featured: an array of nicknames of 'featured' users of the site.
969           Can be useful to draw attention to well-known users, or
970           interesting people, or whatever.
971
972 avatar
973 ------
974
975 For configuring avatar access.
976
977 server: If set, defines another server where avatars are stored in the
978         root directory. Note that the 'avatar' subdir still has to be
979         writeable. You'd typically use this to split HTTP requests on
980         the client to speed up page loading, either with another
981         virtual server or with an NFS or SAMBA share. Clients
982         typically only make 2 connections to a single server at a
983         time <http://ur1.ca/6ih>, so this can parallelize the job.
984         Defaults to null.
985
986 public
987 ------
988
989 For configuring the public stream.
990
991 localonly: If set to true, only messages posted by users of this
992            service (rather than other services, filtered through OMB)
993            are shown in the public stream. Default true.
994 blacklist: An array of IDs of users to hide from the public stream.
995            Useful if you have someone making excessive Twitterfeed posts
996            to the site, other kinds of automated posts, testing bots, etc.
997
998 theme
999 -----
1000
1001 server: Like avatars, you can speed up page loading by pointing the
1002         theme file lookup to another server (virtual or real). The
1003         theme server's root path should map to the Laconica "theme"
1004         subdirectory. Defaults to NULL.
1005
1006 xmpp
1007 ----
1008
1009 For configuring the XMPP sub-system.
1010
1011 enabled: Whether to accept and send messages by XMPP. Default false.
1012 server: server part of XMPP ID for update user.
1013 port: connection port for clients. Default 5222, which you probably
1014       shouldn't need to change.
1015 user: username for the client connection. Users will receive messages
1016       from 'user'@'server'.
1017 resource: a unique identifier for the connection to the server. This
1018           is actually used as a prefix for each XMPP component in the system.
1019 password: password for the user account.
1020 host: some XMPP domains are served by machines with a different
1021       hostname. (For example, @gmail.com GTalk users connect to
1022       talk.google.com). Set this to the correct hostname if that's the
1023       case with your server.
1024 encryption: Whether to encrypt the connection between Laconica and the
1025             XMPP server. Defaults to true, but you can get
1026             considerably better performance turning it off if you're
1027             connecting to a server on the same machine or on a
1028             protected network.
1029 debug: if turned on, this will make the XMPP library blurt out all of
1030        the incoming and outgoing messages as XML stanzas. Use as a
1031        last resort, and never turn it on if you don't have queues
1032        enabled, since it will spit out sensitive data to the browser.
1033 public: an array of JIDs to send _all_ notices to. This is useful for
1034         participating in third-party search and archiving services.
1035
1036 tag
1037 ---
1038
1039 Miscellaneous tagging stuff.
1040
1041 dropoff: Decay factor for tag listing, in seconds.
1042          Defaults to exponential decay over ten days; you can twiddle
1043          with it to try and get better results for your site.
1044
1045 daemon
1046 ------
1047
1048 For daemon processes.
1049
1050 piddir: directory that daemon processes should write their PID file
1051         (process ID) to. Defaults to /var/run/, which is where this
1052         stuff should usually go on Unix-ish systems.
1053 user: If set, the daemons will try to change their effective user ID
1054       to this user before running. Probably a good idea, especially if
1055       you start the daemons as root. Note: user name, like 'daemon',
1056       not 1001.
1057 group: If set, the daemons will try to change their effective group ID
1058        to this named group. Again, a name, not a numerical ID.
1059
1060 memcached
1061 ---------
1062
1063 You can get a significant boost in performance by caching some
1064 database data in memcached <http://www.danga.com/memcached/>.
1065
1066 enabled: Set to true to enable. Default false.
1067 server: a string with the hostname of the memcached server. Can also
1068         be an array of hostnames, if you've got more than one server.
1069
1070 sphinx
1071 ------
1072
1073 You can get a significant boost in performance using Sphinx Search
1074 instead of your database server to search for users and notices.
1075 <http://sphinxsearch.com/>.
1076
1077 enabled: Set to true to enable. Default false.
1078 server: a string with the hostname of the sphinx server.
1079 port: an integer with the port number of the sphinx server.
1080
1081 integration
1082 -----------
1083
1084 A catch-all for integration with other systems.
1085
1086 source: The name to use for the source of posts to Twitter. Defaults
1087         to 'laconica', but if you request your own source name from
1088         Twitter <http://twitter.com/help/request_source>, you can use
1089         that here instead. Status updates on Twitter will then have
1090         links to your site.
1091
1092 inboxes
1093 -------
1094
1095 For notice inboxes.
1096
1097 enabled: A three-valued flag for whether to use notice inboxes (see
1098          upgrading info above for notes about this change). Can be
1099          'false', 'true', or '"transitional"'.
1100
1101 throttle
1102 --------
1103
1104 For notice-posting throttles.
1105
1106 enabled: Whether to throttle posting. Defaults to false.
1107 count: Each user can make this many posts in 'timespan' seconds. So, if count
1108        is 100 and timespan is 3600, then there can be only 100 posts
1109        from a user every hour.
1110 timespan: see 'count'.
1111
1112 profile
1113 -------
1114
1115 Profile management.
1116
1117 banned: an array of usernames and/or profile IDs of 'banned' profiles.
1118         The site will reject any notices by these users -- they will
1119         not be accepted at all. (Compare with blacklisted users above,
1120         whose posts just won't show up in the public stream.)
1121
1122 newuser
1123 -------
1124
1125 Options with new users.
1126
1127 default: nickname of a user account to automatically subscribe new
1128          users to. Typically this would be system account for e.g.
1129          service updates or announcements. Users are able to unsub
1130          if they want. Default is null; no auto subscribe.
1131 welcome: nickname of a user account that sends welcome messages to new
1132          users. Can be the same as 'default' account, although on
1133          busy servers it may be a good idea to keep that one just for
1134          'urgent' messages. Default is null; no message.
1135
1136 If either of these special user accounts are specified, the users should
1137 be created before the configuration is updated.
1138
1139 Troubleshooting
1140 ===============
1141
1142 The primary output for Laconica is syslog, unless you configured a
1143 separate logfile. This is probably the first place to look if you're
1144 getting weird behaviour from Laconica.
1145
1146 If you're tracking the unstable version of Laconica in the git
1147 repository (see below), and you get a compilation error ("unexpected
1148 T_STRING") in the browser, check to see that you don't have any
1149 conflicts in your code.
1150
1151 If you upgraded to Laconica 0.7.3 without reading the "Notice inboxes"
1152 section above, and all your users' 'Personal' tabs are empty, read the
1153 "Notice inboxes" section above.
1154
1155 Myths
1156 =====
1157
1158 These are some myths you may see on the Web about Laconica.
1159 Documentation from the core team about Laconica has been pretty
1160 sparse, so some backtracking and guesswork resulted in some incorrect
1161 assumptions.
1162
1163 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1164   extremely bad idea. It's a tool built into DB_DataObject that will
1165   emit oodles of print lines directly to the browser of your users.
1166   Among these lines will be your database username and password. Do
1167   not enable this option on a production Web site for any reason.
1168
1169 - "Edit dataobject.ini with the following settings..." dataobject.ini
1170   is a development file for the DB_DataObject framework and is not
1171   used by the running software. It was removed from the Laconica
1172   distribution because its presence was confusing. Do not bother
1173   configuring dataobject.ini, and do not put your database username
1174   and password into the file on a production Web server; unscrupulous
1175   persons may try to read it to get your passwords.
1176
1177 Unstable version
1178 ================
1179
1180 If you're adventurous or impatient, you may want to install the
1181 development version of Laconica. To get it, use the git version
1182 control tool <http://git-scm.com/> like so:
1183
1184         git clone http://laconi.ca/software/laconica.git
1185
1186 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1187
1188 Further information
1189 ===================
1190
1191 There are several ways to get more information about Laconica.
1192
1193 * There is a mailing list for Laconica developers and admins at
1194   http://mail.laconi.ca/mailman/listinfo/laconica-dev
1195 * The #laconica IRC channel on freenode.net <http://www.freenode.net/>.
1196 * The Laconica wiki, http://laconi.ca/trac/
1197
1198 Feedback
1199 ========
1200
1201 * Microblogging messages to http://identi.ca/evan are very welcome.
1202 * Laconica's Trac server has a bug tracker for any defects you may find,
1203   or ideas for making things better. http://laconi.ca/trac/
1204 * e-mail to evan@identi.ca will usually be read and responded to very
1205   quickly, unless the question is really hard.
1206
1207 Credits
1208 =======
1209
1210 The following is an incomplete list of developers who've worked on
1211 Laconi.ca. Apologies for any oversight; please let evan@identi.ca know
1212 if anyone's been overlooked in error.
1213
1214 * Evan Prodromou, founder and lead developer, Control Yourself, Inc.
1215 * Zach Copley, Control Yourself, Inc.
1216 * Earle Martin, Control Yourself, Inc.
1217 * Marie-Claude Doyon, designer, Control Yourself, Inc.
1218 * Sarven Capadisli, Control Yourself, Inc.
1219 * Robin Millette, Control Yourself, Inc.
1220 * Ciaran Gultnieks
1221 * Michael Landers
1222 * Ori Avtalion
1223 * Garret Buell
1224 * Mike Cochrane
1225 * Matthew Gregg
1226 * Florian Biree
1227 * Erik Stambaugh
1228 * 'drry'
1229 * Gina Haeussge
1230 * Tryggvi Björgvinsson
1231 * Adrian Lang
1232 * Ori Avtalion
1233 * Meitar Moscovitz
1234 * Ken Sheppardson (Trac server, man-about-town)
1235 * Tiago 'gouki' Faria (i18n managerx)
1236 * Sean Murphy
1237 * Leslie Michael Orchard
1238 * Eric Helgeson
1239 * Ken Sedgwick
1240 * Brian Hendrickson
1241 * Tobias Diekershoff
1242
1243 Thanks also to the developers of our upstream library code and to the
1244 thousands of people who have tried out Identi.ca, installed Laconi.ca,
1245 told their friends, and built the Open Microblogging network to what
1246 it is today.