5 StatusNet 0.8.2 ("Life and How to Live It")
8 This is the README file for StatusNet (formerly Laconica), the Open
9 Source microblogging platform. It includes installation instructions,
10 descriptions of options you can set, warnings, tips, and general info
11 for administrators. Information on using StatusNet can be found in the
12 "doc" subdirectory or in the "help" section on-line.
17 StatusNet (formerly Laconica) is a Free and Open Source microblogging
18 platform. It helps people in a community, company or group to exchange
19 short (140 character) messages over the Web. Users can choose which
20 people to "follow" and receive only their friends' or colleagues'
21 status messages. It provides a similar service to sites like Twitter,
22 Jaiku, Yammer, 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
40 StatusNet, Inc. <http://status.net/> also offers this software as a
41 Web service, requiring no installation on your part. The software run
42 on status.net is identical to the software available for download, so
43 you can move back and forth between a hosted version or a version
44 installed on your own servers.
49 This program is free software: you can redistribute it and/or modify
50 it under the terms of the GNU Affero General Public License as
51 published by the Free Software Foundation, either version 3 of the
52 License, or (at your option) any later version.
54 This program is distributed in the hope that it will be useful, but
55 WITHOUT ANY WARRANTY; without even the implied warranty of
56 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
57 Affero General Public License for more details.
59 You should have received a copy of the GNU Affero General Public
60 License along with this program, in the file "COPYING". If not, see
61 <http://www.gnu.org/licenses/>.
63 IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
64 *different requirements* from the "regular" GPL. In particular, if
65 you make modifications to the StatusNet source code on your server,
66 you *MUST MAKE AVAILABLE* the modified version of the source code
67 to your users under the same license. This is a legal requirement
68 of using the software, and if you do not wish to share your
69 modifications, *YOU MAY NOT INSTALL STATUSNET*.
71 Additional library software has been made available in the 'extlib'
72 directory. All of it is Free Software and can be distributed under
73 liberal terms, but those terms may differ in detail from the AGPL's
74 particulars. See each package's license file in the extlib directory
80 This is a minor feature and bugfix release since version 0.8.1,
81 released Aug 26 2009. Notable changes this version:
83 - New script for deleting user accounts. Not particularly safe or
84 community-friendly. Better for deleting abusive accounts than for
85 users who are 'retiring'.
86 - Improved detection of URLs in notices, specifically for punctuation
87 chars like ~, :, $, _, -, +, !, @, and %.
88 - Removed some extra <dl> semantic HTML code.
89 - Correct error in status-network database ini file (having multiple
90 statusnet sites with a single codebase)
91 - Fixed error output for Twitter posting failures.
92 - Fixed bug in Twitter queue handler that requeued inapplicable
94 - Improve FOAF output for remote users.
95 - new commands to join and leave groups.
96 - Fixed bug in which you cannot turn off importing friends timelines
98 - Better error handling in Twitter posting.
99 - Show oEmbed data for XHTML files as well as plain HTML.
100 - Updated bug database link in README.
101 - require HTML tidy extension.
102 - add support for HTTP Basic Auth in PHP CGI or FastCGI (e.g. GoDaddy).
103 - autofocus input to selected entry elements depending on page.
104 - updated layout for filter-by-tag form.
105 - better layout for inbox and outbox pages.
106 - fix highlighting search terms in attributes of notice list elements.
107 - Correctly handle errors in linkback plugin.
109 - Updated cloudy theme.
110 - Don't match '::' as an IPv6 address.
111 - Use the same decision logic for deciding whether to mark an
112 attachment as an enclosure in RSS or as a paperclip item in Web
114 - Fixed a bug in the Piwik plugin that hard-coded the site ID.
115 - Add a param, inreplyto, to notice/new to allow an explicit response
117 - Show username in subject of emails.
118 - Check if avatar exists before trying to delete it.
119 - Correctly add omb_version to response for request token in OMB.
120 - Add a few more SMS carriers.
121 - Add a few more notice sources.
123 - Improvements to the AutoCompletePlugin.
124 - Check for 'dl' before using it.
125 - Make it impossible to delete self-subscriptions via the API.
126 - Fix pagination of tagged user pages.
127 - Make PiwikAnalyticsPlugin work with addPlugin().
128 - Removed trailing single space in user nicknames in notice lists.
129 - Show context link if a notice starts a conversation.
130 - blacklist all files and directories in install dir.
131 - handle GoDaddy-style PATH_INFO, including script name.
132 - add home_timeline synonym for friends_timeline.
133 - Add a popup window for the realtime plugin.
134 - Add some more streams for the realtime plugin.
135 - Fix a bug that overwrote group creation timestamp on every edit.
136 - Moved HTTP error code strings to a class variable.
137 - The Twitter API now returns server errors in the correct format.
138 - Reset the doctype for HTML output.
139 - Fixed a number of notices.
140 - Don't show search suggestions for private sites.
141 - Some corrections to FBConnect nav overrides.
142 - Slightly less database-intensive session management.
143 - Updated name of software in installer script.
144 - Include long-form attachment URLs if url-shortener is disabled.
145 - Include updated localisations for Polish, Greek, Hebrew, Icelandic,
146 Norwegian, and Chinese.
147 - Include upstream fixes to gettext.php.
148 - Correct for regression in Facebook API for updates.
149 - Ignore "Sent from my iPhone" (and similar) in mail updates.
150 - Use the NICKNAME_FMT constant for detecting nicknames.
151 - Check for site servername config'd.
152 - Compatibility fix for empty status updates with Twitter API.
153 - a script to register a new user.
154 - a script to make a user admin of a group.
159 The following software packages are *required* for this software to
162 - PHP 5.2.3+. It may be possible to run this software on earlier
163 versions of PHP, but many of the functions used are only available
165 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
166 server. It has been primarily tested on 5.x servers, although it may
167 be possible to install on earlier (or later!) versions. The server
168 *must* support the MyISAM storage engine -- the default for most
169 MySQL servers -- *and* the InnoDB storage engine.
170 - A Web server. Preferably, you should have Apache 2.2.x with the
171 mod_rewrite extension installed and enabled.
173 Your PHP installation must include the following PHP extensions:
175 - Curl. This is for fetching files by HTTP.
176 - XMLWriter. This is for formatting XML and HTML output.
177 - MySQL. For accessing the database.
178 - GD. For scaling down avatar images.
179 - mbstring. For handling Unicode (UTF-8) encoded strings.
180 - gettext. For multiple languages. Default on many PHP installs.
181 - tidy. Used to clean up HTML/URLs for the URL shortener to consume.
183 For some functionality, you will also need the following extensions:
185 - Memcache. A client for the memcached server, which caches database
186 information in volatile memory. This is important for adequate
187 performance on high-traffic sites. You will also need a memcached
188 server to store the data in.
189 - Mailparse. Efficient parsing of email requires this extension.
190 Submission by email or SMS-over-email uses this extension.
191 - Sphinx Search. A client for the sphinx server, an alternative
192 to MySQL or Postgresql fulltext search. You will also need a
193 Sphinx server to serve the search queries.
195 You will almost definitely get 2-3 times better performance from your
196 site if you install a PHP bytecode cache/accelerator. Some well-known
197 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
198 is a proprietary accelerator installed on some hosting sites.
203 A number of external PHP libraries are used to provide basic
204 functionality and optional functionality for your system. For your
205 convenience, they are available in the "extlib" directory of this
206 package, and you do not have to download and install them. However,
207 you may want to keep them up-to-date with the latest upstream version,
208 and the URLs are listed here for your convenience.
210 - DB_DataObject http://pear.php.net/package/DB_DataObject
211 - Validate http://pear.php.net/package/Validate
212 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
213 to use the openidenabled.com version since it's more widely
214 implemented, and seems to be better supported.
215 http://openidenabled.com/php-openid/
216 - PEAR DB. Although this is an older data access system (new
217 packages should probably use PHP DBO), the OpenID libraries
218 depend on PEAR DB so we use it here, too. DB_DataObject can
219 also use PEAR MDB2, which may give you better performance
220 but won't work with OpenID.
221 http://pear.php.net/package/DB
222 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
223 - markdown.php from http://michelf.com/projects/php-markdown/
224 - PEAR Mail, for sending out mail notifications
225 http://pear.php.net/package/Mail
226 - PEAR Net_SMTP, if you use the SMTP factory for notifications
227 http://pear.php.net/package/Net_SMTP
228 - PEAR Net_Socket, if you use the SMTP factory for notifications
229 http://pear.php.net/package/Net_Socket
230 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
231 library available for PHP. http://xmpphp.googlecode.com/. Note that
232 as of this writing the version of this library that is available in
233 the extlib directory is *significantly different* from the upstream
234 version (patches have been submitted). Upgrading to the upstream
235 version may render your StatusNet site unable to send or receive XMPP
237 - Facebook library. Used for the Facebook application.
238 - PEAR Services_oEmbed. Used for some multimedia integration.
239 - PEAR HTTP_Request is an oEmbed dependency.
240 - PEAR Validate is an oEmbed dependency.
241 - PEAR Net_URL2 is an oEmbed dependency.
242 - Console_GetOpt for parsing command-line options.
244 A design goal of StatusNet is that the basic Web functionality should
245 work on even the most restrictive commercial hosting services.
246 However, additional functionality, such as receiving messages by
247 Jabber/GTalk, require that you be able to run long-running processes
248 on your account. In addition, posting by email or from SMS require
249 that you be able to install a mail filter in your mail server.
254 Installing the basic StatusNet Web component is relatively easy,
255 especially if you've previously installed PHP/MySQL packages.
257 1. Unpack the tarball you downloaded on your Web server. Usually a
258 command like this will work:
260 tar zxf statusnet-0.8.2.tar.gz
262 ...which will make a statusnet-0.8.2 subdirectory in your current
263 directory. (If you don't have shell access on your Web server, you
264 may have to unpack the tarball on your local computer and FTP the
265 files to the server.)
267 2. Move the tarball to a directory of your choosing in your Web root
268 directory. Usually something like this will work:
270 mv statusnet-0.8.2 /var/www/mublog
272 This will make your StatusNet instance available in the mublog path of
273 your server, like "http://example.net/mublog". "microblog" or
274 "statusnet" might also be good path names. If you know how to
275 configure virtual hosts on your web server, you can try setting up
276 "http://micro.example.net/" or the like.
278 3. Make your target directory writeable by the Web server.
280 chmod a+w /var/www/mublog/
282 On some systems, this will probably work:
284 chgrp www-data /var/www/mublog/
285 chmod g+w /var/www/mublog/
287 If your Web server runs as another user besides "www-data", try
288 that user's default group instead. As a last resort, you can create
289 a new group like "mublog" and add the Web server's user to the group.
291 4. You should also take this moment to make your avatar, background, and
292 file subdirectories writeable by the Web server. An insecure way to do
295 chmod a+w /var/www/mublog/avatar
296 chmod a+w /var/www/mublog/background
297 chmod a+w /var/www/mublog/file
299 You can also make the avatar, background, and file directories
300 writeable by the Web server group, as noted above.
302 5. Create a database to hold your microblog data. Something like this
305 mysqladmin -u "username" --password="password" create statusnet
307 Note that StatusNet must have its own database; you can't share the
308 database with another program. You can name it whatever you want,
311 (If you don't have shell access to your server, you may need to use
312 a tool like PHPAdmin to create a database. Check your hosting
313 service's documentation for how to create a new MySQL database.)
315 6. Create a new database account that StatusNet will use to access the
316 database. If you have shell access, this will probably work from the
319 GRANT ALL on statusnet.*
320 TO 'lacuser'@'localhost'
321 IDENTIFIED BY 'lacpassword';
323 You should change 'lacuser' and 'lacpassword' to your preferred new
324 username and password. You may want to test logging in to MySQL as
327 7. In a browser, navigate to the StatusNet install script; something like:
329 http://yourserver.example.com/mublog/install.php
331 Enter the database connection information and your site name. The
332 install program will configure your site and install the initial,
333 almost-empty database.
335 8. You should now be able to navigate to your microblog's main directory
336 and see the "Public Timeline", which will be empty. If not, magic
337 has happened! You can now register a new user, post some notices,
338 edit your profile, etc. However, you may want to wait to do that stuff
339 if you think you can set up "fancy URLs" (see below), since some
340 URLs are stored in the database.
345 By default, StatusNet will use URLs that include the main PHP program's
346 name in them. For example, a user's home profile might be
349 http://example.org/mublog/index.php/mublog/fred
351 On certain systems that don't support this kind of syntax, they'll
354 http://example.org/mublog/index.php?p=mublog/fred
356 It's possible to configure the software so it looks like this instead:
358 http://example.org/mublog/fred
360 These "fancy URLs" are more readable and memorable for users. To use
361 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
362 mod_redirect enabled, -OR- know how to configure "url redirection" in
365 1. Copy the htaccess.sample file to .htaccess in your StatusNet
366 directory. Note: if you have control of your server's httpd.conf or
367 similar configuration files, it can greatly improve performance to
368 import the .htaccess file into your conf file instead. If you're
369 not sure how to do it, you may save yourself a lot of headache by
370 just leaving the .htaccess file.
372 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
373 to your StatusNet installation on your server. Typically this will
374 be the path to your StatusNet directory relative to your Web root.
376 3. Add or uncomment or change a line in your config.php file so it says:
378 $config['site']['fancy'] = true;
380 You should now be able to navigate to a "fancy" URL on your server,
383 http://example.net/mublog/main/register
385 If you changed your HTTP server configuration, you may need to restart
391 To use a Sphinx server to search users and notices, you also need
392 to install, compile and enable the sphinx pecl extension for php on the
393 client side, which itself depends on the sphinx development files.
394 "pecl install sphinx" should take care of that. Add "extension=sphinx.so"
395 to your php.ini and reload apache to enable it.
397 You can update your MySQL or Postgresql databases to drop their fulltext
398 search indexes, since they're now provided by sphinx.
400 On the sphinx server side, a script reads the main database and build
401 the keyword index. A cron job reads the database and keeps the sphinx
402 indexes up to date. scripts/sphinx-cron.sh should be called by cron
403 every 5 minutes, for example. scripts/sphinx.sh is an init.d script
404 to start and stop the sphinx search daemon.
409 StatusNet supports a cheap-and-dirty system for sending update messages
410 to mobile phones and for receiving updates from the mobile. Instead of
411 sending through the SMS network itself, which is costly and requires
412 buy-in from the wireless carriers, it simply piggybacks on the email
413 gateways that many carriers provide to their customers. So, SMS
414 configuration is essentially email configuration.
416 Each user sends to a made-up email address, which they keep a secret.
417 Incoming email that is "From" the user's SMS email address, and "To"
418 the users' secret email address on the site's domain, will be
419 converted to a notice and stored in the DB.
421 For this to work, there *must* be a domain or sub-domain for which all
422 (or most) incoming email can pass through the incoming mail filter.
424 1. Run the SQL script carrier.sql in your StatusNet database. This will
427 mysql -u "lacuser" --password="lacpassword" statusnet < db/carrier.sql
429 This will populate your database with a list of wireless carriers
430 that support email SMS gateways.
432 2. Make sure the maildaemon.php file is executable:
434 chmod +x scripts/maildaemon.php
436 Note that "daemon" is kind of a misnomer here; the script is more
437 of a filter than a daemon.
439 2. Edit /etc/aliases on your mail server and add the following line:
441 *: /path/to/statusnet/scripts/maildaemon.php
443 3. Run whatever code you need to to update your aliases database. For
444 many mail servers (Postfix, Exim, Sendmail), this should work:
448 You may need to restart your mail server for the new database to
451 4. Set the following in your config.php file:
453 $config['mail']['domain'] = 'yourdomain.example.net';
455 At this point, post-by-email and post-by-SMS-gateway should work. Note
456 that if your mail server is on a different computer from your email
457 server, you'll need to have a full installation of StatusNet, a working
458 config.php, and access to the StatusNet database from the mail server.
463 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
464 instant-messenger protocol that drives Jabber and GTalk IM. You can
465 distribute messages via XMPP using the system below; however, you
466 need to run the XMPP incoming daemon to allow incoming messages as
469 1. You may want to strongly consider setting up your own XMPP server.
470 Ejabberd, OpenFire, and JabberD are all Open Source servers.
471 Jabber, Inc. provides a high-performance commercial server.
473 2. You must register a Jabber ID (JID) with your new server. It helps
474 to choose a name like "update@example.com" or "notice" or something
475 similar. Alternately, your "update JID" can be registered on a
476 publicly-available XMPP service, like jabber.org or GTalk.
478 StatusNet will not register the JID with your chosen XMPP server;
479 you need to do this manually, with an XMPP client like Gajim,
480 Telepathy, or Pidgin.im.
482 3. Configure your site's XMPP variables, as described below in the
483 configuration section.
485 On a default installation, your site can broadcast messages using
486 XMPP. Users won't be able to post messages using XMPP unless you've
487 got the XMPP daemon running. See 'Queues and daemons' below for how
488 to set that up. Also, once you have a sizable number of users, sending
489 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
490 can really slow down your site; it may cause posting to timeout.
492 NOTE: stream_select(), a crucial function for network programming, is
493 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
494 work around this bug in StatusNet; current recommendation is to move
495 off of amd64 to another server.
500 You can send *all* messages from your microblogging site to a
501 third-party service using XMPP. This can be useful for providing
502 search, indexing, bridging, or other cool services.
504 To configure a downstream site to receive your public stream, add
505 their "JID" (Jabber ID) to your config.php as follows:
507 $config['xmpp']['public'][] = 'downstream@example.net';
509 (Don't miss those square brackets at the end.) Note that your XMPP
510 broadcasting must be configured as mentioned above. Although you can
511 send out messages at "Web time", high-volume sites should strongly
512 consider setting up queues and daemons.
517 Some activities that StatusNet needs to do, like broadcast OMB, SMS,
518 and XMPP messages, can be 'queued' and done by off-line bots instead.
519 For this to work, you must be able to run long-running offline
520 processes, either on your main Web server or on another server you
521 control. (Your other server will still need all the above
522 prerequisites, with the exception of Apache.) Installing on a separate
523 server is probably a good idea for high-volume sites.
525 1. You'll need the "CLI" (command-line interface) version of PHP
526 installed on whatever server you use.
528 2. If you're using a separate server for queues, install StatusNet
529 somewhere on the server. You don't need to worry about the
530 .htaccess file, but make sure that your config.php file is close
531 to, or identical to, your Web server's version.
533 3. In your config.php files (both the Web server and the queues
534 server!), set the following variable:
536 $config['queue']['enabled'] = true;
538 You may also want to look at the 'daemon' section of this file for
539 more daemon options. Note that if you set the 'user' and/or 'group'
540 options, you'll need to create that user and/or group by hand.
541 They're not created automatically.
543 4. On the queues server, run the command scripts/startdaemons.sh. It
544 needs as a parameter the install path; if you run it from the
545 StatusNet dir, "." should suffice.
547 This will run eight (for now) queue handlers:
549 * xmppdaemon.php - listens for new XMPP messages from users and stores
550 them as notices in the database.
551 * jabberqueuehandler.php - sends queued notices in the database to
552 registered users who should receive them.
553 * publicqueuehandler.php - sends queued notices in the database to
554 public feed listeners.
555 * ombqueuehandler.php - sends queued notices to OpenMicroBlogging
556 recipients on foreign servers.
557 * smsqueuehandler.php - sends queued notices to SMS-over-email addresses
559 * xmppconfirmhandler.php - sends confirmation messages to registered
561 * twitterqueuehandler.php - sends queued notices to Twitter for user
562 who have opted to set up Twitter bridging.
563 * facebookqueuehandler.php - sends queued notices to Facebook for users
564 of the built-in Facebook application.
566 Note that these queue daemons are pretty raw, and need your care. In
567 particular, they leak memory, and you may want to restart them on a
568 regular (daily or so) basis with a cron job. Also, if they lose
569 the connection to the XMPP server for too long, they'll simply die. It
570 may be a good idea to use a daemon-monitoring service, like 'monit',
571 to check their status and keep them running.
573 All the daemons write their process IDs (pids) to /var/run/ by
574 default. This can be useful for starting, stopping, and monitoring the
577 Since version 0.8.0, it's now possible to use a STOMP server instead of
578 our kind of hacky home-grown DB-based queue solution. See the "queues"
579 config section below for how to configure to use STOMP. As of this
580 writing, the software has been tested with ActiveMQ (
587 As of 0.8.1, OAuth is used to to access protected resources on Twitter
588 instead of HTTP Basic Auth. To use Twitter bridging you will need
589 to register your instance of StatusNet as an application on Twitter
590 (http://twitter.com/apps), and update the following variables in your
591 config.php with the consumer key and secret Twitter generates for you:
593 $config['twitter']['consumer_key'] = 'YOURKEY';
594 $config['twitter']['consumer_secret'] = 'YOURSECRET';
596 When registering your application with Twitter set the type to "Browser"
597 and your Callback URL to:
599 http://example.org/mublog/twitter/authorization
601 The default access type should be, "Read & Write".
603 * Importing statuses from Twitter
605 To allow your users to import their friends' Twitter statuses, you will
606 need to enable the bidirectional Twitter bridge in config.php:
608 $config['twitterbridge']['enabled'] = true;
610 and run the TwitterStatusFetcher daemon (scripts/twitterstatusfetcher.php).
611 Additionally, you will want to set the integration source variable,
612 which will keep notices posted to Twitter via StatusNet from looping
613 back. The integration source should be set to the name of your
614 application, exactly as you specified it on the settings page for your
615 StatusNet application on Twitter, e.g.:
617 $config['integration']['source'] = 'YourApp';
619 * Twitter Friends Syncing
621 Users may set a flag in their settings ("Subscribe to my Twitter friends
622 here" under the Twitter tab) to have StatusNet attempt to locate and
623 subscribe to "friends" (people they "follow") on Twitter who also have
624 accounts on your StatusNet system, and who have previously set up a link
625 for automatically posting notices to Twitter.
627 As of 0.8.0, this is no longer accomplished via a cron job. Instead you
628 must run the SyncTwitterFriends daemon (scripts/synctwitterfreinds.php).
630 Built-in Facebook Application
631 -----------------------------
633 StatusNet's Facebook application allows your users to automatically
634 update their Facebook statuses with their latest notices, invite
635 their friends to use the app (and thus your site), view their notice
636 timelines, and post notices -- all from within Facebook. The application
637 is built into StatusNet and runs on your host. For automatic Facebook
638 status updating to work you will need to enable queuing and run the
639 facebookqueuehandler.php daemon (see the "Queues and daemons" section
642 Quick setup instructions*:
644 Install the Facebook Developer application on Facebook:
646 http://www.facebook.com/developers/
648 Use it to create a new application and generate an API key and secret.
649 Uncomment the Facebook app section of your config.php and copy in the
650 key and secret, e.g.:
652 # Config section for the built-in Facebook application
653 $config['facebook']['apikey'] = 'APIKEY';
654 $config['facebook']['secret'] = 'SECRET';
656 In Facebook's application editor, specify the following URLs for your app:
658 - Canvas Callback URL: http://example.net/mublog/facebook/
659 - Post-Remove Callback URL: http://example.net/mublog/facebook/remove
660 - Post-Add Redirect URL: http://apps.facebook.com/yourapp/
661 - Canvas Page URL: http://apps.facebook.com/yourapp/
663 (Replace 'example.net' with your host's URL, 'mublog' with the path
664 to your StatusNet installation, and 'yourapp' with the name of the
665 Facebook application you created.)
667 Additionally, Choose "Web" for Application type in the Advanced tab.
668 In the "Canvas setting" section, choose the "FBML" for Render Method,
669 "Smart Size" for IFrame size, and "Full width (760px)" for Canvas Width.
670 Everything else can be left with default values.
672 *For more detailed instructions please see the installation guide on the
675 http://status.net/trac/wiki/FacebookApplication
680 Sitemap files <http://sitemaps.org/> are a very nice way of telling
681 search engines and other interested bots what's available on your site
682 and what's changed recently. You can generate sitemap files for your
685 1. Choose your sitemap URL layout. StatusNet creates a number of
686 sitemap XML files for different parts of your site. You may want to
687 put these in a sub-directory of your StatusNet directory to avoid
688 clutter. The sitemap index file tells the search engines and other
689 bots where to find all the sitemap files; it *must* be in the main
690 installation directory or higher. Both types of file must be
691 available through HTTP.
693 2. To generate your sitemaps, run the following command on your server:
695 php scripts/sitemap.php -f index-file-path -d sitemap-directory -u URL-prefix-for-sitemaps
697 Here, index-file-path is the full path to the sitemap index file,
698 like './sitemapindex.xml'. sitemap-directory is the directory where
699 you want the sitemaps stored, like './sitemaps/' (make sure the dir
700 exists). URL-prefix-for-sitemaps is the full URL for the sitemap dir,
701 typically something like <http://example.net/mublog/sitemaps/>.
703 You can use several methods for submitting your sitemap index to
704 search engines to get your site indexed. One is to add a line like the
705 following to your robots.txt file:
707 Sitemap: /mublog/sitemapindex.xml
709 This is a good idea for letting *all* Web spiders know about your
710 sitemap. You can also submit sitemap files to major search engines
711 using their respective "Webmaster centres"; see sitemaps.org for links
717 There are two themes shipped with this version of StatusNet: "identica",
718 which is what the Identi.ca site uses, and "default", which is a good
719 basis for other sites.
721 As of right now, your ability to change the theme is site-wide; users
722 can't choose their own theme. Additionally, the only thing you can
723 change in the theme is CSS stylesheets and some image files; you can't
724 change the HTML output, like adding or removing menu items.
726 You can choose a theme using the $config['site']['theme'] element in
727 the config.php file. See below for details.
729 You can add your own theme by making a sub-directory of the 'theme'
730 subdirectory with the name of your theme. Each theme can have the
733 display.css: a CSS2 file for "default" styling for all browsers.
734 ie6.css: a CSS2 file for override styling for fixing up Internet
736 ie7.css: a CSS2 file for override styling for fixing up Internet
738 logo.png: a logo image for the site.
739 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
740 users who don't upload their own.
741 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
742 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
743 listing on profile pages.
745 You may want to start by copying the files from the default theme to
748 NOTE: the HTML generated by StatusNet changed *radically* between
749 version 0.6.x and 0.7.x. Older themes will need signification
750 modification to use the new output format.
755 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
756 Theoretically, you can add your own sub-directory to the locale/
757 subdirectory to add a new language to your system. You'll need to
758 compile the ".po" files into ".mo" files, however.
760 Contributions of translation information to StatusNet are very easy:
761 you can use the Web interface at http://status.net/pootle/ to add one
762 or a few or lots of new translations -- or even new languages. You can
763 also download more up-to-date .po files there, if you so desire.
768 There is no built-in system for doing backups in StatusNet. You can make
769 backups of a working StatusNet system by backing up the database and
770 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
771 and to backup the Web directory, try tar.
776 The administrator can set the "private" flag for a site so that it's
777 not visible to non-logged-in users. This might be useful for
778 workgroups who want to share a microblogging site for project
779 management, but host it on a public server.
781 Note that this is an experimental feature; total privacy is not
782 guaranteed or ensured. Also, privacy is all-or-nothing for a site; you
783 can't have some accounts or notices private, and others public.
784 Finally, the interaction of private sites with OpenMicroBlogging is
785 undefined. Remote users won't be able to subscribe to users on a
786 private site, but users of the private site may be able to subscribe
787 to users on a remote site. (Or not... it's not well tested.) The
788 "proper behaviour" hasn't been defined here, so handle with care.
793 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
794 incorrectly-stored international characters ("UTF-8"). For new
795 installations, it will now store non-ASCII characters correctly.
796 However, older installations will have the incorrect storage, and will
797 consequently show up "wrong" in browsers. See below for how to deal
800 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
801 been tracking the "git" version of the software, you will probably
802 want to upgrade and keep your existing data. There is no automated
803 upgrade procedure in StatusNet 0.8.2. Try these step-by-step
804 instructions; read to the end first before trying them.
806 0. Download StatusNet and set up all the prerequisites as if you were
808 1. Make backups of both your database and your Web directory. UNDER NO
809 CIRCUMSTANCES should you try to do an upgrade without a known-good
810 backup. You have been warned.
811 2. Shut down Web access to your site, either by turning off your Web
812 server or by redirecting all pages to a "sorry, under maintenance"
814 3. Shut down XMPP access to your site, typically by shutting down the
815 xmppdaemon.php process and all other daemons that you're running.
816 If you've got "monit" or "cron" automatically restarting your
817 daemons, make sure to turn that off, too.
818 4. Shut down SMS and email access to your site. The easy way to do
819 this is to comment out the line piping incoming email to your
820 maildaemon.php file, and running something like "newaliases".
821 5. Once all writing processes to your site are turned off, make a
822 final backup of the Web directory and database.
823 6. Move your StatusNet directory to a backup spot, like "mublog.bak".
824 7. Unpack your StatusNet 0.8.2 tarball and move it to "mublog" or
825 wherever your code used to be.
826 8. Copy the config.php file and avatar directory from your old
827 directory to your new directory.
828 9. Copy htaccess.sample to .htaccess in the new directory. Change the
829 RewriteBase to use the correct path.
830 10. Rebuild the database. (You can safely skip this step and go to #12
831 if you're upgrading from another 0.8.x version).
833 NOTE: this step is destructive and cannot be
834 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
835 do it without a known-good backup!
837 If your database is at version 0.7.4, you can run a special upgrade
840 mysql -u<rootuser> -p<rootpassword> <database> db/074to080.sql
842 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
843 BACKUP run the rebuilddb.sh script like this:
845 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
847 Here, rootuser and rootpassword are the username and password for a
848 user who can drop and create databases as well as tables; typically
849 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
850 your database and rebuilds it; if there is an error you have no
851 database. Make sure you have a backup.
852 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
853 which operates slightly differently. Read the documentation in that
854 script before running it.
855 11. Use mysql or psql client to log into your database and make sure that
856 the notice, user, profile, subscription etc. tables are non-empty.
857 12. Turn back on the Web server, and check that things still work.
858 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
859 bots have changed since version 0.5; see above for details.
861 If you're upgrading from very old versions, you may want to look at
862 the fixup_* scripts in the scripts directories. These will store some
863 precooked data in the DB. All upgraders should check out the inboxes
866 NOTE: the database definition file, laconica.ini, has been renamed to
867 statusnet.ini (since this is the recommended database name). If you
868 have a line in your config.php pointing to the old name, you'll need
874 Before version 0.6.2, the page showing all notices from people the
875 user is subscribed to ("so-and-so with friends") was calculated at run
876 time. Starting with 0.6.2, we have a new data structure for holding a
877 user's "notice inbox". (Note: distinct from the "message inbox", which
878 is the "inbox" tab in the UI. The notice inbox appears under the
881 Notices are added to the inbox when they're created. This speeds up
882 the query considerably, and also allows us the opportunity, in the
883 future, to add different kind of notices to an inbox -- like @-replies
884 or subscriptions to search terms or hashtags.
886 Notice inboxes are enabled by default for new installations. If you
887 are upgrading an existing site, this means that your users will see
888 empty "Personal" pages. The following steps will help you fix the
891 0. $config['inboxes']['enabled'] can be set to one of three values. If
892 you set it to 'false', the site will work as before. Support for this
893 will probably be dropped in future versions.
894 1. Setting the flag to 'transitional' means that you're in transition.
895 In this mode, the code will run the "new query" or the "old query"
896 based on whether the user's inbox has been updated.
897 2. After setting the flag to "transitional", you can run the
898 fixup_inboxes.php script to create the inboxes. You may want to set
899 the memory limit high. You can re-run it without ill effect.
900 3. When fixup_inboxes is finished, you can set the enabled flag to
903 NOTE: As of version 0.8.1 notice inboxes are automatically trimmed back
904 to ~1000 notices every once in a while.
906 NOTE: we will drop support for non-inboxed sites in the 0.9.x version
907 of StatusNet. It's time to switch now!
912 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
913 international characters ("UTF-8"). This fix is not
914 backwards-compatible; installations from before 0.7.4 will show
915 non-ASCII characters of old notices incorrectly. This section explains
918 0. You can disable the new behaviour by setting the 'db''utf8' config
919 option to "false". You should only do this until you're ready to
920 convert your DB to the new format.
921 1. When you're ready to convert, you can run the fixup_utf8.php script
922 in the scripts/ subdirectory. If you've had the "new behaviour"
923 enabled (probably a good idea), you can give the ID of the first
924 "new" notice as a parameter, and only notices before that one will
925 be converted. Notices are converted in reverse chronological order,
926 so the most recent (and visible) ones will be converted first. The
927 script should work whether or not you have the 'db''utf8' config
929 2. When you're ready, set $config['db']['utf8'] to true, so that
930 new notices will be stored correctly.
932 Configuration options
933 =====================
935 The main configuration file for StatusNet (excepting configurations for
936 dependency software) is config.php in your StatusNet directory. If you
937 edit any other file in the directory, like lib/common.php (where most
938 of the defaults are defined), you will lose your configuration options
939 in any upgrade, and you will wish that you had been more careful.
941 Starting with version 0.7.1, you can put config files in the
942 /etc/statusnet/ directory on your server, if it exists. Config files
943 will be included in this order:
945 * /etc/statusnet/statusnet.php - server-wide config
946 * /etc/statusnet/<servername>.php - for a virtual host
947 * /etc/statusnet/<servername>_<pathname>.php - for a path
948 * INSTALLDIR/config.php - for a particular implementation
950 Almost all configuration options are made through a two-dimensional
951 associative array, cleverly named $config. A typical configuration
954 $config['section']['option'] = value;
956 For brevity, the following documentation describes each section and
962 This section is a catch-all for site-wide variables.
964 name: the name of your site, like 'YourCompany Microblog'.
965 server: the server part of your site's URLs, like 'example.net'.
966 path: The path part of your site's URLs, like 'mublog' or ''
968 fancy: whether or not your site uses fancy URLs (see Fancy URLs
969 section above). Default is false.
970 logfile: full path to a file for StatusNet to save logging
971 information to. You may want to use this if you don't have
973 logdebug: whether to log additional debug info like backtraces on
974 hard errors. Default false.
975 locale_path: full path to the directory for locale data. Unless you
976 store all your locale data in one place, you probably
977 don't need to use this.
978 language: default language for your site. Defaults to US English.
979 languages: A list of languages supported on your site. Typically you'd
980 only change this if you wanted to disable support for one
982 "unset($config['site']['languages']['de'])" will disable
984 theme: Theme for your site (see Theme section). Two themes are
985 provided by default: 'default' and 'stoica' (the one used by
986 Identi.ca). It's appreciated if you don't use the 'stoica' theme
987 except as the basis for your own.
988 email: contact email address for your site. By default, it's extracted
989 from your Web server environment; you may want to customize it.
990 broughtbyurl: name of an organization or individual who provides the
991 service. Each page will include a link to this name in the
992 footer. A good way to link to the blog, forum, wiki,
993 corporate portal, or whoever is making the service available.
994 broughtby: text used for the "brought by" link.
995 timezone: default timezone for message display. Users can set their
996 own time zone. Defaults to 'UTC', which is a pretty good default.
997 closed: If set to 'true', will disallow registration on your site.
998 This is a cheap way to restrict accounts to only one
999 individual or group; just register the accounts you want on
1000 the service, *then* set this variable to 'true'.
1001 inviteonly: If set to 'true', will only allow registration if the user
1002 was invited by an existing user.
1003 openidonly: If set to 'true', will only allow registrations and logins
1005 private: If set to 'true', anonymous users will be redirected to the
1006 'login' page. Also, API methods that normally require no
1007 authentication will require it. Note that this does not turn
1008 off registration; use 'closed' or 'inviteonly' for the
1010 notice: A plain string that will appear on every page. A good place
1011 to put introductory information about your service, or info about
1012 upgrades and outages, or other community info. Any HTML will
1014 logo: URL of an image file to use as the logo for the site. Overrides
1015 the logo in the theme, if any.
1016 ssl: Whether to use SSL and https:// URLs for some or all pages.
1017 Possible values are 'always' (use it for all pages), 'never'
1018 (don't use it for any pages), or 'sometimes' (use it for
1019 sensitive pages that include passwords like login and registration,
1020 but not for regular pages). Default to 'never'.
1021 sslserver: use an alternate server name for SSL URLs, like
1022 'secure.example.org'. You should be careful to set cookie
1023 parameters correctly so that both the SSL server and the
1024 "normal" server can access the session cookie and
1025 preferably other cookies as well.
1026 shorturllength: Length of URL at which URLs in a message exceeding 140
1027 characters will be sent to the user's chosen
1029 dupelimit: minimum time allowed for one person to say the same thing
1030 twice. Default 60s. Anything lower is considered a user
1036 This section is a reference to the configuration options for
1037 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
1038 set are listed below for clarity.
1040 database: a DSN (Data Source Name) for your StatusNet database. This is
1041 in the format 'protocol://username:password@hostname/databasename',
1042 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
1043 really know what you're doing), 'username' is the username,
1044 'password' is the password, and etc.
1045 ini_yourdbname: if your database is not named 'statusnet', you'll need
1046 to set this to point to the location of the
1047 statusnet.ini file. Note that the real name of your database
1048 should go in there, not literally 'yourdbname'.
1049 db_driver: You can try changing this to 'MDB2' to use the other driver
1050 type for DB_DataObject, but note that it breaks the OpenID
1051 libraries, which only support PEAR::DB.
1052 debug: On a database error, you may get a message saying to set this
1053 value to 5 to see debug messages in the browser. This breaks
1054 just about all pages, and will also expose the username and
1056 quote_identifiers: Set this to true if you're using postgresql.
1057 type: either 'mysql' or 'postgresql' (used for some bits of
1058 database-type-specific SQL in the code). Defaults to mysql.
1059 mirror: you can set this to an array of DSNs, like the above
1060 'database' value. If it's set, certain read-only actions will
1061 use a random value out of this array for the database, rather
1062 than the one in 'database' (actually, 'database' is overwritten).
1063 You can offload a busy DB server by setting up MySQL replication
1064 and adding the slaves to this array. Note that if you want some
1065 requests to go to the 'database' (master) server, you'll need
1066 to include it in this array, too.
1067 utf8: whether to talk to the database in UTF-8 mode. This is the default
1068 with new installations, but older sites may want to turn it off
1069 until they get their databases fixed up. See "UTF-8 database"
1075 By default, StatusNet sites log error messages to the syslog facility.
1076 (You can override this using the 'logfile' parameter described above).
1078 appname: The name that StatusNet uses to log messages. By default it's
1079 "statusnet", but if you have more than one installation on the
1080 server, you may want to change the name for each instance so
1081 you can track log messages more easily.
1082 priority: level to log at. Currently ignored.
1083 facility: what syslog facility to used. Defaults to LOG_USER, only
1084 reset if you know what syslog is and have a good reason
1090 You can configure the software to queue time-consuming tasks, like
1091 sending out SMS email or XMPP messages, for off-line processing. See
1092 'Queues and daemons' above for how to set this up.
1094 enabled: Whether to uses queues. Defaults to false.
1095 subsystem: Which kind of queueserver to use. Values include "db" for
1096 our hacked-together database queuing (no other server
1097 required) and "stomp" for a stomp server.
1098 stomp_server: "broker URI" for stomp server. Something like
1099 "tcp://hostname:61613". More complicated ones are
1100 possible; see your stomp server's documentation for
1102 queue_basename: a root name to use for queues (stomp only). Typically
1103 something like '/queue/sitename/' makes sense.
1104 stomp_username: username for connecting to the stomp server; defaults
1106 stomp_password: password for connecting to the stomp server; defaults
1111 The default license to use for your users notices. The default is the
1112 Creative Commons Attribution 3.0 license, which is probably the right
1113 choice for any public site. Note that some other servers will not
1114 accept notices if you apply a stricter license than this.
1116 url: URL of the license, used for links.
1117 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1118 image: A button shown on each page for the license.
1123 This is for configuring out-going email. We use PEAR's Mail module,
1124 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1126 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1127 'smtp'. Defaults to PEAR's default, 'mail'.
1128 params: if the mail backend requires any parameters, you can provide
1129 them in an associative array.
1134 This is for configuring nicknames in the service.
1136 blacklist: an array of strings for usernames that may not be
1137 registered. A default array exists for strings that are
1138 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1139 but you may want to add others if you have other software
1140 installed in a subdirectory of StatusNet or if you just
1141 don't want certain words used as usernames.
1142 featured: an array of nicknames of 'featured' users of the site.
1143 Can be useful to draw attention to well-known users, or
1144 interesting people, or whatever.
1149 For configuring avatar access.
1151 dir: Directory to look for avatar files and to put them into.
1152 Defaults to avatar subdirectory of install directory; if
1153 you change it, make sure to change path, too.
1154 path: Path to avatars. Defaults to path for avatar subdirectory,
1155 but you can change it if you wish. Note that this will
1156 be included with the avatar server, too.
1157 server: If set, defines another server where avatars are stored in the
1158 root directory. Note that the 'avatar' subdir still has to be
1159 writeable. You'd typically use this to split HTTP requests on
1160 the client to speed up page loading, either with another
1161 virtual server or with an NFS or SAMBA share. Clients
1162 typically only make 2 connections to a single server at a
1163 time <http://ur1.ca/6ih>, so this can parallelize the job.
1169 For configuring the public stream.
1171 localonly: If set to true, only messages posted by users of this
1172 service (rather than other services, filtered through OMB)
1173 are shown in the public stream. Default true.
1174 blacklist: An array of IDs of users to hide from the public stream.
1175 Useful if you have someone making excessive Twitterfeed posts
1176 to the site, other kinds of automated posts, testing bots, etc.
1177 autosource: Sources of notices that are from automatic posters, and thus
1178 should be kept off the public timeline. Default empty.
1183 server: Like avatars, you can speed up page loading by pointing the
1184 theme file lookup to another server (virtual or real).
1185 Defaults to NULL, meaning to use the site server.
1186 dir: Directory where theme files are stored. Used to determine
1187 whether to show parts of a theme file. Defaults to the theme
1188 subdirectory of the install directory.
1189 path: Path part of theme URLs, before the theme name. Relative to the
1190 theme server. It may make sense to change this path when upgrading,
1191 (using version numbers as the path) to make sure that all files are
1192 reloaded by caching clients or proxies. Defaults to null,
1193 which means to use the site path + '/theme'.
1198 For configuring the XMPP sub-system.
1200 enabled: Whether to accept and send messages by XMPP. Default false.
1201 server: server part of XMPP ID for update user.
1202 port: connection port for clients. Default 5222, which you probably
1203 shouldn't need to change.
1204 user: username for the client connection. Users will receive messages
1205 from 'user'@'server'.
1206 resource: a unique identifier for the connection to the server. This
1207 is actually used as a prefix for each XMPP component in the system.
1208 password: password for the user account.
1209 host: some XMPP domains are served by machines with a different
1210 hostname. (For example, @gmail.com GTalk users connect to
1211 talk.google.com). Set this to the correct hostname if that's the
1212 case with your server.
1213 encryption: Whether to encrypt the connection between StatusNet and the
1214 XMPP server. Defaults to true, but you can get
1215 considerably better performance turning it off if you're
1216 connecting to a server on the same machine or on a
1218 debug: if turned on, this will make the XMPP library blurt out all of
1219 the incoming and outgoing messages as XML stanzas. Use as a
1220 last resort, and never turn it on if you don't have queues
1221 enabled, since it will spit out sensitive data to the browser.
1222 public: an array of JIDs to send _all_ notices to. This is useful for
1223 participating in third-party search and archiving services.
1228 For configuring invites.
1230 enabled: Whether to allow users to send invites. Default true.
1235 For configuring OpenID.
1237 enabled: Whether to allow users to register and login using OpenID. Default
1243 Miscellaneous tagging stuff.
1245 dropoff: Decay factor for tag listing, in seconds.
1246 Defaults to exponential decay over ten days; you can twiddle
1247 with it to try and get better results for your site.
1252 Settings for the "popular" section of the site.
1254 dropoff: Decay factor for popularity listing, in seconds.
1255 Defaults to exponential decay over ten days; you can twiddle
1256 with it to try and get better results for your site.
1261 For daemon processes.
1263 piddir: directory that daemon processes should write their PID file
1264 (process ID) to. Defaults to /var/run/, which is where this
1265 stuff should usually go on Unix-ish systems.
1266 user: If set, the daemons will try to change their effective user ID
1267 to this user before running. Probably a good idea, especially if
1268 you start the daemons as root. Note: user name, like 'daemon',
1270 group: If set, the daemons will try to change their effective group ID
1271 to this named group. Again, a name, not a numerical ID.
1276 You can get a significant boost in performance by caching some
1277 database data in memcached <http://www.danga.com/memcached/>.
1279 enabled: Set to true to enable. Default false.
1280 server: a string with the hostname of the memcached server. Can also
1281 be an array of hostnames, if you've got more than one server.
1282 base: memcached uses key-value pairs to store data. We build long,
1283 funny-looking keys to make sure we don't have any conflicts. The
1284 base of the key is usually a simplified version of the site name
1285 (like "Identi.ca" => "identica"), but you can overwrite this if
1286 you need to. You can safely ignore it if you only have one
1287 StatusNet site using your memcached server.
1288 port: Port to connect to; defaults to 11211.
1293 You can get a significant boost in performance using Sphinx Search
1294 instead of your database server to search for users and notices.
1295 <http://sphinxsearch.com/>.
1297 enabled: Set to true to enable. Default false.
1298 server: a string with the hostname of the sphinx server.
1299 port: an integer with the port number of the sphinx server.
1306 enabled: Whether to enable post-by-email. Defaults to true. You will
1307 also need to set up maildaemon.php.
1312 For SMS integration.
1314 enabled: Whether to enable SMS integration. Defaults to true. Queues
1315 should also be enabled.
1320 For Twitter integration
1322 enabled: Whether to enable Twitter integration. Defaults to true.
1323 Queues should also be enabled.
1328 A catch-all for integration with other systems.
1330 source: The name to use for the source of posts to Twitter. Defaults
1331 to 'statusnet', but if you request your own source name from
1332 Twitter <http://twitter.com/help/request_source>, you can use
1333 that here instead. Status updates on Twitter will then have
1335 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1342 enabled: A three-valued flag for whether to use notice inboxes (see
1343 upgrading info above for notes about this change). Can be
1344 'false', 'true', or '"transitional"'.
1349 For notice-posting throttles.
1351 enabled: Whether to throttle posting. Defaults to false.
1352 count: Each user can make this many posts in 'timespan' seconds. So, if count
1353 is 100 and timespan is 3600, then there can be only 100 posts
1354 from a user every hour.
1355 timespan: see 'count'.
1362 banned: an array of usernames and/or profile IDs of 'banned' profiles.
1363 The site will reject any notices by these users -- they will
1364 not be accepted at all. (Compare with blacklisted users above,
1365 whose posts just won't show up in the public stream.)
1370 Options with new users.
1372 default: nickname of a user account to automatically subscribe new
1373 users to. Typically this would be system account for e.g.
1374 service updates or announcements. Users are able to unsub
1375 if they want. Default is null; no auto subscribe.
1376 welcome: nickname of a user account that sends welcome messages to new
1377 users. Can be the same as 'default' account, although on
1378 busy servers it may be a good idea to keep that one just for
1379 'urgent' messages. Default is null; no message.
1381 If either of these special user accounts are specified, the users should
1382 be created before the configuration is updated.
1387 The software will, by default, send statistical snapshots about the
1388 local installation to a stats server on the status.net Web site. This
1389 data is used by the developers to prioritize development decisions. No
1390 identifying data about users or organizations is collected. The data
1391 is available to the public for review. Participating in this survey
1392 helps StatusNet developers take your needs into account when updating
1395 run: string indicating when to run the statistics. Values can be 'web'
1396 (run occasionally at Web time), 'cron' (run from a cron script),
1397 or 'never' (don't ever run). If you set it to 'cron', remember to
1398 schedule the script to run on a regular basis.
1399 frequency: if run value is 'web', how often to report statistics.
1400 Measured in Web hits; depends on how active your site is.
1401 Default is 10000 -- that is, one report every 10000 Web hits,
1403 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1404 report system, but if they go evil or disappear you may
1405 need to update this to another value. Note: if you
1406 don't want to report stats, it's much better to
1407 set 'run' to 'never' than to set this value to something
1413 The software lets users upload files with their notices. You can configure
1414 the types of accepted files by mime types and a trio of quota options:
1415 per file, per user (total), per user per month.
1417 We suggest the use of the pecl file_info extension to handle mime type
1420 supported: an array of mime types you accept to store and distribute,
1421 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1422 setup your server to properly recognize the types you want to
1424 uploads: false to disable uploading files with notices (true by default).
1425 filecommand: The required MIME_Type library may need to use the 'file'
1426 command. It tries the one in the Web server's path, but if
1427 you're having problems with uploads, try setting this to the
1428 correct value. Note: 'file' must accept '-b' and '-i' options.
1430 For quotas, be sure you've set the upload_max_filesize and post_max_size
1431 in php.ini to be large enough to handle your upload. In httpd.conf
1432 (if you're using apache), check that the LimitRequestBody directive isn't
1433 set too low (it's optional, so it may not be there at all).
1435 file_quota: maximum size for a single file upload in bytes. A user can send
1436 any amount of notices with attachments as long as each attachment
1437 is smaller than file_quota.
1438 user_quota: total size in bytes a user can store on this server. Each user
1439 can store any number of files as long as their total size does
1440 not exceed the user_quota.
1441 monthly_quota: total size permitted in the current month. This is the total
1442 size in bytes that a user can upload each month.
1443 dir: directory accessible to the Web process where uploads should go.
1444 Defaults to the 'file' subdirectory of the install directory, which
1445 should be writeable by the Web user.
1446 server: server name to use when creating URLs for uploaded files.
1447 Defaults to null, meaning to use the default Web server. Using
1448 a virtual server here can speed up Web performance.
1449 path: URL path, relative to the server, to find files. Defaults to
1450 main path + '/file/'.
1451 filecommand: command to use for determining the type of a file. May be
1452 skipped if fileinfo extension is installed. Defaults to
1458 Options for group functionality.
1460 maxaliases: maximum number of aliases a group can have. Default 3. Set
1461 to 0 or less to prevent aliases in a group.
1466 oEmbed endpoint for multimedia attachments (links in posts).
1468 endpoint: oohembed endpoint using http://oohembed.com/ software.
1473 Some stuff for search.
1475 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1476 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1477 but requires the lame old MyISAM engine for MySQL. The latter
1478 will work with InnoDB but could be miserably slow on large
1479 systems. We'll probably add another type sometime in the future,
1480 with our own indexing system (maybe like MediaWiki's).
1487 handle: boolean. Whether we should register our own PHP session-handling
1488 code (using the database and memcache if enabled). Defaults to false.
1489 Setting this to true makes some sense on large or multi-server
1490 sites, but it probably won't hurt for smaller ones, either.
1491 debug: whether to output debugging info for session storage. Can help
1492 with weird session bugs, sometimes. Default false.
1497 Users can upload backgrounds for their pages; this section defines
1500 server: the server to use for background. Using a separate (even
1501 virtual) server for this can speed up load times. Default is
1502 null; same as site server.
1503 dir: directory to write backgrounds too. Default is '/background/'
1504 subdir of install dir.
1505 path: path to backgrounds. Default is sub-path of install path; note
1506 that you may need to change this if you change site-path too.
1511 A bi-direction bridge to Twitter (http://twitter.com/).
1513 enabled: default false. If true, will show user's Twitter friends'
1514 notices in their inbox and faves pages, only to the user. You
1515 must also run the twitterstatusfetcher.php script.
1520 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1521 notify third-party servers of updates.
1523 notify: an array of URLs for ping endpoints. Default is the empty
1524 array (no notification).
1529 Default design (colors and background) for the site. Actual appearance
1530 depends on the theme. Null values mean to use the theme defaults.
1532 backgroundcolor: Hex color of the site background.
1533 contentcolor: Hex color of the content area background.
1534 sidebarcolor: Hex color of the sidebar background.
1535 textcolor: Hex color of all non-link text.
1536 linkcolor: Hex color of all links.
1537 backgroundimage: Image to use for the background.
1538 disposition: Flags for whether or not to tile the background image.
1543 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1544 powerful plugin architecture. Important events in the code are named,
1545 like 'StartNoticeSave', and other software can register interest
1546 in those events. When the events happen, the other software is called
1547 and has a choice of accepting or rejecting the events.
1549 In the simplest case, you can add a function to config.php and use the
1550 Event::addHandler() function to hook an event:
1552 function AddGoogleLink($action)
1554 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1558 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1560 This adds a menu item to the end of the main navigation menu. You can
1561 see the list of existing events, and parameters that handlers must
1562 implement, in EVENTS.txt.
1564 The Plugin class in lib/plugin.php makes it easier to write more
1565 complex plugins. Sub-classes can just create methods named
1566 'onEventName', where 'EventName' is the name of the event (case
1567 matters!). These methods will be automatically registered as event
1568 handlers by the Plugin constructor (which you must call from your own
1569 class's constructor).
1571 Several example plugins are included in the plugins/ directory. You
1572 can enable a plugin with the following line in config.php:
1574 addPlugin('Example', array('param1' => 'value1',
1575 'param2' => 'value2'));
1577 This will look for and load files named 'ExamplePlugin.php' or
1578 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1579 plugins that ship with StatusNet) or in the local/ directory (for
1580 plugins you write yourself or that you get from somewhere else) or
1583 Plugins are documented in their own directories.
1588 The primary output for StatusNet is syslog, unless you configured a
1589 separate logfile. This is probably the first place to look if you're
1590 getting weird behaviour from StatusNet.
1592 If you're tracking the unstable version of StatusNet in the git
1593 repository (see below), and you get a compilation error ("unexpected
1594 T_STRING") in the browser, check to see that you don't have any
1595 conflicts in your code.
1597 If you upgraded to StatusNet 0.8.2 without reading the "Notice
1598 inboxes" section above, and all your users' 'Personal' tabs are empty,
1599 read the "Notice inboxes" section above.
1604 These are some myths you may see on the Web about StatusNet.
1605 Documentation from the core team about StatusNet has been pretty
1606 sparse, so some backtracking and guesswork resulted in some incorrect
1609 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1610 extremely bad idea. It's a tool built into DB_DataObject that will
1611 emit oodles of print lines directly to the browser of your users.
1612 Among these lines will be your database username and password. Do
1613 not enable this option on a production Web site for any reason.
1615 - "Edit dataobject.ini with the following settings..." dataobject.ini
1616 is a development file for the DB_DataObject framework and is not
1617 used by the running software. It was removed from the StatusNet
1618 distribution because its presence was confusing. Do not bother
1619 configuring dataobject.ini, and do not put your database username
1620 and password into the file on a production Web server; unscrupulous
1621 persons may try to read it to get your passwords.
1626 If you're adventurous or impatient, you may want to install the
1627 development version of StatusNet. To get it, use the git version
1628 control tool <http://git-scm.com/> like so:
1630 git clone git@gitorious.org:statusnet/mainline.git
1632 This is the version of the software that runs on Identi.ca and the
1633 status.net hosted service. Using it is a mixed bag. On the positive
1634 side, it usually includes the latest security and bug fix patches. On
1635 the downside, it may also include changes that require admin
1636 intervention (like running a script or even raw SQL!) that may not be
1637 documented yet. It may be a good idea to test this version before
1638 installing it on your production machines.
1640 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1645 There are several ways to get more information about StatusNet.
1647 * There is a mailing list for StatusNet developers and admins at
1648 http://mail.status.net/mailman/listinfo/statusnet-dev
1649 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1650 * The StatusNet wiki, http://status.net/wiki/
1651 * The StatusNet blog, http://status.net/blog/
1652 * The StatusNet status update, <http://status.status.net/status> (!)
1657 * Microblogging messages to http://identi.ca/evan are very welcome.
1658 * StatusNet's Trac server has a bug tracker for any defects you may find,
1659 or ideas for making things better. http://status.net/trac/
1660 * e-mail to evan@status.net will usually be read and responded to very
1661 quickly, unless the question is really hard.
1666 The following is an incomplete list of developers who've worked on
1667 StatusNet. Apologies for any oversight; please let evan@status.net know
1668 if anyone's been overlooked in error.
1670 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1671 * Zach Copley, StatusNet, Inc.
1672 * Earle Martin, StatusNet, Inc.
1673 * Marie-Claude Doyon, designer, StatusNet, Inc.
1674 * Sarven Capadisli, StatusNet, Inc.
1675 * Robin Millette, StatusNet, Inc.
1686 * Tryggvi Björgvinsson
1690 * Ken Sheppardson (Trac server, man-about-town)
1691 * Tiago 'gouki' Faria (i18n manager)
1693 * Leslie Michael Orchard
1697 * Tobias Diekershoff
1707 Thanks also to the developers of our upstream library code and to the
1708 thousands of people who have tried out Identi.ca, installed StatusNet,
1709 told their friends, and built the Open Microblogging network to what