5 StatusNet 0.8.0 ("Shiny Happy People")
8 This is the README file for StatusNet, the Open Source microblogging
9 platform. It includes installation instructions, descriptions of
10 options you can set, warnings, tips, and general info for
11 administrators. Information on using StatusNet can be found in the
12 "doc" subdirectory or in the "help" section on-line.
17 StatusNet (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.
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.
28 StatusNet 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.
33 StatusNet was originally developed for the Open Software Service,
34 Identi.ca <http://identi.ca/>. It is shared with you in hope that you
35 too make an Open Software Service available to your users. To learn
36 more, please see the Open Software Service Definition 1.1:
38 http://www.opendefinition.org/ossd
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.
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.
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/>.
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 StatusNet 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*.
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
74 This is a major feature release since version 0.7.4, released May 31
75 2009. Notable changes this version:
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
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
93 - New themes. Five new themes are added to the base release; these show
94 off the flexibility of StatusNet's theming system.
95 - Statistics. Public sites will periodically send usage statistics,
96 configuration options, and dependency information to StatusNet 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
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 StatusNet sites.
117 - Better command-line handling for scripts, including standard options
118 and ability to set hostname and path from the command line.
119 - An experimental plugin to use Meteor (http://www.meteorserver.org/)
120 for "real-time" updates.
121 - A new framework for "real-time" updates, making it easier to develop
122 plugins for different browser-based update modes.
123 - RSS 2.0 and Atom feeds for groups.
124 - RSS 2.0 and Atom feeds for tags.
125 - Attachments can be sent by email.
126 - Attachments are encoded as enclosures in RSS 2.0 and Atom.
127 - Notices with attachments display in Facebook as media inline.
129 - Many, many bug fixes.
134 The following software packages are *required* for this software to
137 - PHP 5.2.3+. It may be possible to run this software on earlier
138 versions of PHP, but many of the functions used are only available
140 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
141 server. It has been primarily tested on 5.x servers, although it may
142 be possible to install on earlier (or later!) versions. The server
143 *must* support the MyISAM storage engine -- the default for most
144 MySQL servers -- *and* the InnoDB storage engine.
145 - A Web server. Preferably, you should have Apache 2.2.x with the
146 mod_rewrite extension installed and enabled.
148 Your PHP installation must include the following PHP extensions:
150 - Curl. This is for fetching files by HTTP.
151 - XMLWriter. This is for formatting XML and HTML output.
152 - MySQL. For accessing the database.
153 - GD. For scaling down avatar images.
154 - mbstring. For handling Unicode (UTF-8) encoded strings.
155 - gettext. For multiple languages. Default on many PHP installs.
157 For some functionality, you will also need the following extensions:
159 - Memcache. A client for the memcached server, which caches database
160 information in volatile memory. This is important for adequate
161 performance on high-traffic sites. You will also need a memcached
162 server to store the data in.
163 - Mailparse. Efficient parsing of email requires this extension.
164 Submission by email or SMS-over-email uses this extension.
165 - Sphinx Search. A client for the sphinx server, an alternative
166 to MySQL or Postgresql fulltext search. You will also need a
167 Sphinx server to serve the search queries.
169 You will almost definitely get 2-3 times better performance from your
170 site if you install a PHP bytecode cache/accelerator. Some well-known
171 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
172 is a proprietary accelerator installed on some hosting sites.
177 A number of external PHP libraries are used to provide basic
178 functionality and optional functionality for your system. For your
179 convenience, they are available in the "extlib" directory of this
180 package, and you do not have to download and install them. However,
181 you may want to keep them up-to-date with the latest upstream version,
182 and the URLs are listed here for your convenience.
184 - DB_DataObject http://pear.php.net/package/DB_DataObject
185 - Validate http://pear.php.net/package/Validate
186 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
187 to use the openidenabled.com version since it's more widely
188 implemented, and seems to be better supported.
189 http://openidenabled.com/php-openid/
190 - PEAR DB. Although this is an older data access system (new
191 packages should probably use PHP DBO), the OpenID libraries
192 depend on PEAR DB so we use it here, too. DB_DataObject can
193 also use PEAR MDB2, which may give you better performance
194 but won't work with OpenID.
195 http://pear.php.net/package/DB
196 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
197 - markdown.php from http://michelf.com/projects/php-markdown/
198 - PEAR Mail, for sending out mail notifications
199 http://pear.php.net/package/Mail
200 - PEAR Net_SMTP, if you use the SMTP factory for notifications
201 http://pear.php.net/package/Net_SMTP
202 - PEAR Net_Socket, if you use the SMTP factory for notifications
203 http://pear.php.net/package/Net_Socket
204 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
205 library available for PHP. http://xmpphp.googlecode.com/. Note that
206 as of this writing the version of this library that is available in
207 the extlib directory is *significantly different* from the upstream
208 version (patches have been submitted). Upgrading to the upstream
209 version may render your StatusNet site unable to send or receive XMPP
211 - Facebook library. Used for the Facebook application.
212 - PEAR Services_oEmbed. Used for some multimedia integration.
213 - PEAR HTTP_Request is an oEmbed dependency.
214 - PEAR Validate is an oEmbed dependency.
215 - PEAR Net_URL2 is an oEmbed dependency.
216 - Console_GetOpt for parsing command-line options.
218 A design goal of StatusNet is that the basic Web functionality should
219 work on even the most restrictive commercial hosting services.
220 However, additional functionality, such as receiving messages by
221 Jabber/GTalk, require that you be able to run long-running processes
222 on your account. In addition, posting by email or from SMS require
223 that you be able to install a mail filter in your mail server.
228 Installing the basic StatusNet Web component is relatively easy,
229 especially if you've previously installed PHP/MySQL packages.
231 1. Unpack the tarball you downloaded on your Web server. Usually a
232 command like this will work:
234 tar zxf statusnet-0.8.0.tar.gz
236 ...which will make a statusnet-0.8.0 subdirectory in your current
237 directory. (If you don't have shell access on your Web server, you
238 may have to unpack the tarball on your local computer and FTP the
239 files to the server.)
241 2. Move the tarball to a directory of your choosing in your Web root
242 directory. Usually something like this will work:
244 mv statusnet-0.8.0 /var/www/mublog
246 This will make your StatusNet instance available in the mublog path of
247 your server, like "http://example.net/mublog". "microblog" or
248 "statusnet" might also be good path names. If you know how to
249 configure virtual hosts on your web server, you can try setting up
250 "http://micro.example.net/" or the like.
252 3. Make your target directory writeable by the Web server.
254 chmod a+w /var/www/mublog/
256 On some systems, this will probably work:
258 chgrp www-data /var/www/mublog/
259 chmod g+w /var/www/mublog/
261 If your Web server runs as another user besides "www-data", try
262 that user's default group instead. As a last resort, you can create
263 a new group like "mublog" and add the Web server's user to the group.
265 4. You should also take this moment to make your avatar, background, and
266 file subdirectories writeable by the Web server. An insecure way to do
269 chmod a+w /var/www/mublog/avatar
270 chmod a+w /var/www/mublog/background
271 chmod a+w /var/www/mublog/file
273 You can also make the avatar, background, and file directories
274 writeable by the Web server group, as noted above.
276 5. Create a database to hold your microblog data. Something like this
279 mysqladmin -u "username" --password="password" create statusnet
281 Note that StatusNet must have its own database; you can't share the
282 database with another program. You can name it whatever you want,
285 (If you don't have shell access to your server, you may need to use
286 a tool like PHPAdmin to create a database. Check your hosting
287 service's documentation for how to create a new MySQL database.)
289 6. Create a new database account that StatusNet will use to access the
290 database. If you have shell access, this will probably work from the
293 GRANT ALL on statusnet.*
294 TO 'lacuser'@'localhost'
295 IDENTIFIED BY 'lacpassword';
297 You should change 'lacuser' and 'lacpassword' to your preferred new
298 username and password. You may want to test logging in to MySQL as
301 7. In a browser, navigate to the StatusNet install script; something like:
303 http://yourserver.example.com/mublog/install.php
305 Enter the database connection information and your site name. The
306 install program will configure your site and install the initial,
307 almost-empty database.
309 8. You should now be able to navigate to your microblog's main directory
310 and see the "Public Timeline", which will be empty. If not, magic
311 has happened! You can now register a new user, post some notices,
312 edit your profile, etc. However, you may want to wait to do that stuff
313 if you think you can set up "fancy URLs" (see below), since some
314 URLs are stored in the database.
319 By default, StatusNet will use URLs that include the main PHP program's
320 name in them. For example, a user's home profile might be
323 http://example.org/mublog/index.php/mublog/fred
325 On certain systems that don't support this kind of syntax, they'll
328 http://example.org/mublog/index.php?p=mublog/fred
330 It's possible to configure the software so it looks like this instead:
332 http://example.org/mublog/fred
334 These "fancy URLs" are more readable and memorable for users. To use
335 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
336 mod_redirect enabled, -OR- know how to configure "url redirection" in
339 1. Copy the htaccess.sample file to .htaccess in your StatusNet
340 directory. Note: if you have control of your server's httpd.conf or
341 similar configuration files, it can greatly improve performance to
342 import the .htaccess file into your conf file instead. If you're
343 not sure how to do it, you may save yourself a lot of headache by
344 just leaving the .htaccess file.
346 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
347 to your StatusNet installation on your server. Typically this will
348 be the path to your StatusNet directory relative to your Web root.
350 3. Add or uncomment or change a line in your config.php file so it says:
352 $config['site']['fancy'] = true;
354 You should now be able to navigate to a "fancy" URL on your server,
357 http://example.net/mublog/main/register
359 If you changed your HTTP server configuration, you may need to restart
365 To use a Sphinx server to search users and notices, you also need
366 to install, compile and enable the sphinx pecl extension for php on the
367 client side, which itself depends on the sphinx development files.
368 "pecl install sphinx" should take care of that. Add "extension=sphinx.so"
369 to your php.ini and reload apache to enable it.
371 You can update your MySQL or Postgresql databases to drop their fulltext
372 search indexes, since they're now provided by sphinx.
374 On the sphinx server side, a script reads the main database and build
375 the keyword index. A cron job reads the database and keeps the sphinx
376 indexes up to date. scripts/sphinx-cron.sh should be called by cron
377 every 5 minutes, for example. scripts/sphinx.sh is an init.d script
378 to start and stop the sphinx search daemon.
383 StatusNet supports a cheap-and-dirty system for sending update messages
384 to mobile phones and for receiving updates from the mobile. Instead of
385 sending through the SMS network itself, which is costly and requires
386 buy-in from the wireless carriers, it simply piggybacks on the email
387 gateways that many carriers provide to their customers. So, SMS
388 configuration is essentially email configuration.
390 Each user sends to a made-up email address, which they keep a secret.
391 Incoming email that is "From" the user's SMS email address, and "To"
392 the users' secret email address on the site's domain, will be
393 converted to a notice and stored in the DB.
395 For this to work, there *must* be a domain or sub-domain for which all
396 (or most) incoming email can pass through the incoming mail filter.
398 1. Run the SQL script carrier.sql in your StatusNet database. This will
401 mysql -u "lacuser" --password="lacpassword" statusnet < db/carrier.sql
403 This will populate your database with a list of wireless carriers
404 that support email SMS gateways.
406 2. Make sure the maildaemon.php file is executable:
408 chmod +x scripts/maildaemon.php
410 Note that "daemon" is kind of a misnomer here; the script is more
411 of a filter than a daemon.
413 2. Edit /etc/aliases on your mail server and add the following line:
415 *: /path/to/statusnet/scripts/maildaemon.php
417 3. Run whatever code you need to to update your aliases database. For
418 many mail servers (Postfix, Exim, Sendmail), this should work:
422 You may need to restart your mail server for the new database to
425 4. Set the following in your config.php file:
427 $config['mail']['domain'] = 'yourdomain.example.net';
429 At this point, post-by-email and post-by-SMS-gateway should work. Note
430 that if your mail server is on a different computer from your email
431 server, you'll need to have a full installation of StatusNet, a working
432 config.php, and access to the StatusNet database from the mail server.
437 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
438 instant-messenger protocol that drives Jabber and GTalk IM. You can
439 distribute messages via XMPP using the system below; however, you
440 need to run the XMPP incoming daemon to allow incoming messages as
443 1. You may want to strongly consider setting up your own XMPP server.
444 Ejabberd, OpenFire, and JabberD are all Open Source servers.
445 Jabber, Inc. provides a high-performance commercial server.
447 2. You must register a Jabber ID (JID) with your new server. It helps
448 to choose a name like "update@example.com" or "notice" or something
449 similar. Alternately, your "update JID" can be registered on a
450 publicly-available XMPP service, like jabber.org or GTalk.
452 StatusNet will not register the JID with your chosen XMPP server;
453 you need to do this manually, with an XMPP client like Gajim,
454 Telepathy, or Pidgin.im.
456 3. Configure your site's XMPP variables, as described below in the
457 configuration section.
459 On a default installation, your site can broadcast messages using
460 XMPP. Users won't be able to post messages using XMPP unless you've
461 got the XMPP daemon running. See 'Queues and daemons' below for how
462 to set that up. Also, once you have a sizable number of users, sending
463 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
464 can really slow down your site; it may cause posting to timeout.
466 NOTE: stream_select(), a crucial function for network programming, is
467 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
468 work around this bug in StatusNet; current recommendation is to move
469 off of amd64 to another server.
474 You can send *all* messages from your microblogging site to a
475 third-party service using XMPP. This can be useful for providing
476 search, indexing, bridging, or other cool services.
478 To configure a downstream site to receive your public stream, add
479 their "JID" (Jabber ID) to your config.php as follows:
481 $config['xmpp']['public'][] = 'downstream@example.net';
483 (Don't miss those square brackets at the end.) Note that your XMPP
484 broadcasting must be configured as mentioned above. Although you can
485 send out messages at "Web time", high-volume sites should strongly
486 consider setting up queues and daemons.
491 Some activities that StatusNet needs to do, like broadcast OMB, SMS,
492 and XMPP messages, can be 'queued' and done by off-line bots instead.
493 For this to work, you must be able to run long-running offline
494 processes, either on your main Web server or on another server you
495 control. (Your other server will still need all the above
496 prerequisites, with the exception of Apache.) Installing on a separate
497 server is probably a good idea for high-volume sites.
499 1. You'll need the "CLI" (command-line interface) version of PHP
500 installed on whatever server you use.
502 2. If you're using a separate server for queues, install StatusNet
503 somewhere on the server. You don't need to worry about the
504 .htaccess file, but make sure that your config.php file is close
505 to, or identical to, your Web server's version.
507 3. In your config.php files (both the Web server and the queues
508 server!), set the following variable:
510 $config['queue']['enabled'] = true;
512 You may also want to look at the 'daemon' section of this file for
513 more daemon options. Note that if you set the 'user' and/or 'group'
514 options, you'll need to create that user and/or group by hand.
515 They're not created automatically.
517 4. On the queues server, run the command scripts/startdaemons.sh. It
518 needs as a parameter the install path; if you run it from the
519 StatusNet dir, "." should suffice.
521 This will run eight (for now) queue handlers:
523 * xmppdaemon.php - listens for new XMPP messages from users and stores
524 them as notices in the database.
525 * jabberqueuehandler.php - sends queued notices in the database to
526 registered users who should receive them.
527 * publicqueuehandler.php - sends queued notices in the database to
528 public feed listeners.
529 * ombqueuehandler.php - sends queued notices to OpenMicroBlogging
530 recipients on foreign servers.
531 * smsqueuehandler.php - sends queued notices to SMS-over-email addresses
533 * xmppconfirmhandler.php - sends confirmation messages to registered
535 * twitterqueuehandler.php - sends queued notices to Twitter for user
536 who have opted to set up Twitter bridging.
537 * facebookqueuehandler.php - sends queued notices to Facebook for users
538 of the built-in Facebook application.
540 Note that these queue daemons are pretty raw, and need your care. In
541 particular, they leak memory, and you may want to restart them on a
542 regular (daily or so) basis with a cron job. Also, if they lose
543 the connection to the XMPP server for too long, they'll simply die. It
544 may be a good idea to use a daemon-monitoring service, like 'monit',
545 to check their status and keep them running.
547 All the daemons write their process IDs (pids) to /var/run/ by
548 default. This can be useful for starting, stopping, and monitoring the
551 With version 0.8.0, it's now possible to use a STOMP server instead of
552 our kind of hacky home-grown DB-based queue solution. See the "queues"
553 config section below for how to configure to use STOMP. As of this
554 writing, the software has been tested with ActiveMQ (
561 As of 0.8.1, OAuth is used to to access protected resources on Twitter
562 instead of HTTP Basic Auth. To use Twitter bridging you will need
563 to register your instance of StatusNet as an application on Twitter
564 (http://twitter.com/apps), and update the following variables in your
565 config.php with the consumer key and secret Twitter generates for you:
567 $config['twitter']['consumer_key'] = 'YOURKEY';
568 $config['twitter']['consumer_secret'] = 'YOURSECRET';
570 When registering your application with Twitter set the type to "Browser"
571 and your Callback URL to:
573 http://example.org/mublog/twitter/authorization
575 The default access type should be, "Read & Write".
577 * Importing statuses from Twitter
579 To allow your users to import their friends' Twitter statuses, you will
580 need to enable the bidirectional Twitter bridge in config.php:
582 $config['twitterbridge']['enabled'] = true;
584 and run the TwitterStatusFetcher daemon (scripts/twitterstatusfetcher.php).
585 Additionally, you will want to set the integration source variable,
586 which will keep notices posted to Twitter via StatusNet from looping
587 back. The integration source should be set to the name of your
588 application, exactly as you specified it on the settings page for your
589 StatusNet application on Twitter, e.g.:
591 $config['integration']['source'] = 'YourApp';
593 * Twitter Friends Syncing
595 Users may set a flag in their settings ("Subscribe to my Twitter friends
596 here" under the Twitter tab) to have StatusNet attempt to locate and
597 subscribe to "friends" (people they "follow") on Twitter who also have
598 accounts on your StatusNet system, and who have previously set up a link
599 for automatically posting notices to Twitter.
601 As of 0.8.0, this is no longer accomplished via a cron job. Instead you
602 must run the SyncTwitterFriends daemon (scripts/synctwitterfreinds.php).
604 Built-in Facebook Application
605 -----------------------------
607 StatusNet's Facebook application allows your users to automatically
608 update their Facebook statuses with their latest notices, invite
609 their friends to use the app (and thus your site), view their notice
610 timelines, and post notices -- all from within Facebook. The application
611 is built into StatusNet and runs on your host. For automatic Facebook
612 status updating to work you will need to enable queuing and run the
613 facebookqueuehandler.php daemon (see the "Queues and daemons" section
616 Quick setup instructions*:
618 Install the Facebook Developer application on Facebook:
620 http://www.facebook.com/developers/
622 Use it to create a new application and generate an API key and secret.
623 Uncomment the Facebook app section of your config.php and copy in the
624 key and secret, e.g.:
626 # Config section for the built-in Facebook application
627 $config['facebook']['apikey'] = 'APIKEY';
628 $config['facebook']['secret'] = 'SECRET';
630 In Facebook's application editor, specify the following URLs for your app:
632 - Callback URL: http://example.net/mublog/facebook/
633 - Post-Remove URL: http://example.net/mublog/facebook/remove
634 - Post-Add Redirect URL: http://apps.facebook.com/yourapp/
635 - Canvas URL: http://apps.facebook.com/yourapp/
637 (Replace 'example.net' with your host's URL, 'mublog' with the path
638 to your StatusNet installation, and 'yourapp' with the name of the
639 Facebook application you created.)
641 Additionally, Choose "Web" for Application type in the Advanced tab.
642 In the "Canvas setting" section, choose the "FBML" for Render Method,
643 "Smart Size" for IFrame size, and "Full width (760px)" for Canvas Width.
644 Everything else can be left with default values.
646 *For more detailed instructions please see the installation guide on the
649 http://status.net/trac/wiki/FacebookApplication
654 Sitemap files <http://sitemaps.org/> are a very nice way of telling
655 search engines and other interested bots what's available on your site
656 and what's changed recently. You can generate sitemap files for your
659 1. Choose your sitemap URL layout. StatusNet creates a number of
660 sitemap XML files for different parts of your site. You may want to
661 put these in a sub-directory of your StatusNet directory to avoid
662 clutter. The sitemap index file tells the search engines and other
663 bots where to find all the sitemap files; it *must* be in the main
664 installation directory or higher. Both types of file must be
665 available through HTTP.
667 2. To generate your sitemaps, run the following command on your server:
669 php scripts/sitemap.php -f index-file-path -d sitemap-directory -u URL-prefix-for-sitemaps
671 Here, index-file-path is the full path to the sitemap index file,
672 like './sitemapindex.xml'. sitemap-directory is the directory where
673 you want the sitemaps stored, like './sitemaps/' (make sure the dir
674 exists). URL-prefix-for-sitemaps is the full URL for the sitemap dir,
675 typically something like <http://example.net/mublog/sitemaps/>.
677 You can use several methods for submitting your sitemap index to
678 search engines to get your site indexed. One is to add a line like the
679 following to your robots.txt file:
681 Sitemap: /mublog/sitemapindex.xml
683 This is a good idea for letting *all* Web spiders know about your
684 sitemap. You can also submit sitemap files to major search engines
685 using their respective "Webmaster centres"; see sitemaps.org for links
691 There are two themes shipped with this version of StatusNet: "identica",
692 which is what the Identi.ca site uses, and "default", which is a good
693 basis for other sites.
695 As of right now, your ability to change the theme is site-wide; users
696 can't choose their own theme. Additionally, the only thing you can
697 change in the theme is CSS stylesheets and some image files; you can't
698 change the HTML output, like adding or removing menu items.
700 You can choose a theme using the $config['site']['theme'] element in
701 the config.php file. See below for details.
703 You can add your own theme by making a sub-directory of the 'theme'
704 subdirectory with the name of your theme. Each theme can have the
707 display.css: a CSS2 file for "default" styling for all browsers.
708 ie6.css: a CSS2 file for override styling for fixing up Internet
710 ie7.css: a CSS2 file for override styling for fixing up Internet
712 logo.png: a logo image for the site.
713 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
714 users who don't upload their own.
715 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
716 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
717 listing on profile pages.
719 You may want to start by copying the files from the default theme to
722 NOTE: the HTML generated by StatusNet changed *radically* between
723 version 0.6.x and 0.7.x. Older themes will need signification
724 modification to use the new output format.
729 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
730 Theoretically, you can add your own sub-directory to the locale/
731 subdirectory to add a new language to your system. You'll need to
732 compile the ".po" files into ".mo" files, however.
734 Contributions of translation information to StatusNet are very easy:
735 you can use the Web interface at http://status.net/pootle/ to add one
736 or a few or lots of new translations -- or even new languages. You can
737 also download more up-to-date .po files there, if you so desire.
742 There is no built-in system for doing backups in StatusNet. You can make
743 backups of a working StatusNet system by backing up the database and
744 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
745 and to backup the Web directory, try tar.
750 The administrator can set the "private" flag for a site so that it's
751 not visible to non-logged-in users. This might be useful for
752 workgroups who want to share a microblogging site for project
753 management, but host it on a public server.
755 Note that this is an experimental feature; total privacy is not
756 guaranteed or ensured. Also, privacy is all-or-nothing for a site; you
757 can't have some accounts or notices private, and others public.
758 Finally, the interaction of private sites with OpenMicroBlogging is
759 undefined. Remote users won't be able to subscribe to users on a
760 private site, but users of the private site may be able to subscribe
761 to users on a remote site. (Or not... it's not well tested.) The
762 "proper behaviour" hasn't been defined here, so handle with care.
767 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
768 incorrectly-stored international characters ("UTF-8"). For new
769 installations, it will now store non-ASCII characters correctly.
770 However, older installations will have the incorrect storage, and will
771 consequently show up "wrong" in browsers. See below for how to deal
774 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
775 been tracking the "git" version of the software, you will probably
776 want to upgrade and keep your existing data. There is no automated
777 upgrade procedure in StatusNet 0.8.0. Try these step-by-step
778 instructions; read to the end first before trying them.
780 0. Download StatusNet and set up all the prerequisites as if you were
782 1. Make backups of both your database and your Web directory. UNDER NO
783 CIRCUMSTANCES should you try to do an upgrade without a known-good
784 backup. You have been warned.
785 2. Shut down Web access to your site, either by turning off your Web
786 server or by redirecting all pages to a "sorry, under maintenance"
788 3. Shut down XMPP access to your site, typically by shutting down the
789 xmppdaemon.php process and all other daemons that you're running.
790 If you've got "monit" or "cron" automatically restarting your
791 daemons, make sure to turn that off, too.
792 4. Shut down SMS and email access to your site. The easy way to do
793 this is to comment out the line piping incoming email to your
794 maildaemon.php file, and running something like "newaliases".
795 5. Once all writing processes to your site are turned off, make a
796 final backup of the Web directory and database.
797 6. Move your StatusNet directory to a backup spot, like "mublog.bak".
798 7. Unpack your StatusNet 0.8.0 tarball and move it to "mublog" or
799 wherever your code used to be.
800 8. Copy the config.php file and avatar directory from your old
801 directory to your new directory.
802 9. Copy htaccess.sample to .htaccess in the new directory. Change the
803 RewriteBase to use the correct path.
804 10. Rebuild the database. NOTE: this step is destructive and cannot be
805 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
806 do it without a known-good backup!
808 If your database is at version 0.7.4, you can run a special upgrade
811 mysql -u<rootuser> -p<rootpassword> <database> db/074to080.sql
813 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
814 BACKUP run the rebuilddb.sh script like this:
816 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
818 Here, rootuser and rootpassword are the username and password for a
819 user who can drop and create databases as well as tables; typically
820 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
821 your database and rebuilds it; if there is an error you have no
822 database. Make sure you have a backup.
823 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
824 which operates slightly differently. Read the documentation in that
825 script before running it.
826 11. Use mysql or psql client to log into your database and make sure that
827 the notice, user, profile, subscription etc. tables are non-empty.
828 12. Turn back on the Web server, and check that things still work.
829 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
830 bots have changed since version 0.5; see above for details.
832 If you're upgrading from very old versions, you may want to look at
833 the fixup_* scripts in the scripts directories. These will store some
834 precooked data in the DB. All upgraders should check out the inboxes
837 NOTE: the database definition file, stoica.ini, has been renamed to
838 statusnet.ini (since this is the recommended database name). If you
839 have a line in your config.php pointing to the old name, you'll need
845 Before version 0.6.2, the page showing all notices from people the
846 user is subscribed to ("so-and-so with friends") was calculated at run
847 time. Starting with 0.6.2, we have a new data structure for holding a
848 user's "notice inbox". (Note: distinct from the "message inbox", which
849 is the "inbox" tab in the UI. The notice inbox appears under the
852 Notices are added to the inbox when they're created. This speeds up
853 the query considerably, and also allows us the opportunity, in the
854 future, to add different kind of notices to an inbox -- like @-replies
855 or subscriptions to search terms or hashtags.
857 Notice inboxes are enabled by default for new installations. If you
858 are upgrading an existing site, this means that your users will see
859 empty "Personal" pages. The following steps will help you fix the
862 0. $config['inboxes']['enabled'] can be set to one of three values. If
863 you set it to 'false', the site will work as before. Support for this
864 will probably be dropped in future versions.
865 1. Setting the flag to 'transitional' means that you're in transition.
866 In this mode, the code will run the "new query" or the "old query"
867 based on whether the user's inbox has been updated.
868 2. After setting the flag to "transitional", you can run the
869 fixup_inboxes.php script to create the inboxes. You may want to set
870 the memory limit high. You can re-run it without ill effect.
871 3. When fixup_inboxes is finished, you can set the enabled flag to
874 NOTE: we will drop support for non-inboxed sites in the 0.9.x version
875 of StatusNet. It's time to switch now!
880 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
881 international characters ("UTF-8"). This fix is not
882 backwards-compatible; installations from before 0.7.4 will show
883 non-ASCII characters of old notices incorrectly. This section explains
886 0. You can disable the new behaviour by setting the 'db''utf8' config
887 option to "false". You should only do this until you're ready to
888 convert your DB to the new format.
889 1. When you're ready to convert, you can run the fixup_utf8.php script
890 in the scripts/ subdirectory. If you've had the "new behaviour"
891 enabled (probably a good idea), you can give the ID of the first
892 "new" notice as a parameter, and only notices before that one will
893 be converted. Notices are converted in reverse chronological order,
894 so the most recent (and visible) ones will be converted first. The
895 script should work whether or not you have the 'db''utf8' config
897 2. When you're ready, set $config['db']['utf8'] to true, so that
898 new notices will be stored correctly.
900 Configuration options
901 =====================
903 The main configuration file for StatusNet (excepting configurations for
904 dependency software) is config.php in your StatusNet directory. If you
905 edit any other file in the directory, like lib/common.php (where most
906 of the defaults are defined), you will lose your configuration options
907 in any upgrade, and you will wish that you had been more careful.
909 Starting with version 0.7.1, you can put config files in the
910 /etc/statusnet/ directory on your server, if it exists. Config files
911 will be included in this order:
913 * /etc/statusnet/laconica.php - server-wide config
914 * /etc/statusnet/<servername>.php - for a virtual host
915 * /etc/statusnet/<servername>_<pathname>.php - for a path
916 * INSTALLDIR/config.php - for a particular implementation
918 Almost all configuration options are made through a two-dimensional
919 associative array, cleverly named $config. A typical configuration
922 $config['section']['option'] = value;
924 For brevity, the following documentation describes each section and
930 This section is a catch-all for site-wide variables.
932 name: the name of your site, like 'YourCompany Microblog'.
933 server: the server part of your site's URLs, like 'example.net'.
934 path: The path part of your site's URLs, like 'mublog' or ''
936 fancy: whether or not your site uses fancy URLs (see Fancy URLs
937 section above). Default is false.
938 logfile: full path to a file for StatusNet to save logging
939 information to. You may want to use this if you don't have
941 logdebug: whether to log additional debug info like backtraces on
942 hard errors. Default false.
943 locale_path: full path to the directory for locale data. Unless you
944 store all your locale data in one place, you probably
945 don't need to use this.
946 language: default language for your site. Defaults to US English.
947 languages: A list of languages supported on your site. Typically you'd
948 only change this if you wanted to disable support for one
950 "unset($config['site']['languages']['de'])" will disable
952 theme: Theme for your site (see Theme section). Two themes are
953 provided by default: 'default' and 'stoica' (the one used by
954 Identi.ca). It's appreciated if you don't use the 'stoica' theme
955 except as the basis for your own.
956 email: contact email address for your site. By default, it's extracted
957 from your Web server environment; you may want to customize it.
958 broughtbyurl: name of an organization or individual who provides the
959 service. Each page will include a link to this name in the
960 footer. A good way to link to the blog, forum, wiki,
961 corporate portal, or whoever is making the service available.
962 broughtby: text used for the "brought by" link.
963 timezone: default timezone for message display. Users can set their
964 own time zone. Defaults to 'UTC', which is a pretty good default.
965 closed: If set to 'true', will disallow registration on your site.
966 This is a cheap way to restrict accounts to only one
967 individual or group; just register the accounts you want on
968 the service, *then* set this variable to 'true'.
969 inviteonly: If set to 'true', will only allow registration if the user
970 was invited by an existing user.
971 openidonly: If set to 'true', will only allow registrations and logins
973 private: If set to 'true', anonymous users will be redirected to the
974 'login' page. Also, API methods that normally require no
975 authentication will require it. Note that this does not turn
976 off registration; use 'closed' or 'inviteonly' for the
978 notice: A plain string that will appear on every page. A good place
979 to put introductory information about your service, or info about
980 upgrades and outages, or other community info. Any HTML will
982 logo: URL of an image file to use as the logo for the site. Overrides
983 the logo in the theme, if any.
984 ssl: Whether to use SSL and https:// URLs for some or all pages.
985 Possible values are 'always' (use it for all pages), 'never'
986 (don't use it for any pages), or 'sometimes' (use it for
987 sensitive pages that include passwords like login and registration,
988 but not for regular pages). Default to 'never'.
989 sslserver: use an alternate server name for SSL URLs, like
990 'secure.example.org'. You should be careful to set cookie
991 parameters correctly so that both the SSL server and the
992 "normal" server can access the session cookie and
993 preferably other cookies as well.
994 shorturllength: Length of URL at which URLs in a message exceeding 140
995 characters will be sent to the user's chosen
997 dupelimit: minimum time allowed for one person to say the same thing
998 twice. Default 60s. Anything lower is considered a user
1004 This section is a reference to the configuration options for
1005 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
1006 set are listed below for clarity.
1008 database: a DSN (Data Source Name) for your StatusNet database. This is
1009 in the format 'protocol://username:password@hostname/databasename',
1010 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
1011 really know what you're doing), 'username' is the username,
1012 'password' is the password, and etc.
1013 ini_yourdbname: if your database is not named 'statusnet', you'll need
1014 to set this to point to the location of the
1015 statusnet.ini file. Note that the real name of your database
1016 should go in there, not literally 'yourdbname'.
1017 db_driver: You can try changing this to 'MDB2' to use the other driver
1018 type for DB_DataObject, but note that it breaks the OpenID
1019 libraries, which only support PEAR::DB.
1020 debug: On a database error, you may get a message saying to set this
1021 value to 5 to see debug messages in the browser. This breaks
1022 just about all pages, and will also expose the username and
1024 quote_identifiers: Set this to true if you're using postgresql.
1025 type: either 'mysql' or 'postgresql' (used for some bits of
1026 database-type-specific SQL in the code). Defaults to mysql.
1027 mirror: you can set this to an array of DSNs, like the above
1028 'database' value. If it's set, certain read-only actions will
1029 use a random value out of this array for the database, rather
1030 than the one in 'database' (actually, 'database' is overwritten).
1031 You can offload a busy DB server by setting up MySQL replication
1032 and adding the slaves to this array. Note that if you want some
1033 requests to go to the 'database' (master) server, you'll need
1034 to include it in this array, too.
1035 utf8: whether to talk to the database in UTF-8 mode. This is the default
1036 with new installations, but older sites may want to turn it off
1037 until they get their databases fixed up. See "UTF-8 database"
1043 By default, StatusNet sites log error messages to the syslog facility.
1044 (You can override this using the 'logfile' parameter described above).
1046 appname: The name that StatusNet uses to log messages. By default it's
1047 "statusnet", but if you have more than one installation on the
1048 server, you may want to change the name for each instance so
1049 you can track log messages more easily.
1050 priority: level to log at. Currently ignored.
1051 facility: what syslog facility to used. Defaults to LOG_USER, only
1052 reset if you know what syslog is and have a good reason
1058 You can configure the software to queue time-consuming tasks, like
1059 sending out SMS email or XMPP messages, for off-line processing. See
1060 'Queues and daemons' above for how to set this up.
1062 enabled: Whether to uses queues. Defaults to false.
1063 subsystem: Which kind of queueserver to use. Values include "db" for
1064 our hacked-together database queuing (no other server
1065 required) and "stomp" for a stomp server.
1066 stomp_server: "broker URI" for stomp server. Something like
1067 "tcp://hostname:61613". More complicated ones are
1068 possible; see your stomp server's documentation for
1070 queue_basename: a root name to use for queues (stomp only). Typically
1071 something like '/queue/sitename/' makes sense.
1072 stomp_username: username for connecting to the stomp server; defaults
1074 stomp_password: password for connecting to the stomp server; defaults
1079 The default license to use for your users notices. The default is the
1080 Creative Commons Attribution 3.0 license, which is probably the right
1081 choice for any public site. Note that some other servers will not
1082 accept notices if you apply a stricter license than this.
1084 url: URL of the license, used for links.
1085 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1086 image: A button shown on each page for the license.
1091 This is for configuring out-going email. We use PEAR's Mail module,
1092 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1094 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1095 'smtp'. Defaults to PEAR's default, 'mail'.
1096 params: if the mail backend requires any parameters, you can provide
1097 them in an associative array.
1102 This is for configuring nicknames in the service.
1104 blacklist: an array of strings for usernames that may not be
1105 registered. A default array exists for strings that are
1106 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1107 but you may want to add others if you have other software
1108 installed in a subdirectory of StatusNet or if you just
1109 don't want certain words used as usernames.
1110 featured: an array of nicknames of 'featured' users of the site.
1111 Can be useful to draw attention to well-known users, or
1112 interesting people, or whatever.
1117 For configuring avatar access.
1119 dir: Directory to look for avatar files and to put them into.
1120 Defaults to avatar subdirectory of install directory; if
1121 you change it, make sure to change path, too.
1122 path: Path to avatars. Defaults to path for avatar subdirectory,
1123 but you can change it if you wish. Note that this will
1124 be included with the avatar server, too.
1125 server: If set, defines another server where avatars are stored in the
1126 root directory. Note that the 'avatar' subdir still has to be
1127 writeable. You'd typically use this to split HTTP requests on
1128 the client to speed up page loading, either with another
1129 virtual server or with an NFS or SAMBA share. Clients
1130 typically only make 2 connections to a single server at a
1131 time <http://ur1.ca/6ih>, so this can parallelize the job.
1137 For configuring the public stream.
1139 localonly: If set to true, only messages posted by users of this
1140 service (rather than other services, filtered through OMB)
1141 are shown in the public stream. Default true.
1142 blacklist: An array of IDs of users to hide from the public stream.
1143 Useful if you have someone making excessive Twitterfeed posts
1144 to the site, other kinds of automated posts, testing bots, etc.
1145 autosource: Sources of notices that are from automatic posters, and thus
1146 should be kept off the public timeline. Default empty.
1151 server: Like avatars, you can speed up page loading by pointing the
1152 theme file lookup to another server (virtual or real).
1153 Defaults to NULL, meaning to use the site server.
1154 dir: Directory where theme files are stored. Used to determine
1155 whether to show parts of a theme file. Defaults to the theme
1156 subdirectory of the install directory.
1157 path: Path part of theme URLs, before the theme name. Relative to the
1158 theme server. It may make sense to change this path when upgrading,
1159 (using version numbers as the path) to make sure that all files are
1160 reloaded by caching clients or proxies. Defaults to null,
1161 which means to use the site path + '/theme'.
1166 For configuring the XMPP sub-system.
1168 enabled: Whether to accept and send messages by XMPP. Default false.
1169 server: server part of XMPP ID for update user.
1170 port: connection port for clients. Default 5222, which you probably
1171 shouldn't need to change.
1172 user: username for the client connection. Users will receive messages
1173 from 'user'@'server'.
1174 resource: a unique identifier for the connection to the server. This
1175 is actually used as a prefix for each XMPP component in the system.
1176 password: password for the user account.
1177 host: some XMPP domains are served by machines with a different
1178 hostname. (For example, @gmail.com GTalk users connect to
1179 talk.google.com). Set this to the correct hostname if that's the
1180 case with your server.
1181 encryption: Whether to encrypt the connection between StatusNet and the
1182 XMPP server. Defaults to true, but you can get
1183 considerably better performance turning it off if you're
1184 connecting to a server on the same machine or on a
1186 debug: if turned on, this will make the XMPP library blurt out all of
1187 the incoming and outgoing messages as XML stanzas. Use as a
1188 last resort, and never turn it on if you don't have queues
1189 enabled, since it will spit out sensitive data to the browser.
1190 public: an array of JIDs to send _all_ notices to. This is useful for
1191 participating in third-party search and archiving services.
1196 For configuring invites.
1198 enabled: Whether to allow users to send invites. Default true.
1203 For configuring OpenID.
1205 enabled: Whether to allow users to register and login using OpenID. Default
1211 Miscellaneous tagging stuff.
1213 dropoff: Decay factor for tag listing, in seconds.
1214 Defaults to exponential decay over ten days; you can twiddle
1215 with it to try and get better results for your site.
1220 Settings for the "popular" section of the site.
1222 dropoff: Decay factor for popularity listing, in seconds.
1223 Defaults to exponential decay over ten days; you can twiddle
1224 with it to try and get better results for your site.
1229 For daemon processes.
1231 piddir: directory that daemon processes should write their PID file
1232 (process ID) to. Defaults to /var/run/, which is where this
1233 stuff should usually go on Unix-ish systems.
1234 user: If set, the daemons will try to change their effective user ID
1235 to this user before running. Probably a good idea, especially if
1236 you start the daemons as root. Note: user name, like 'daemon',
1238 group: If set, the daemons will try to change their effective group ID
1239 to this named group. Again, a name, not a numerical ID.
1244 You can get a significant boost in performance by caching some
1245 database data in memcached <http://www.danga.com/memcached/>.
1247 enabled: Set to true to enable. Default false.
1248 server: a string with the hostname of the memcached server. Can also
1249 be an array of hostnames, if you've got more than one server.
1250 base: memcached uses key-value pairs to store data. We build long,
1251 funny-looking keys to make sure we don't have any conflicts. The
1252 base of the key is usually a simplified version of the site name
1253 (like "Identi.ca" => "identica"), but you can overwrite this if
1254 you need to. You can safely ignore it if you only have one
1255 StatusNet site using your memcached server.
1256 port: Port to connect to; defaults to 11211.
1261 You can get a significant boost in performance using Sphinx Search
1262 instead of your database server to search for users and notices.
1263 <http://sphinxsearch.com/>.
1265 enabled: Set to true to enable. Default false.
1266 server: a string with the hostname of the sphinx server.
1267 port: an integer with the port number of the sphinx server.
1274 enabled: Whether to enable post-by-email. Defaults to true. You will
1275 also need to set up maildaemon.php.
1280 For SMS integration.
1282 enabled: Whether to enable SMS integration. Defaults to true. Queues
1283 should also be enabled.
1288 For Twitter integration
1290 enabled: Whether to enable Twitter integration. Defaults to true.
1291 Queues should also be enabled.
1296 A catch-all for integration with other systems.
1298 source: The name to use for the source of posts to Twitter. Defaults
1299 to 'statusnet', but if you request your own source name from
1300 Twitter <http://twitter.com/help/request_source>, you can use
1301 that here instead. Status updates on Twitter will then have
1303 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1310 enabled: A three-valued flag for whether to use notice inboxes (see
1311 upgrading info above for notes about this change). Can be
1312 'false', 'true', or '"transitional"'.
1317 For notice-posting throttles.
1319 enabled: Whether to throttle posting. Defaults to false.
1320 count: Each user can make this many posts in 'timespan' seconds. So, if count
1321 is 100 and timespan is 3600, then there can be only 100 posts
1322 from a user every hour.
1323 timespan: see 'count'.
1330 banned: an array of usernames and/or profile IDs of 'banned' profiles.
1331 The site will reject any notices by these users -- they will
1332 not be accepted at all. (Compare with blacklisted users above,
1333 whose posts just won't show up in the public stream.)
1338 Options with new users.
1340 default: nickname of a user account to automatically subscribe new
1341 users to. Typically this would be system account for e.g.
1342 service updates or announcements. Users are able to unsub
1343 if they want. Default is null; no auto subscribe.
1344 welcome: nickname of a user account that sends welcome messages to new
1345 users. Can be the same as 'default' account, although on
1346 busy servers it may be a good idea to keep that one just for
1347 'urgent' messages. Default is null; no message.
1349 If either of these special user accounts are specified, the users should
1350 be created before the configuration is updated.
1355 The software will, by default, send statistical snapshots about the
1356 local installation to a stats server on the status.net Web site. This
1357 data is used by the developers to prioritize development decisions. No
1358 identifying data about users or organizations is collected. The data
1359 is available to the public for review. Participating in this survey
1360 helps StatusNet developers take your needs into account when updating
1363 run: string indicating when to run the statistics. Values can be 'web'
1364 (run occasionally at Web time), 'cron' (run from a cron script),
1365 or 'never' (don't ever run). If you set it to 'cron', remember to
1366 schedule the script to run on a regular basis.
1367 frequency: if run value is 'web', how often to report statistics.
1368 Measured in Web hits; depends on how active your site is.
1369 Default is 10000 -- that is, one report every 10000 Web hits,
1371 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1372 report system, but if they go evil or disappear you may
1373 need to update this to another value. Note: if you
1374 don't want to report stats, it's much better to
1375 set 'run' to 'never' than to set this value to something
1381 The software lets users upload files with their notices. You can configure
1382 the types of accepted files by mime types and a trio of quota options:
1383 per file, per user (total), per user per month.
1385 We suggest the use of the pecl file_info extension to handle mime type
1388 supported: an array of mime types you accept to store and distribute,
1389 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1390 setup your server to properly recognize the types you want to
1392 uploads: false to disable uploading files with notices (true by default).
1393 filecommand: The required MIME_Type library may need to use the 'file'
1394 command. It tries the one in the Web server's path, but if
1395 you're having problems with uploads, try setting this to the
1396 correct value. Note: 'file' must accept '-b' and '-i' options.
1398 For quotas, be sure you've set the upload_max_filesize and post_max_size
1399 in php.ini to be large enough to handle your upload. In httpd.conf
1400 (if you're using apache), check that the LimitRequestBody directive isn't
1401 set too low (it's optional, so it may not be there at all).
1403 file_quota: maximum size for a single file upload in bytes. A user can send
1404 any amount of notices with attachments as long as each attachment
1405 is smaller than file_quota.
1406 user_quota: total size in bytes a user can store on this server. Each user
1407 can store any number of files as long as their total size does
1408 not exceed the user_quota.
1409 monthly_quota: total size permitted in the current month. This is the total
1410 size in bytes that a user can upload each month.
1411 dir: directory accessible to the Web process where uploads should go.
1412 Defaults to the 'file' subdirectory of the install directory, which
1413 should be writeable by the Web user.
1414 server: server name to use when creating URLs for uploaded files.
1415 Defaults to null, meaning to use the default Web server. Using
1416 a virtual server here can speed up Web performance.
1417 path: URL path, relative to the server, to find files. Defaults to
1418 main path + '/file/'.
1419 filecommand: command to use for determining the type of a file. May be
1420 skipped if fileinfo extension is installed. Defaults to
1426 Options for group functionality.
1428 maxaliases: maximum number of aliases a group can have. Default 3. Set
1429 to 0 or less to prevent aliases in a group.
1434 oEmbed endpoint for multimedia attachments (links in posts).
1436 endpoint: oohembed endpoint using http://oohembed.com/ software.
1441 Some stuff for search.
1443 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1444 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1445 but requires the lame old MyISAM engine for MySQL. The latter
1446 will work with InnoDB but could be miserably slow on large
1447 systems. We'll probably add another type sometime in the future,
1448 with our own indexing system (maybe like MediaWiki's).
1455 handle: boolean. Whether we should register our own PHP session-handling
1456 code (using the database and memcache if enabled). Defaults to false.
1457 Setting this to true makes some sense on large or multi-server
1458 sites, but it probably won't hurt for smaller ones, either.
1459 debug: whether to output debugging info for session storage. Can help
1460 with weird session bugs, sometimes. Default false.
1465 Users can upload backgrounds for their pages; this section defines
1468 server: the server to use for background. Using a separate (even
1469 virtual) server for this can speed up load times. Default is
1470 null; same as site server.
1471 dir: directory to write backgrounds too. Default is '/background/'
1472 subdir of install dir.
1473 path: path to backgrounds. Default is sub-path of install path; note
1474 that you may need to change this if you change site-path too.
1479 A bi-direction bridge to Twitter (http://twitter.com/).
1481 enabled: default false. If true, will show user's Twitter friends'
1482 notices in their inbox and faves pages, only to the user. You
1483 must also run the twitterstatusfetcher.php script.
1488 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1489 notify third-party servers of updates.
1491 notify: an array of URLs for ping endpoints. Default is the empty
1492 array (no notification).
1497 Default design (colors and background) for the site. Actual appearance
1498 depends on the theme. Null values mean to use the theme defaults.
1500 backgroundcolor: Hex color of the site background.
1501 contentcolor: Hex color of the content area background.
1502 sidebarcolor: Hex color of the sidebar background.
1503 textcolor: Hex color of all non-link text.
1504 linkcolor: Hex color of all links.
1505 backgroundimage: Image to use for the background.
1506 disposition: Flags for whether or not to tile the background image.
1511 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1512 powerful plugin architecture. Important events in the code are named,
1513 like 'StartNoticeSave', and other software can register interest
1514 in those events. When the events happen, the other software is called
1515 and has a choice of accepting or rejecting the events.
1517 In the simplest case, you can add a function to config.php and use the
1518 Event::addHandler() function to hook an event:
1520 function AddGoogleLink($action)
1522 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1526 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1528 This adds a menu item to the end of the main navigation menu. You can
1529 see the list of existing events, and parameters that handlers must
1530 implement, in EVENTS.txt.
1532 The Plugin class in lib/plugin.php makes it easier to write more
1533 complex plugins. Sub-classes can just create methods named
1534 'onEventName', where 'EventName' is the name of the event (case
1535 matters!). These methods will be automatically registered as event
1536 handlers by the Plugin constructor (which you must call from your own
1537 class's constructor).
1539 Several example plugins are included in the plugins/ directory. You
1540 can enable a plugin with the following line in config.php:
1542 addPlugin('Example', array('param1' => 'value1',
1543 'param2' => 'value2'));
1545 This will look for and load files named 'ExamplePlugin.php' or
1546 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1547 plugins that ship with StatusNet) or in the local/ directory (for
1548 plugins you write yourself or that you get from somewhere else) or
1551 Plugins are documented in their own directories.
1556 The primary output for StatusNet is syslog, unless you configured a
1557 separate logfile. This is probably the first place to look if you're
1558 getting weird behaviour from StatusNet.
1560 If you're tracking the unstable version of StatusNet in the git
1561 repository (see below), and you get a compilation error ("unexpected
1562 T_STRING") in the browser, check to see that you don't have any
1563 conflicts in your code.
1565 If you upgraded to StatusNet 0.7.4 without reading the "Notice inboxes"
1566 section above, and all your users' 'Personal' tabs are empty, read the
1567 "Notice inboxes" section above.
1572 These are some myths you may see on the Web about StatusNet.
1573 Documentation from the core team about StatusNet has been pretty
1574 sparse, so some backtracking and guesswork resulted in some incorrect
1577 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1578 extremely bad idea. It's a tool built into DB_DataObject that will
1579 emit oodles of print lines directly to the browser of your users.
1580 Among these lines will be your database username and password. Do
1581 not enable this option on a production Web site for any reason.
1583 - "Edit dataobject.ini with the following settings..." dataobject.ini
1584 is a development file for the DB_DataObject framework and is not
1585 used by the running software. It was removed from the StatusNet
1586 distribution because its presence was confusing. Do not bother
1587 configuring dataobject.ini, and do not put your database username
1588 and password into the file on a production Web server; unscrupulous
1589 persons may try to read it to get your passwords.
1594 If you're adventurous or impatient, you may want to install the
1595 development version of StatusNet. To get it, use the git version
1596 control tool <http://git-scm.com/> like so:
1598 git clone http://status.net/software/statusnet.git
1600 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1605 There are several ways to get more information about StatusNet.
1607 * There is a mailing list for StatusNet developers and admins at
1608 http://mail.status.net/mailman/listinfo/statusnet-dev
1609 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1610 * The StatusNet wiki, http://status.net/trac/
1615 * Microblogging messages to http://identi.ca/evan are very welcome.
1616 * StatusNet's Trac server has a bug tracker for any defects you may find,
1617 or ideas for making things better. http://status.net/trac/
1618 * e-mail to evan@identi.ca will usually be read and responded to very
1619 quickly, unless the question is really hard.
1624 The following is an incomplete list of developers who've worked on
1625 Laconi.ca. Apologies for any oversight; please let evan@identi.ca know
1626 if anyone's been overlooked in error.
1628 * Evan Prodromou, founder and lead developer, Control Yourself, Inc.
1629 * Zach Copley, Control Yourself, Inc.
1630 * Earle Martin, Control Yourself, Inc.
1631 * Marie-Claude Doyon, designer, Control Yourself, Inc.
1632 * Sarven Capadisli, Control Yourself, Inc.
1633 * Robin Millette, Control Yourself, Inc.
1644 * Tryggvi Björgvinsson
1648 * Ken Sheppardson (Trac server, man-about-town)
1649 * Tiago 'gouki' Faria (i18n manager)
1651 * Leslie Michael Orchard
1655 * Tobias Diekershoff
1664 Thanks also to the developers of our upstream library code and to the
1665 thousands of people who have tried out Identi.ca, installed Laconi.ca,
1666 told their friends, and built the Open Microblogging network to what