5 StatusNet 0.9.0 ("Stand") Beta 4
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 characters, by default) messages over the Web. Users can
20 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, 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 major feature release since version 0.8.2, released Nov 1 2009.
81 Notable changes this version:
83 - Records of deleted notices are stored without the notice content.
84 - Much of the optional core featureset has been moved to plugins.
85 - OpenID support moved from core to a plugin. Helps test the strength of
86 our plugin architecture and makes it easy to disable this
87 functionality for e.g. intranet sites.
88 - Many additional hook events (see EVENTS.txt for details).
89 - OMB 0.1 support re-implemented using libomb.
90 - Re-structure database so notices, messages, bios and group
91 descriptions can be over 140 characters. Limit defined by
92 site administrator as configuration option; can be unlimited.
93 - Configuration data now optionally stored in the database, which
94 overrides any settings in config files.
95 - Twitter integration re-implemented as a plugin.
96 - Facebook integration re-implemented as a plugin.
97 - Role-based authorization framework. Users can have named roles, and
98 roles can have rights (e.g., to delete notices, change configuration
99 data, or ban uncooperative users). Default roles 'admin' (for
100 configuration) and 'moderator' (for community management) added.
101 - Plugin for PubSubHubBub (PuSH) support.
102 - Considerable code style cleanup to meet PEAR code standards.
103 - Made a common library for HTTP-client access which uses available
104 HTTP libraries where possible.
105 - Added statuses/home_timeline method to API.
106 - Hooks for plugins to handle notices offline, either by defining
107 their own queue handler scripts or to use a default plugin queue
109 - Plugins can now modify the database schema, adding their own tables
110 or modifying existing ones.
112 - Twitter API supports Web caching for some methods.
113 - Twitter API refactored into one-action-per-method.
114 - Realtime plugin supports a tear-off window.
116 - Moved all JavaScript tags to just before </body> by default,
117 significantly speeding up apparent page load time.
118 - Added a Realtime plugin for Orbited server.
119 - Added a mobile plugin to give a more mobile-phone-friendly layout
120 when a mobile browser is detected.
121 - Use CSS sprites for most common icons.
122 - Fixes for images and buttons on Web output.
123 - New plugin requires that users validate their email before posting.
124 - New plugin UserFlag lets users flag other profiles for review.
125 - Considerably better i18n support. Use TranslateWiki to update
127 - Notices and profiles now store location information.
128 - New plugin, Geonames, for turning location names and lat/long pairs
129 into structured IDs and vice versa. Architecture reusable for other
131 - Better check of license compatibility between site licenses.
132 - Some improvements in XMPP output.
133 - Media upload in the API.
134 - Replies appear in the user's inbox.
135 - Improved the UI on the bookmarklet.
136 - StatusNet identities can be used as OpenID identities.
137 - Script to register a user.
138 - Script to make someone a group admin.
139 - Script to make someone a site admin or moderator.
141 - Pluggable authentication.
142 - LDAP authentication plugin.
143 - Script for console interaction with the site (!).
144 - Users don't see group posts from people they've blocked.
145 - Admin panel interface for changing site configuration.
146 - Users can be sandboxed (limited contributions) or silenced
147 (no contributions) by moderators.
148 - Many changes to make language usage more consistent.
149 - Sphinx search moved to a plugin.
151 - Profile and group lists support hAtom.
152 - Massive refactoring of util.js.
153 - Mapstraction plugin to show maps on inbox and profile pages.
154 - Play/pause buttons for realtime notices.
155 - Support for geo microformat.
156 - Partial support for feed subscriptions, RSSCloud, PubSubHubBub.
157 - Support for geolocation in browser (Chrome, Firefox).
158 - Quit trying to negotiate HTML format. Always use text/html.
159 We lose, and so do Web standards. Boo.
160 - Better logging of request info.
161 - Better output for errors in Web interface.
162 - No longer store .mo files; these need to be generated.
164 - Events to allow pluginizing logger.
165 - New framework for plugin localization.
167 - Add support for "repeats" (similar to Twitter's "retweets").
168 - Support for repeats in Twitter API.
169 - Better notification of direct messages.
170 - New plugin to add "powered by StatusNet" to logo.
171 - Returnto works for private sites.
172 - Localisation updates, including new Persian translation.
173 - CAS authentication plugin
174 - Get rid of DB_DataObject native cache (big memory leaker)
175 - setconfig.php script to set configuration variables
176 - Blacklist plugin, to blacklist URLs and nicknames
177 - Users can set flag whether they want to share location
178 both in notice form (for one notice) and profile settings
180 - notice inboxes moved from normalized notice_inbox table to
181 denormalized inbox table
182 - Automatic compression of Memcache
183 - Memory caching pluginized
184 - Memcache, XCache, APC and Diskcache plugins
185 - A script to update user locations
186 - cache empty query results
187 - A sample plugin to show best plugin practices
188 - CacheLog plugin to debug cache accesses
189 - Require users to login to view attachments on private sites
190 - Plugin to use Mollom spam detection service
191 - Plugin for RSSCloud
192 - Add an array of default plugins
193 - A version action to give credit to contributors and plugin
195 - Daemon to read IMAP mailbox instead of using a mailbox script
196 - Pass session information between SSL and non-SSL server
197 when SSL set to 'sometimes'
198 - Major refactoring of queue handlers to manage very
199 large hosting site (like status.net)
200 - SubscriptionThrottle plugin to prevent subscription spamming
205 The following software packages are *required* for this software to
208 - PHP 5.2.3+. It may be possible to run this software on earlier
209 versions of PHP, but many of the functions used are only available
211 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
212 server. It has been primarily tested on 5.x servers, although it may
213 be possible to install on earlier (or later!) versions. The server
214 *must* support the MyISAM storage engine -- the default for most
215 MySQL servers -- *and* the InnoDB storage engine.
216 - A Web server. Preferably, you should have Apache 2.2.x with the
217 mod_rewrite extension installed and enabled.
219 Your PHP installation must include the following PHP extensions:
221 - Curl. This is for fetching files by HTTP.
222 - XMLWriter. This is for formatting XML and HTML output.
223 - MySQL. For accessing the database.
224 - GD. For scaling down avatar images.
225 - mbstring. For handling Unicode (UTF-8) encoded strings.
226 - gettext. For multiple languages. Default on many PHP installs.
228 For some functionality, you will also need the following extensions:
230 - Memcache. A client for the memcached server, which caches database
231 information in volatile memory. This is important for adequate
232 performance on high-traffic sites. You will also need a memcached
233 server to store the data in.
234 - Mailparse. Efficient parsing of email requires this extension.
235 Submission by email or SMS-over-email uses this extension.
236 - Sphinx Search. A client for the sphinx server, an alternative
237 to MySQL or Postgresql fulltext search. You will also need a
238 Sphinx server to serve the search queries.
240 You will almost definitely get 2-3 times better performance from your
241 site if you install a PHP bytecode cache/accelerator. Some well-known
242 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
243 is a proprietary accelerator installed on some hosting sites.
248 A number of external PHP libraries are used to provide basic
249 functionality and optional functionality for your system. For your
250 convenience, they are available in the "extlib" directory of this
251 package, and you do not have to download and install them. However,
252 you may want to keep them up-to-date with the latest upstream version,
253 and the URLs are listed here for your convenience.
255 - DB_DataObject http://pear.php.net/package/DB_DataObject
256 - Validate http://pear.php.net/package/Validate
257 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
258 to use the openidenabled.com version since it's more widely
259 implemented, and seems to be better supported.
260 http://openidenabled.com/php-openid/
261 - PEAR DB. Although this is an older data access system (new
262 packages should probably use PHP DBO), the OpenID libraries
263 depend on PEAR DB so we use it here, too. DB_DataObject can
264 also use PEAR MDB2, which may give you better performance
265 but won't work with OpenID.
266 http://pear.php.net/package/DB
267 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
268 - markdown.php from http://michelf.com/projects/php-markdown/
269 - PEAR Mail, for sending out mail notifications
270 http://pear.php.net/package/Mail
271 - PEAR Net_SMTP, if you use the SMTP factory for notifications
272 http://pear.php.net/package/Net_SMTP
273 - PEAR Net_Socket, if you use the SMTP factory for notifications
274 http://pear.php.net/package/Net_Socket
275 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
276 library available for PHP. http://xmpphp.googlecode.com/. Note that
277 as of this writing the version of this library that is available in
278 the extlib directory is *significantly different* from the upstream
279 version (patches have been submitted). Upgrading to the upstream
280 version may render your StatusNet site unable to send or receive XMPP
282 - Facebook library. Used for the Facebook application.
283 - PEAR Services_oEmbed. Used for some multimedia integration.
284 - PEAR HTTP_Request is an oEmbed dependency.
285 - PEAR Validate is an oEmbed dependency.
286 - PEAR Net_URL2 is an oEmbed dependency.
287 - Console_GetOpt for parsing command-line options.
289 A design goal of StatusNet is that the basic Web functionality should
290 work on even the most restrictive commercial hosting services.
291 However, additional functionality, such as receiving messages by
292 Jabber/GTalk, require that you be able to run long-running processes
293 on your account. In addition, posting by email or from SMS require
294 that you be able to install a mail filter in your mail server.
299 Installing the basic StatusNet Web component is relatively easy,
300 especially if you've previously installed PHP/MySQL packages.
302 1. Unpack the tarball you downloaded on your Web server. Usually a
303 command like this will work:
305 tar zxf statusnet-0.8.2.tar.gz
307 ...which will make a statusnet-0.8.2 subdirectory in your current
308 directory. (If you don't have shell access on your Web server, you
309 may have to unpack the tarball on your local computer and FTP the
310 files to the server.)
312 2. Move the tarball to a directory of your choosing in your Web root
313 directory. Usually something like this will work:
315 mv statusnet-0.8.2 /var/www/mublog
317 This will make your StatusNet instance available in the mublog path of
318 your server, like "http://example.net/mublog". "microblog" or
319 "statusnet" might also be good path names. If you know how to
320 configure virtual hosts on your web server, you can try setting up
321 "http://micro.example.net/" or the like.
323 3. Make your target directory writeable by the Web server.
325 chmod a+w /var/www/mublog/
327 On some systems, this will probably work:
329 chgrp www-data /var/www/mublog/
330 chmod g+w /var/www/mublog/
332 If your Web server runs as another user besides "www-data", try
333 that user's default group instead. As a last resort, you can create
334 a new group like "mublog" and add the Web server's user to the group.
336 4. You should also take this moment to make your avatar, background, and
337 file subdirectories writeable by the Web server. An insecure way to do
340 chmod a+w /var/www/mublog/avatar
341 chmod a+w /var/www/mublog/background
342 chmod a+w /var/www/mublog/file
344 You can also make the avatar, background, and file directories
345 writeable by the Web server group, as noted above.
347 5. Create a database to hold your microblog data. Something like this
350 mysqladmin -u "username" --password="password" create statusnet
352 Note that StatusNet must have its own database; you can't share the
353 database with another program. You can name it whatever you want,
356 (If you don't have shell access to your server, you may need to use
357 a tool like PHPAdmin to create a database. Check your hosting
358 service's documentation for how to create a new MySQL database.)
360 6. Create a new database account that StatusNet will use to access the
361 database. If you have shell access, this will probably work from the
364 GRANT ALL on statusnet.*
365 TO 'lacuser'@'localhost'
366 IDENTIFIED BY 'lacpassword';
368 You should change 'lacuser' and 'lacpassword' to your preferred new
369 username and password. You may want to test logging in to MySQL as
372 7. In a browser, navigate to the StatusNet install script; something like:
374 http://yourserver.example.com/mublog/install.php
376 Enter the database connection information and your site name. The
377 install program will configure your site and install the initial,
378 almost-empty database.
380 8. You should now be able to navigate to your microblog's main directory
381 and see the "Public Timeline", which will be empty. If not, magic
382 has happened! You can now register a new user, post some notices,
383 edit your profile, etc. However, you may want to wait to do that stuff
384 if you think you can set up "fancy URLs" (see below), since some
385 URLs are stored in the database.
390 By default, StatusNet will use URLs that include the main PHP program's
391 name in them. For example, a user's home profile might be
394 http://example.org/mublog/index.php/mublog/fred
396 On certain systems that don't support this kind of syntax, they'll
399 http://example.org/mublog/index.php?p=mublog/fred
401 It's possible to configure the software so it looks like this instead:
403 http://example.org/mublog/fred
405 These "fancy URLs" are more readable and memorable for users. To use
406 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
407 mod_rewrite enabled, -OR- know how to configure "url redirection" in
410 1. Copy the htaccess.sample file to .htaccess in your StatusNet
411 directory. Note: if you have control of your server's httpd.conf or
412 similar configuration files, it can greatly improve performance to
413 import the .htaccess file into your conf file instead. If you're
414 not sure how to do it, you may save yourself a lot of headache by
415 just leaving the .htaccess file.
417 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
418 to your StatusNet installation on your server. Typically this will
419 be the path to your StatusNet directory relative to your Web root.
421 3. Add or uncomment or change a line in your config.php file so it says:
423 $config['site']['fancy'] = true;
425 You should now be able to navigate to a "fancy" URL on your server,
428 http://example.net/mublog/main/register
430 If you changed your HTTP server configuration, you may need to restart
433 If it doesn't work, double-check that AllowOverride for the StatusNet
434 directory is 'All' in your Apache configuration file. This is usually
435 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
436 /etc/apache2/sites-available/default. See the Apache documentation for
437 .htaccess files for more details:
439 http://httpd.apache.org/docs/2.2/howto/htaccess.html
441 Also, check that mod_rewrite is installed and enabled:
443 http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
448 To use a Sphinx server to search users and notices, you'll need to
449 enable the SphinxSearch plugin. Add to your config.php:
451 addPlugin('SphinxSearch');
452 $config['sphinx']['server'] = 'searchhost.local';
454 You also need to install, compile and enable the sphinx pecl extension for
455 php on the client side, which itself depends on the sphinx development files.
457 See plugins/SphinxSearch/README for more details and server setup.
462 StatusNet supports a cheap-and-dirty system for sending update messages
463 to mobile phones and for receiving updates from the mobile. Instead of
464 sending through the SMS network itself, which is costly and requires
465 buy-in from the wireless carriers, it simply piggybacks on the email
466 gateways that many carriers provide to their customers. So, SMS
467 configuration is essentially email configuration.
469 Each user sends to a made-up email address, which they keep a secret.
470 Incoming email that is "From" the user's SMS email address, and "To"
471 the users' secret email address on the site's domain, will be
472 converted to a notice and stored in the DB.
474 For this to work, there *must* be a domain or sub-domain for which all
475 (or most) incoming email can pass through the incoming mail filter.
477 1. Run the SQL script carrier.sql in your StatusNet database. This will
480 mysql -u "lacuser" --password="lacpassword" statusnet < db/carrier.sql
482 This will populate your database with a list of wireless carriers
483 that support email SMS gateways.
485 2. Make sure the maildaemon.php file is executable:
487 chmod +x scripts/maildaemon.php
489 Note that "daemon" is kind of a misnomer here; the script is more
490 of a filter than a daemon.
492 2. Edit /etc/aliases on your mail server and add the following line:
494 *: /path/to/statusnet/scripts/maildaemon.php
496 3. Run whatever code you need to to update your aliases database. For
497 many mail servers (Postfix, Exim, Sendmail), this should work:
501 You may need to restart your mail server for the new database to
504 4. Set the following in your config.php file:
506 $config['mail']['domain'] = 'yourdomain.example.net';
508 At this point, post-by-email and post-by-SMS-gateway should work. Note
509 that if your mail server is on a different computer from your email
510 server, you'll need to have a full installation of StatusNet, a working
511 config.php, and access to the StatusNet database from the mail server.
516 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
517 instant-messenger protocol that drives Jabber and GTalk IM. You can
518 distribute messages via XMPP using the system below; however, you
519 need to run the XMPP incoming daemon to allow incoming messages as
522 1. You may want to strongly consider setting up your own XMPP server.
523 Ejabberd, OpenFire, and JabberD are all Open Source servers.
524 Jabber, Inc. provides a high-performance commercial server.
526 2. You must register a Jabber ID (JID) with your new server. It helps
527 to choose a name like "update@example.com" or "notice" or something
528 similar. Alternately, your "update JID" can be registered on a
529 publicly-available XMPP service, like jabber.org or GTalk.
531 StatusNet will not register the JID with your chosen XMPP server;
532 you need to do this manually, with an XMPP client like Gajim,
533 Telepathy, or Pidgin.im.
535 3. Configure your site's XMPP variables, as described below in the
536 configuration section.
538 On a default installation, your site can broadcast messages using
539 XMPP. Users won't be able to post messages using XMPP unless you've
540 got the XMPP daemon running. See 'Queues and daemons' below for how
541 to set that up. Also, once you have a sizable number of users, sending
542 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
543 can really slow down your site; it may cause posting to timeout.
545 NOTE: stream_select(), a crucial function for network programming, is
546 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
547 work around this bug in StatusNet; current recommendation is to move
548 off of amd64 to another server.
553 You can send *all* messages from your microblogging site to a
554 third-party service using XMPP. This can be useful for providing
555 search, indexing, bridging, or other cool services.
557 To configure a downstream site to receive your public stream, add
558 their "JID" (Jabber ID) to your config.php as follows:
560 $config['xmpp']['public'][] = 'downstream@example.net';
562 (Don't miss those square brackets at the end.) Note that your XMPP
563 broadcasting must be configured as mentioned above. Although you can
564 send out messages at "Web time", high-volume sites should strongly
565 consider setting up queues and daemons.
570 Some activities that StatusNet needs to do, like broadcast OMB, SMS,
571 and XMPP messages, can be 'queued' and done by off-line bots instead.
572 For this to work, you must be able to run long-running offline
573 processes, either on your main Web server or on another server you
574 control. (Your other server will still need all the above
575 prerequisites, with the exception of Apache.) Installing on a separate
576 server is probably a good idea for high-volume sites.
578 1. You'll need the "CLI" (command-line interface) version of PHP
579 installed on whatever server you use.
581 2. If you're using a separate server for queues, install StatusNet
582 somewhere on the server. You don't need to worry about the
583 .htaccess file, but make sure that your config.php file is close
584 to, or identical to, your Web server's version.
586 3. In your config.php files (both the Web server and the queues
587 server!), set the following variable:
589 $config['queue']['enabled'] = true;
591 You may also want to look at the 'daemon' section of this file for
592 more daemon options. Note that if you set the 'user' and/or 'group'
593 options, you'll need to create that user and/or group by hand.
594 They're not created automatically.
596 4. On the queues server, run the command scripts/startdaemons.sh. It
597 needs as a parameter the install path; if you run it from the
598 StatusNet dir, "." should suffice.
600 This will run the queue handlers:
602 * queuedaemon.php - polls for queued items for inbox processing and
603 pushing out to OMB, SMS, XMPP, etc.
604 * xmppdaemon.php - listens for new XMPP messages from users and stores
605 them as notices in the database; also pulls queued XMPP output from
606 queuedaemon.php to push out to clients.
608 These two daemons will automatically restart in most cases of failure
609 including memory leaks (if a memory_limit is set), but may still die
610 or behave oddly if they lose connections to the XMPP or queue servers.
612 It may be a good idea to use a daemon-monitoring service, like 'monit',
613 to check their status and keep them running.
615 All the daemons write their process IDs (pids) to /var/run/ by
616 default. This can be useful for starting, stopping, and monitoring the
619 Since version 0.8.0, it's now possible to use a STOMP server instead of
620 our kind of hacky home-grown DB-based queue solution. See the "queues"
621 config section below for how to configure to use STOMP. As of this
622 writing, the software has been tested with ActiveMQ.
627 Sitemap files <http://sitemaps.org/> are a very nice way of telling
628 search engines and other interested bots what's available on your site
629 and what's changed recently. You can generate sitemap files for your
632 1. Choose your sitemap URL layout. StatusNet creates a number of
633 sitemap XML files for different parts of your site. You may want to
634 put these in a sub-directory of your StatusNet directory to avoid
635 clutter. The sitemap index file tells the search engines and other
636 bots where to find all the sitemap files; it *must* be in the main
637 installation directory or higher. Both types of file must be
638 available through HTTP.
640 2. To generate your sitemaps, run the following command on your server:
642 php scripts/sitemap.php -f index-file-path -d sitemap-directory -u URL-prefix-for-sitemaps
644 Here, index-file-path is the full path to the sitemap index file,
645 like './sitemapindex.xml'. sitemap-directory is the directory where
646 you want the sitemaps stored, like './sitemaps/' (make sure the dir
647 exists). URL-prefix-for-sitemaps is the full URL for the sitemap dir,
648 typically something like <http://example.net/mublog/sitemaps/>.
650 You can use several methods for submitting your sitemap index to
651 search engines to get your site indexed. One is to add a line like the
652 following to your robots.txt file:
654 Sitemap: /mublog/sitemapindex.xml
656 This is a good idea for letting *all* Web spiders know about your
657 sitemap. You can also submit sitemap files to major search engines
658 using their respective "Webmaster centres"; see sitemaps.org for links
664 There are two themes shipped with this version of StatusNet: "identica",
665 which is what the Identi.ca site uses, and "default", which is a good
666 basis for other sites.
668 As of right now, your ability to change the theme is site-wide; users
669 can't choose their own theme. Additionally, the only thing you can
670 change in the theme is CSS stylesheets and some image files; you can't
671 change the HTML output, like adding or removing menu items.
673 You can choose a theme using the $config['site']['theme'] element in
674 the config.php file. See below for details.
676 You can add your own theme by making a sub-directory of the 'theme'
677 subdirectory with the name of your theme. Each theme can have the
680 display.css: a CSS2 file for "default" styling for all browsers.
681 ie6.css: a CSS2 file for override styling for fixing up Internet
683 ie7.css: a CSS2 file for override styling for fixing up Internet
685 logo.png: a logo image for the site.
686 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
687 users who don't upload their own.
688 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
689 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
690 listing on profile pages.
692 You may want to start by copying the files from the default theme to
695 NOTE: the HTML generated by StatusNet changed *radically* between
696 version 0.6.x and 0.7.x. Older themes will need signification
697 modification to use the new output format.
702 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
703 Theoretically, you can add your own sub-directory to the locale/
704 subdirectory to add a new language to your system. You'll need to
705 compile the ".po" files into ".mo" files, however.
707 Contributions of translation information to StatusNet are very easy:
708 you can use the Web interface at TranslateWiki.net to add one
709 or a few or lots of new translations -- or even new languages. You can
710 also download more up-to-date .po files there, if you so desire.
712 For info on helping with translations, see http://status.net/wiki/Translations
717 There is no built-in system for doing backups in StatusNet. You can make
718 backups of a working StatusNet system by backing up the database and
719 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
720 and to backup the Web directory, try tar.
725 The administrator can set the "private" flag for a site so that it's
726 not visible to non-logged-in users. This might be useful for
727 workgroups who want to share a microblogging site for project
728 management, but host it on a public server.
730 Note that this is an experimental feature; total privacy is not
731 guaranteed or ensured. Also, privacy is all-or-nothing for a site; you
732 can't have some accounts or notices private, and others public.
733 Finally, the interaction of private sites with OpenMicroBlogging is
734 undefined. Remote users won't be able to subscribe to users on a
735 private site, but users of the private site may be able to subscribe
736 to users on a remote site. (Or not... it's not well tested.) The
737 "proper behaviour" hasn't been defined here, so handle with care.
739 Access to file attachments can also be restricted to logged-in users only.
740 1. Add a directory outside the web root where your file uploads will be
741 stored. Usually a command like this will work:
743 mkdir /var/www/mublog-files
745 2. Make the file uploads directory writeable by the web server. An
746 insecure way to do this is:
748 chmod a+x /var/www/mublog-files
750 3. Tell StatusNet to use this directory for file uploads. Add a line
751 like this to your config.php:
753 $config['attachments']['dir'] = '/var/www/mublog-files';
758 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
759 incorrectly-stored international characters ("UTF-8"). For new
760 installations, it will now store non-ASCII characters correctly.
761 However, older installations will have the incorrect storage, and will
762 consequently show up "wrong" in browsers. See below for how to deal
765 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
766 been tracking the "git" version of the software, you will probably
767 want to upgrade and keep your existing data. There is no automated
768 upgrade procedure in StatusNet 0.8.2. Try these step-by-step
769 instructions; read to the end first before trying them.
771 0. Download StatusNet and set up all the prerequisites as if you were
773 1. Make backups of both your database and your Web directory. UNDER NO
774 CIRCUMSTANCES should you try to do an upgrade without a known-good
775 backup. You have been warned.
776 2. Shut down Web access to your site, either by turning off your Web
777 server or by redirecting all pages to a "sorry, under maintenance"
779 3. Shut down XMPP access to your site, typically by shutting down the
780 xmppdaemon.php process and all other daemons that you're running.
781 If you've got "monit" or "cron" automatically restarting your
782 daemons, make sure to turn that off, too.
783 4. Shut down SMS and email access to your site. The easy way to do
784 this is to comment out the line piping incoming email to your
785 maildaemon.php file, and running something like "newaliases".
786 5. Once all writing processes to your site are turned off, make a
787 final backup of the Web directory and database.
788 6. Move your StatusNet directory to a backup spot, like "mublog.bak".
789 7. Unpack your StatusNet 0.8.2 tarball and move it to "mublog" or
790 wherever your code used to be.
791 8. Copy the config.php file and avatar directory from your old
792 directory to your new directory.
793 9. Copy htaccess.sample to .htaccess in the new directory. Change the
794 RewriteBase to use the correct path.
795 10. Rebuild the database. (You can safely skip this step and go to #12
796 if you're upgrading from another 0.8.x version).
798 NOTE: this step is destructive and cannot be
799 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
800 do it without a known-good backup!
802 If your database is at version 0.7.4, you can run a special upgrade
805 mysql -u<rootuser> -p<rootpassword> <database> db/074to080.sql
807 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
808 BACKUP run the rebuilddb.sh script like this:
810 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
812 Here, rootuser and rootpassword are the username and password for a
813 user who can drop and create databases as well as tables; typically
814 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
815 your database and rebuilds it; if there is an error you have no
816 database. Make sure you have a backup.
817 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
818 which operates slightly differently. Read the documentation in that
819 script before running it.
820 11. Use mysql or psql client to log into your database and make sure that
821 the notice, user, profile, subscription etc. tables are non-empty.
822 12. Turn back on the Web server, and check that things still work.
823 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
824 bots have changed since version 0.5; see above for details.
826 If you're upgrading from very old versions, you may want to look at
827 the fixup_* scripts in the scripts directories. These will store some
828 precooked data in the DB. All upgraders should check out the inboxes
831 NOTE: the database definition file, laconica.ini, has been renamed to
832 statusnet.ini (since this is the recommended database name). If you
833 have a line in your config.php pointing to the old name, you'll need
839 Notice inboxes are now required. If you don't have inboxes enabled,
840 StatusNet will no longer run.
845 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
846 international characters ("UTF-8"). This fix is not
847 backwards-compatible; installations from before 0.7.4 will show
848 non-ASCII characters of old notices incorrectly. This section explains
851 0. You can disable the new behaviour by setting the 'db''utf8' config
852 option to "false". You should only do this until you're ready to
853 convert your DB to the new format.
854 1. When you're ready to convert, you can run the fixup_utf8.php script
855 in the scripts/ subdirectory. If you've had the "new behaviour"
856 enabled (probably a good idea), you can give the ID of the first
857 "new" notice as a parameter, and only notices before that one will
858 be converted. Notices are converted in reverse chronological order,
859 so the most recent (and visible) ones will be converted first. The
860 script should work whether or not you have the 'db''utf8' config
862 2. When you're ready, set $config['db']['utf8'] to true, so that
863 new notices will be stored correctly.
865 Configuration options
866 =====================
868 The main configuration file for StatusNet (excepting configurations for
869 dependency software) is config.php in your StatusNet directory. If you
870 edit any other file in the directory, like lib/common.php (where most
871 of the defaults are defined), you will lose your configuration options
872 in any upgrade, and you will wish that you had been more careful.
874 Starting with version 0.7.1, you can put config files in the
875 /etc/statusnet/ directory on your server, if it exists. Config files
876 will be included in this order:
878 * /etc/statusnet/statusnet.php - server-wide config
879 * /etc/statusnet/<servername>.php - for a virtual host
880 * /etc/statusnet/<servername>_<pathname>.php - for a path
881 * INSTALLDIR/config.php - for a particular implementation
883 Almost all configuration options are made through a two-dimensional
884 associative array, cleverly named $config. A typical configuration
887 $config['section']['option'] = value;
889 For brevity, the following documentation describes each section and
895 This section is a catch-all for site-wide variables.
897 name: the name of your site, like 'YourCompany Microblog'.
898 server: the server part of your site's URLs, like 'example.net'.
899 path: The path part of your site's URLs, like 'mublog' or ''
901 fancy: whether or not your site uses fancy URLs (see Fancy URLs
902 section above). Default is false.
903 logfile: full path to a file for StatusNet to save logging
904 information to. You may want to use this if you don't have
906 logdebug: whether to log additional debug info like backtraces on
907 hard errors. Default false.
908 locale_path: full path to the directory for locale data. Unless you
909 store all your locale data in one place, you probably
910 don't need to use this.
911 language: default language for your site. Defaults to US English.
912 Note that this is overridden if a user is logged in and has
913 selected a different language. It is also overridden if the
914 user is NOT logged in, but their browser requests a different
915 langauge. Since pretty much everybody's browser requests a
916 language, that means that changing this setting has little or
917 no effect in practice.
918 languages: A list of languages supported on your site. Typically you'd
919 only change this if you wanted to disable support for one
921 "unset($config['site']['languages']['de'])" will disable
923 theme: Theme for your site (see Theme section). Two themes are
924 provided by default: 'default' and 'stoica' (the one used by
925 Identi.ca). It's appreciated if you don't use the 'stoica' theme
926 except as the basis for your own.
927 email: contact email address for your site. By default, it's extracted
928 from your Web server environment; you may want to customize it.
929 broughtbyurl: name of an organization or individual who provides the
930 service. Each page will include a link to this name in the
931 footer. A good way to link to the blog, forum, wiki,
932 corporate portal, or whoever is making the service available.
933 broughtby: text used for the "brought by" link.
934 timezone: default timezone for message display. Users can set their
935 own time zone. Defaults to 'UTC', which is a pretty good default.
936 closed: If set to 'true', will disallow registration on your site.
937 This is a cheap way to restrict accounts to only one
938 individual or group; just register the accounts you want on
939 the service, *then* set this variable to 'true'.
940 inviteonly: If set to 'true', will only allow registration if the user
941 was invited by an existing user.
942 private: If set to 'true', anonymous users will be redirected to the
943 'login' page. Also, API methods that normally require no
944 authentication will require it. Note that this does not turn
945 off registration; use 'closed' or 'inviteonly' for the
947 notice: A plain string that will appear on every page. A good place
948 to put introductory information about your service, or info about
949 upgrades and outages, or other community info. Any HTML will
951 logo: URL of an image file to use as the logo for the site. Overrides
952 the logo in the theme, if any.
953 ssl: Whether to use SSL and https:// URLs for some or all pages.
954 Possible values are 'always' (use it for all pages), 'never'
955 (don't use it for any pages), or 'sometimes' (use it for
956 sensitive pages that include passwords like login and registration,
957 but not for regular pages). Default to 'never'.
958 sslserver: use an alternate server name for SSL URLs, like
959 'secure.example.org'. You should be careful to set cookie
960 parameters correctly so that both the SSL server and the
961 "normal" server can access the session cookie and
962 preferably other cookies as well.
963 shorturllength: Length of URL at which URLs in a message exceeding 140
964 characters will be sent to the user's chosen
966 dupelimit: minimum time allowed for one person to say the same thing
967 twice. Default 60s. Anything lower is considered a user
969 textlimit: default max size for texts in the site. Defaults to 140.
970 0 means no limit. Can be fine-tuned for notices, messages,
971 profile bios and group descriptions.
976 This section is a reference to the configuration options for
977 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
978 set are listed below for clarity.
980 database: a DSN (Data Source Name) for your StatusNet database. This is
981 in the format 'protocol://username:password@hostname/databasename',
982 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
983 really know what you're doing), 'username' is the username,
984 'password' is the password, and etc.
985 ini_yourdbname: if your database is not named 'statusnet', you'll need
986 to set this to point to the location of the
987 statusnet.ini file. Note that the real name of your database
988 should go in there, not literally 'yourdbname'.
989 db_driver: You can try changing this to 'MDB2' to use the other driver
990 type for DB_DataObject, but note that it breaks the OpenID
991 libraries, which only support PEAR::DB.
992 debug: On a database error, you may get a message saying to set this
993 value to 5 to see debug messages in the browser. This breaks
994 just about all pages, and will also expose the username and
996 quote_identifiers: Set this to true if you're using postgresql.
997 type: either 'mysql' or 'postgresql' (used for some bits of
998 database-type-specific SQL in the code). Defaults to mysql.
999 mirror: you can set this to an array of DSNs, like the above
1000 'database' value. If it's set, certain read-only actions will
1001 use a random value out of this array for the database, rather
1002 than the one in 'database' (actually, 'database' is overwritten).
1003 You can offload a busy DB server by setting up MySQL replication
1004 and adding the slaves to this array. Note that if you want some
1005 requests to go to the 'database' (master) server, you'll need
1006 to include it in this array, too.
1007 utf8: whether to talk to the database in UTF-8 mode. This is the default
1008 with new installations, but older sites may want to turn it off
1009 until they get their databases fixed up. See "UTF-8 database"
1011 schemacheck: when to let plugins check the database schema to add
1012 tables or update them. Values can be 'runtime' (default)
1013 or 'script'. 'runtime' can be costly (plugins check the
1014 schema on every hit, adding potentially several db
1015 queries, some quite long), but not everyone knows how to
1016 run a script. If you can, set this to 'script' and run
1017 scripts/checkschema.php whenever you install or upgrade a
1023 By default, StatusNet sites log error messages to the syslog facility.
1024 (You can override this using the 'logfile' parameter described above).
1026 appname: The name that StatusNet uses to log messages. By default it's
1027 "statusnet", but if you have more than one installation on the
1028 server, you may want to change the name for each instance so
1029 you can track log messages more easily.
1030 priority: level to log at. Currently ignored.
1031 facility: what syslog facility to used. Defaults to LOG_USER, only
1032 reset if you know what syslog is and have a good reason
1038 You can configure the software to queue time-consuming tasks, like
1039 sending out SMS email or XMPP messages, for off-line processing. See
1040 'Queues and daemons' above for how to set this up.
1042 enabled: Whether to uses queues. Defaults to false.
1043 subsystem: Which kind of queueserver to use. Values include "db" for
1044 our hacked-together database queuing (no other server
1045 required) and "stomp" for a stomp server.
1046 stomp_server: "broker URI" for stomp server. Something like
1047 "tcp://hostname:61613". More complicated ones are
1048 possible; see your stomp server's documentation for
1050 queue_basename: a root name to use for queues (stomp only). Typically
1051 something like '/queue/sitename/' makes sense.
1052 stomp_username: username for connecting to the stomp server; defaults
1054 stomp_password: password for connecting to the stomp server; defaults
1059 The default license to use for your users notices. The default is the
1060 Creative Commons Attribution 3.0 license, which is probably the right
1061 choice for any public site. Note that some other servers will not
1062 accept notices if you apply a stricter license than this.
1064 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1065 (default copyright), or 'private' (for private and confidential
1067 owner: for 'allrightsreserved' or 'private', an assigned copyright
1068 holder (for example, an employer for a private site). If
1069 not specified, will be attributed to 'contributors'.
1070 url: URL of the license, used for links.
1071 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1072 image: A button shown on each page for the license.
1077 This is for configuring out-going email. We use PEAR's Mail module,
1078 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1080 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1081 'smtp'. Defaults to PEAR's default, 'mail'.
1082 params: if the mail backend requires any parameters, you can provide
1083 them in an associative array.
1088 This is for configuring nicknames in the service.
1090 blacklist: an array of strings for usernames that may not be
1091 registered. A default array exists for strings that are
1092 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1093 but you may want to add others if you have other software
1094 installed in a subdirectory of StatusNet or if you just
1095 don't want certain words used as usernames.
1096 featured: an array of nicknames of 'featured' users of the site.
1097 Can be useful to draw attention to well-known users, or
1098 interesting people, or whatever.
1103 For configuring avatar access.
1105 dir: Directory to look for avatar files and to put them into.
1106 Defaults to avatar subdirectory of install directory; if
1107 you change it, make sure to change path, too.
1108 path: Path to avatars. Defaults to path for avatar subdirectory,
1109 but you can change it if you wish. Note that this will
1110 be included with the avatar server, too.
1111 server: If set, defines another server where avatars are stored in the
1112 root directory. Note that the 'avatar' subdir still has to be
1113 writeable. You'd typically use this to split HTTP requests on
1114 the client to speed up page loading, either with another
1115 virtual server or with an NFS or SAMBA share. Clients
1116 typically only make 2 connections to a single server at a
1117 time <http://ur1.ca/6ih>, so this can parallelize the job.
1123 For configuring the public stream.
1125 localonly: If set to true, only messages posted by users of this
1126 service (rather than other services, filtered through OMB)
1127 are shown in the public stream. Default true.
1128 blacklist: An array of IDs of users to hide from the public stream.
1129 Useful if you have someone making excessive Twitterfeed posts
1130 to the site, other kinds of automated posts, testing bots, etc.
1131 autosource: Sources of notices that are from automatic posters, and thus
1132 should be kept off the public timeline. Default empty.
1137 server: Like avatars, you can speed up page loading by pointing the
1138 theme file lookup to another server (virtual or real).
1139 Defaults to NULL, meaning to use the site server.
1140 dir: Directory where theme files are stored. Used to determine
1141 whether to show parts of a theme file. Defaults to the theme
1142 subdirectory of the install directory.
1143 path: Path part of theme URLs, before the theme name. Relative to the
1144 theme server. It may make sense to change this path when upgrading,
1145 (using version numbers as the path) to make sure that all files are
1146 reloaded by caching clients or proxies. Defaults to null,
1147 which means to use the site path + '/theme'.
1152 For configuring the XMPP sub-system.
1154 enabled: Whether to accept and send messages by XMPP. Default false.
1155 server: server part of XMPP ID for update user.
1156 port: connection port for clients. Default 5222, which you probably
1157 shouldn't need to change.
1158 user: username for the client connection. Users will receive messages
1159 from 'user'@'server'.
1160 resource: a unique identifier for the connection to the server. This
1161 is actually used as a prefix for each XMPP component in the system.
1162 password: password for the user account.
1163 host: some XMPP domains are served by machines with a different
1164 hostname. (For example, @gmail.com GTalk users connect to
1165 talk.google.com). Set this to the correct hostname if that's the
1166 case with your server.
1167 encryption: Whether to encrypt the connection between StatusNet and the
1168 XMPP server. Defaults to true, but you can get
1169 considerably better performance turning it off if you're
1170 connecting to a server on the same machine or on a
1172 debug: if turned on, this will make the XMPP library blurt out all of
1173 the incoming and outgoing messages as XML stanzas. Use as a
1174 last resort, and never turn it on if you don't have queues
1175 enabled, since it will spit out sensitive data to the browser.
1176 public: an array of JIDs to send _all_ notices to. This is useful for
1177 participating in third-party search and archiving services.
1182 For configuring invites.
1184 enabled: Whether to allow users to send invites. Default true.
1189 Miscellaneous tagging stuff.
1191 dropoff: Decay factor for tag listing, in seconds.
1192 Defaults to exponential decay over ten days; you can twiddle
1193 with it to try and get better results for your site.
1198 Settings for the "popular" section of the site.
1200 dropoff: Decay factor for popularity listing, in seconds.
1201 Defaults to exponential decay over ten days; you can twiddle
1202 with it to try and get better results for your site.
1207 For daemon processes.
1209 piddir: directory that daemon processes should write their PID file
1210 (process ID) to. Defaults to /var/run/, which is where this
1211 stuff should usually go on Unix-ish systems.
1212 user: If set, the daemons will try to change their effective user ID
1213 to this user before running. Probably a good idea, especially if
1214 you start the daemons as root. Note: user name, like 'daemon',
1216 group: If set, the daemons will try to change their effective group ID
1217 to this named group. Again, a name, not a numerical ID.
1222 You can get a significant boost in performance by caching some
1223 database data in memcached <http://www.danga.com/memcached/>.
1225 enabled: Set to true to enable. Default false.
1226 server: a string with the hostname of the memcached server. Can also
1227 be an array of hostnames, if you've got more than one server.
1228 base: memcached uses key-value pairs to store data. We build long,
1229 funny-looking keys to make sure we don't have any conflicts. The
1230 base of the key is usually a simplified version of the site name
1231 (like "Identi.ca" => "identica"), but you can overwrite this if
1232 you need to. You can safely ignore it if you only have one
1233 StatusNet site using your memcached server.
1234 port: Port to connect to; defaults to 11211.
1241 enabled: Whether to enable post-by-email. Defaults to true. You will
1242 also need to set up maildaemon.php.
1247 For SMS integration.
1249 enabled: Whether to enable SMS integration. Defaults to true. Queues
1250 should also be enabled.
1255 A catch-all for integration with other systems.
1257 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1264 enabled: No longer used. If you set this to something other than true,
1265 StatusNet will no longer run.
1270 For notice-posting throttles.
1272 enabled: Whether to throttle posting. Defaults to false.
1273 count: Each user can make this many posts in 'timespan' seconds. So, if count
1274 is 100 and timespan is 3600, then there can be only 100 posts
1275 from a user every hour.
1276 timespan: see 'count'.
1283 banned: an array of usernames and/or profile IDs of 'banned' profiles.
1284 The site will reject any notices by these users -- they will
1285 not be accepted at all. (Compare with blacklisted users above,
1286 whose posts just won't show up in the public stream.)
1287 biolimit: max character length of bio; 0 means no limit; null means to use
1288 the site text limit default.
1293 Options with new users.
1295 default: nickname of a user account to automatically subscribe new
1296 users to. Typically this would be system account for e.g.
1297 service updates or announcements. Users are able to unsub
1298 if they want. Default is null; no auto subscribe.
1299 welcome: nickname of a user account that sends welcome messages to new
1300 users. Can be the same as 'default' account, although on
1301 busy servers it may be a good idea to keep that one just for
1302 'urgent' messages. Default is null; no message.
1304 If either of these special user accounts are specified, the users should
1305 be created before the configuration is updated.
1310 The software will, by default, send statistical snapshots about the
1311 local installation to a stats server on the status.net Web site. This
1312 data is used by the developers to prioritize development decisions. No
1313 identifying data about users or organizations is collected. The data
1314 is available to the public for review. Participating in this survey
1315 helps StatusNet developers take your needs into account when updating
1318 run: string indicating when to run the statistics. Values can be 'web'
1319 (run occasionally at Web time), 'cron' (run from a cron script),
1320 or 'never' (don't ever run). If you set it to 'cron', remember to
1321 schedule the script to run on a regular basis.
1322 frequency: if run value is 'web', how often to report statistics.
1323 Measured in Web hits; depends on how active your site is.
1324 Default is 10000 -- that is, one report every 10000 Web hits,
1326 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1327 report system, but if they go evil or disappear you may
1328 need to update this to another value. Note: if you
1329 don't want to report stats, it's much better to
1330 set 'run' to 'never' than to set this value to something
1336 The software lets users upload files with their notices. You can configure
1337 the types of accepted files by mime types and a trio of quota options:
1338 per file, per user (total), per user per month.
1340 We suggest the use of the pecl file_info extension to handle mime type
1343 supported: an array of mime types you accept to store and distribute,
1344 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1345 setup your server to properly recognize the types you want to
1347 uploads: false to disable uploading files with notices (true by default).
1348 filecommand: The required MIME_Type library may need to use the 'file'
1349 command. It tries the one in the Web server's path, but if
1350 you're having problems with uploads, try setting this to the
1351 correct value. Note: 'file' must accept '-b' and '-i' options.
1353 For quotas, be sure you've set the upload_max_filesize and post_max_size
1354 in php.ini to be large enough to handle your upload. In httpd.conf
1355 (if you're using apache), check that the LimitRequestBody directive isn't
1356 set too low (it's optional, so it may not be there at all).
1358 file_quota: maximum size for a single file upload in bytes. A user can send
1359 any amount of notices with attachments as long as each attachment
1360 is smaller than file_quota.
1361 user_quota: total size in bytes a user can store on this server. Each user
1362 can store any number of files as long as their total size does
1363 not exceed the user_quota.
1364 monthly_quota: total size permitted in the current month. This is the total
1365 size in bytes that a user can upload each month.
1366 dir: directory accessible to the Web process where uploads should go.
1367 Defaults to the 'file' subdirectory of the install directory, which
1368 should be writeable by the Web user.
1369 server: server name to use when creating URLs for uploaded files.
1370 Defaults to null, meaning to use the default Web server. Using
1371 a virtual server here can speed up Web performance.
1372 path: URL path, relative to the server, to find files. Defaults to
1373 main path + '/file/'.
1374 filecommand: command to use for determining the type of a file. May be
1375 skipped if fileinfo extension is installed. Defaults to
1381 Options for group functionality.
1383 maxaliases: maximum number of aliases a group can have. Default 3. Set
1384 to 0 or less to prevent aliases in a group.
1385 desclimit: maximum number of characters to allow in group descriptions.
1386 null (default) means to use the site-wide text limits. 0
1392 oEmbed endpoint for multimedia attachments (links in posts).
1394 endpoint: oohembed endpoint using http://oohembed.com/ software.
1399 Some stuff for search.
1401 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1402 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1403 but requires the lame old MyISAM engine for MySQL. The latter
1404 will work with InnoDB but could be miserably slow on large
1405 systems. We'll probably add another type sometime in the future,
1406 with our own indexing system (maybe like MediaWiki's).
1413 handle: boolean. Whether we should register our own PHP session-handling
1414 code (using the database and memcache if enabled). Defaults to false.
1415 Setting this to true makes some sense on large or multi-server
1416 sites, but it probably won't hurt for smaller ones, either.
1417 debug: whether to output debugging info for session storage. Can help
1418 with weird session bugs, sometimes. Default false.
1423 Users can upload backgrounds for their pages; this section defines
1426 server: the server to use for background. Using a separate (even
1427 virtual) server for this can speed up load times. Default is
1428 null; same as site server.
1429 dir: directory to write backgrounds too. Default is '/background/'
1430 subdir of install dir.
1431 path: path to backgrounds. Default is sub-path of install path; note
1432 that you may need to change this if you change site-path too.
1437 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1438 notify third-party servers of updates.
1440 notify: an array of URLs for ping endpoints. Default is the empty
1441 array (no notification).
1446 Default design (colors and background) for the site. Actual appearance
1447 depends on the theme. Null values mean to use the theme defaults.
1449 backgroundcolor: Hex color of the site background.
1450 contentcolor: Hex color of the content area background.
1451 sidebarcolor: Hex color of the sidebar background.
1452 textcolor: Hex color of all non-link text.
1453 linkcolor: Hex color of all links.
1454 backgroundimage: Image to use for the background.
1455 disposition: Flags for whether or not to tile the background image.
1460 Configuration options specific to notices.
1462 contentlimit: max length of the plain-text content of a notice.
1463 Default is null, meaning to use the site-wide text limit.
1469 Configuration options specific to messages.
1471 contentlimit: max length of the plain-text content of a message.
1472 Default is null, meaning to use the site-wide text limit.
1478 Configuration options for the login command.
1480 disabled: whether to enable this command. If enabled, users who send
1481 the text 'login' to the site through any channel will
1482 receive a link to login to the site automatically in return.
1483 Possibly useful for users who primarily use an XMPP or SMS
1484 interface and can't be bothered to remember their site
1485 password. Note that the security implications of this are
1486 pretty serious and have not been thoroughly tested. You
1487 should enable it only after you've convinced yourself that
1488 it is safe. Default is 'false'.
1493 If an installation has only one user, this can simplify a lot of the
1494 interface. It also makes the user's profile the root URL.
1496 enabled: Whether to run in "single user mode". Default false.
1497 nickname: nickname of the single user.
1502 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1503 powerful plugin architecture. Important events in the code are named,
1504 like 'StartNoticeSave', and other software can register interest
1505 in those events. When the events happen, the other software is called
1506 and has a choice of accepting or rejecting the events.
1508 In the simplest case, you can add a function to config.php and use the
1509 Event::addHandler() function to hook an event:
1511 function AddGoogleLink($action)
1513 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1517 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1519 This adds a menu item to the end of the main navigation menu. You can
1520 see the list of existing events, and parameters that handlers must
1521 implement, in EVENTS.txt.
1523 The Plugin class in lib/plugin.php makes it easier to write more
1524 complex plugins. Sub-classes can just create methods named
1525 'onEventName', where 'EventName' is the name of the event (case
1526 matters!). These methods will be automatically registered as event
1527 handlers by the Plugin constructor (which you must call from your own
1528 class's constructor).
1530 Several example plugins are included in the plugins/ directory. You
1531 can enable a plugin with the following line in config.php:
1533 addPlugin('Example', array('param1' => 'value1',
1534 'param2' => 'value2'));
1536 This will look for and load files named 'ExamplePlugin.php' or
1537 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1538 plugins that ship with StatusNet) or in the local/ directory (for
1539 plugins you write yourself or that you get from somewhere else) or
1542 Plugins are documented in their own directories.
1547 The primary output for StatusNet is syslog, unless you configured a
1548 separate logfile. This is probably the first place to look if you're
1549 getting weird behaviour from StatusNet.
1551 If you're tracking the unstable version of StatusNet in the git
1552 repository (see below), and you get a compilation error ("unexpected
1553 T_STRING") in the browser, check to see that you don't have any
1554 conflicts in your code.
1556 If you upgraded to StatusNet 0.8.2 without reading the "Notice
1557 inboxes" section above, and all your users' 'Personal' tabs are empty,
1558 read the "Notice inboxes" section above.
1563 These are some myths you may see on the Web about StatusNet.
1564 Documentation from the core team about StatusNet has been pretty
1565 sparse, so some backtracking and guesswork resulted in some incorrect
1568 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1569 extremely bad idea. It's a tool built into DB_DataObject that will
1570 emit oodles of print lines directly to the browser of your users.
1571 Among these lines will be your database username and password. Do
1572 not enable this option on a production Web site for any reason.
1574 - "Edit dataobject.ini with the following settings..." dataobject.ini
1575 is a development file for the DB_DataObject framework and is not
1576 used by the running software. It was removed from the StatusNet
1577 distribution because its presence was confusing. Do not bother
1578 configuring dataobject.ini, and do not put your database username
1579 and password into the file on a production Web server; unscrupulous
1580 persons may try to read it to get your passwords.
1585 If you're adventurous or impatient, you may want to install the
1586 development version of StatusNet. To get it, use the git version
1587 control tool <http://git-scm.com/> like so:
1589 git clone git@gitorious.org:statusnet/mainline.git
1591 This is the version of the software that runs on Identi.ca and the
1592 status.net hosted service. Using it is a mixed bag. On the positive
1593 side, it usually includes the latest security and bug fix patches. On
1594 the downside, it may also include changes that require admin
1595 intervention (like running a script or even raw SQL!) that may not be
1596 documented yet. It may be a good idea to test this version before
1597 installing it on your production machines.
1599 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1604 There are several ways to get more information about StatusNet.
1606 * There is a mailing list for StatusNet developers and admins at
1607 http://mail.status.net/mailman/listinfo/statusnet-dev
1608 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1609 * The StatusNet wiki, http://status.net/wiki/
1610 * The StatusNet blog, http://status.net/blog/
1611 * The StatusNet status update, <http://status.status.net/status> (!)
1616 * Microblogging messages to http://identi.ca/evan are very welcome.
1617 * StatusNet's Trac server has a bug tracker for any defects you may find,
1618 or ideas for making things better. http://status.net/trac/
1619 * e-mail to evan@status.net will usually be read and responded to very
1620 quickly, unless the question is really hard.
1625 The following is an incomplete list of developers who've worked on
1626 StatusNet. Apologies for any oversight; please let evan@status.net know
1627 if anyone's been overlooked in error.
1629 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1630 * Zach Copley, StatusNet, Inc.
1631 * Earle Martin, StatusNet, Inc.
1632 * Marie-Claude Doyon, designer, StatusNet, Inc.
1633 * Sarven Capadisli, StatusNet, Inc.
1634 * Robin Millette, StatusNet, Inc.
1645 * Tryggvi Björgvinsson
1649 * Ken Sheppardson (Trac server, man-about-town)
1650 * Tiago 'gouki' Faria (i18n manager)
1652 * Leslie Michael Orchard
1656 * Tobias Diekershoff
1668 Thanks also to the developers of our upstream library code and to the
1669 thousands of people who have tried out Identi.ca, installed StatusNet,
1670 told their friends, and built the Open Microblogging network to what