5 StatusNet 0.9.8 "Letter Never Sent"
8 This is the README file for StatusNet, the Open Source microblogging
9 platform. It includes installation instructions, descriptions of
10 options you can set, warnings, tips, and general info for
11 administrators. Information on using StatusNet can be found in the
12 "doc" subdirectory or in the "help" section on-line.
17 StatusNet is a Free and Open Source microblogging platform. It helps
18 people in a community, company or group to exchange short (140
19 characters, by default) 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 Google Buzz, or Yammer.
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 OStatus
29 <http://ostatus.org/> that lets users in different networks follow
30 each other. It enables a distributed social network spread all across
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. See
42 <http://status.net/signup> for details. The software run
43 on status.net is identical to the software available for download, so
44 you can move back and forth between a hosted version or a version
45 installed on your own servers.
47 A commercial software subscription is available from StatusNet Inc. It
48 includes 24-hour technical support and developer support. More
49 information at http://status.net/contact or email sales@status.net.
54 This program is free software: you can redistribute it and/or modify
55 it under the terms of the GNU Affero General Public License as
56 published by the Free Software Foundation, either version 3 of the
57 License, or (at your option) any later version.
59 This program is distributed in the hope that it will be useful, but
60 WITHOUT ANY WARRANTY; without even the implied warranty of
61 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
62 Affero General Public License for more details.
64 You should have received a copy of the GNU Affero General Public
65 License along with this program, in the file "COPYING". If not, see
66 <http://www.gnu.org/licenses/>.
68 IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
69 *different requirements* from the "regular" GPL. In particular, if
70 you make modifications to the StatusNet source code on your server,
71 you *MUST MAKE AVAILABLE* the modified version of the source code
72 to your users under the same license. This is a legal requirement
73 of using the software, and if you do not wish to share your
74 modifications, *YOU MAY NOT INSTALL STATUSNET*.
76 Documentation in the /doc-src/ directory is available under the
77 Creative Commons Attribution 3.0 Unported license, with attribution to
78 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
80 CSS and images in the /theme/ directory are available under the
81 Creative Commons Attribution 3.0 Unported license, with attribution to
82 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
84 Our understanding and intention is that if you add your own theme that
85 uses only CSS and images, those files are not subject to the copyleft
86 requirements of the Affero General Public License 3.0. See
87 http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
88 legal advice; consult your lawyer.
90 Additional library software has been made available in the 'extlib'
91 directory. All of it is Free Software and can be distributed under
92 liberal terms, but those terms may differ in detail from the AGPL's
93 particulars. See each package's license file in the extlib directory
99 This is a security release since version 0.9.7 released on 11 March
100 2011. It fixes security bug #3260. All sites running version 0.9.7 or
101 below are recommended to upgrade to 0.9.8 immediately.
103 Notable changes this version:
105 - Fix bug #3260, a cross-site scripting (XSS) bug that allows an
106 attacker to inject JavaScript into a page with a carefully structured URL.
107 - Updated code for Google Analytics to reflect new API.
108 - Various fixes for Bookmark plugin.
109 - Updates to reCAPTCHA plugin based on changes to API.
110 - New plugin to move the site notice to the sidebar.
111 - Add rss.me to notice source list.
112 - Updates to data backup/restore.
113 - Correct use of "likes" in Facebook plugin.
114 - Ignore failures in Twitter plugin.
116 A full changelog is available at http://status.net/wiki/StatusNet_0.9.8.
121 The following software packages are *required* for this software to
124 - PHP 5.2.3+. It may be possible to run this software on earlier
125 versions of PHP, but many of the functions used are only available
126 in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
127 daemons on 64-bit platforms. PHP 5.3.x should work correctly in this
128 release, but problems with some plugins are possible.
129 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
130 server. It has been primarily tested on 5.x servers, although it may
131 be possible to install on earlier (or later!) versions. The server
132 *must* support the MyISAM storage engine -- the default for most
133 MySQL servers -- *and* the InnoDB storage engine.
134 - A Web server. Preferably, you should have Apache 2.2.x with the
135 mod_rewrite extension installed and enabled.
137 Your PHP installation must include the following PHP extensions:
139 - Curl. This is for fetching files by HTTP.
140 - XMLWriter. This is for formatting XML and HTML output.
141 - MySQL. For accessing the database.
142 - GD. For scaling down avatar images.
143 - mbstring. For handling Unicode (UTF-8) encoded strings.
145 For some functionality, you will also need the following extensions:
147 - Memcache. A client for the memcached server, which caches database
148 information in volatile memory. This is important for adequate
149 performance on high-traffic sites. You will also need a memcached
150 server to store the data in.
151 - Mailparse. Efficient parsing of email requires this extension.
152 Submission by email or SMS-over-email uses this extension.
153 - Sphinx Search. A client for the sphinx server, an alternative
154 to MySQL or Postgresql fulltext search. You will also need a
155 Sphinx server to serve the search queries.
156 - bcmath or gmp. For Salmon signatures (part of OStatus). Needed
157 if you have OStatus configured.
158 - gettext. For multiple languages. Default on many PHP installs;
159 will be emulated if not present.
161 You will almost definitely get 2-3 times better performance from your
162 site if you install a PHP bytecode cache/accelerator. Some well-known
163 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
164 is a proprietary accelerator installed on some hosting sites.
169 A number of external PHP libraries are used to provide basic
170 functionality and optional functionality for your system. For your
171 convenience, they are available in the "extlib" directory of this
172 package, and you do not have to download and install them. However,
173 you may want to keep them up-to-date with the latest upstream version,
174 and the URLs are listed here for your convenience.
176 - DB_DataObject http://pear.php.net/package/DB_DataObject
177 - Validate http://pear.php.net/package/Validate
178 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
179 to use the openidenabled.com version since it's more widely
180 implemented, and seems to be better supported.
181 http://openidenabled.com/php-openid/
182 - PEAR DB. Although this is an older data access system (new
183 packages should probably use PHP DBO), the OpenID libraries
184 depend on PEAR DB so we use it here, too. DB_DataObject can
185 also use PEAR MDB2, which may give you better performance
186 but won't work with OpenID.
187 http://pear.php.net/package/DB
188 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
189 - markdown.php from http://michelf.com/projects/php-markdown/
190 - PEAR Mail, for sending out mail notifications
191 http://pear.php.net/package/Mail
192 - PEAR Net_SMTP, if you use the SMTP factory for notifications
193 http://pear.php.net/package/Net_SMTP
194 - PEAR Net_Socket, if you use the SMTP factory for notifications
195 http://pear.php.net/package/Net_Socket
196 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
197 library available for PHP. http://xmpphp.googlecode.com/. Note that
198 as of this writing the version of this library that is available in
199 the extlib directory is *significantly different* from the upstream
200 version (patches have been submitted). Upgrading to the upstream
201 version may render your StatusNet site unable to send or receive XMPP
203 - Facebook library. Used for the Facebook application.
204 - PEAR Validate is used for URL and email validation.
205 - Console_GetOpt for parsing command-line options.
206 - libomb. a library for implementing OpenMicroBlogging 0.1, the
207 predecessor to OStatus.
208 - HTTP_Request2, a library for making HTTP requests.
209 - PEAR Net_URL2 is an HTTP_Request2 dependency.
211 A design goal of StatusNet is that the basic Web functionality should
212 work on even the most restrictive commercial hosting services.
213 However, additional functionality, such as receiving messages by
214 Jabber/GTalk, require that you be able to run long-running processes
215 on your account. In addition, posting by email or from SMS require
216 that you be able to install a mail filter in your mail server.
221 Installing the basic StatusNet Web component is relatively easy,
222 especially if you've previously installed PHP/MySQL packages.
224 1. Unpack the tarball you downloaded on your Web server. Usually a
225 command like this will work:
227 tar zxf statusnet-0.9.7.tar.gz
229 ...which will make a statusnet-0.9.7 subdirectory in your current
230 directory. (If you don't have shell access on your Web server, you
231 may have to unpack the tarball on your local computer and FTP the
232 files to the server.)
234 2. Move the tarball to a directory of your choosing in your Web root
235 directory. Usually something like this will work:
237 mv statusnet-0.9.7 /var/www/statusnet
239 This will make your StatusNet instance available in the statusnet path of
240 your server, like "http://example.net/statusnet". "microblog" or
241 "statusnet" might also be good path names. If you know how to
242 configure virtual hosts on your web server, you can try setting up
243 "http://micro.example.net/" or the like.
245 3. Make your target directory writeable by the Web server.
247 chmod a+w /var/www/statusnet/
249 On some systems, this will probably work:
251 chgrp www-data /var/www/statusnet/
252 chmod g+w /var/www/statusnet/
254 If your Web server runs as another user besides "www-data", try
255 that user's default group instead. As a last resort, you can create
256 a new group like "statusnet" and add the Web server's user to the group.
258 4. You should also take this moment to make your avatar, background, and
259 file subdirectories writeable by the Web server. An insecure way to do
262 chmod a+w /var/www/statusnet/avatar
263 chmod a+w /var/www/statusnet/background
264 chmod a+w /var/www/statusnet/file
266 You can also make the avatar, background, and file directories
267 writeable by the Web server group, as noted above.
269 5. Create a database to hold your microblog data. Something like this
272 mysqladmin -u "username" --password="password" create statusnet
274 Note that StatusNet must have its own database; you can't share the
275 database with another program. You can name it whatever you want,
278 (If you don't have shell access to your server, you may need to use
279 a tool like PHPAdmin to create a database. Check your hosting
280 service's documentation for how to create a new MySQL database.)
282 6. Create a new database account that StatusNet will use to access the
283 database. If you have shell access, this will probably work from the
286 GRANT ALL on statusnet.*
287 TO 'statusnetuser'@'localhost'
288 IDENTIFIED BY 'statusnetpassword';
290 You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
291 username and password. You may want to test logging in to MySQL as
294 7. In a browser, navigate to the StatusNet install script; something like:
296 http://yourserver.example.com/statusnet/install.php
298 Enter the database connection information and your site name. The
299 install program will configure your site and install the initial,
300 almost-empty database.
302 8. You should now be able to navigate to your microblog's main directory
303 and see the "Public Timeline", which will be empty. If not, magic
304 has happened! You can now register a new user, post some notices,
305 edit your profile, etc. However, you may want to wait to do that stuff
306 if you think you can set up "fancy URLs" (see below), since some
307 URLs are stored in the database.
312 By default, StatusNet will use URLs that include the main PHP program's
313 name in them. For example, a user's home profile might be
316 http://example.org/statusnet/index.php/statusnet/fred
318 On certain systems that don't support this kind of syntax, they'll
321 http://example.org/statusnet/index.php?p=statusnet/fred
323 It's possible to configure the software so it looks like this instead:
325 http://example.org/statusnet/fred
327 These "fancy URLs" are more readable and memorable for users. To use
328 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
329 mod_rewrite enabled, -OR- know how to configure "url redirection" in
332 1. Copy the htaccess.sample file to .htaccess in your StatusNet
333 directory. Note: if you have control of your server's httpd.conf or
334 similar configuration files, it can greatly improve performance to
335 import the .htaccess file into your conf file instead. If you're
336 not sure how to do it, you may save yourself a lot of headache by
337 just leaving the .htaccess file.
339 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
340 to your StatusNet installation on your server. Typically this will
341 be the path to your StatusNet directory relative to your Web root.
343 3. Add or uncomment or change a line in your config.php file so it says:
345 $config['site']['fancy'] = true;
347 You should now be able to navigate to a "fancy" URL on your server,
350 http://example.net/statusnet/main/register
352 If you changed your HTTP server configuration, you may need to restart
355 If it doesn't work, double-check that AllowOverride for the StatusNet
356 directory is 'All' in your Apache configuration file. This is usually
357 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
358 /etc/apache2/sites-available/default. See the Apache documentation for
359 .htaccess files for more details:
361 http://httpd.apache.org/docs/2.2/howto/htaccess.html
363 Also, check that mod_rewrite is installed and enabled:
365 http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
370 To use a Sphinx server to search users and notices, you'll need to
371 enable the SphinxSearch plugin. Add to your config.php:
373 addPlugin('SphinxSearch');
374 $config['sphinx']['server'] = 'searchhost.local';
376 You also need to install, compile and enable the sphinx pecl extension for
377 php on the client side, which itself depends on the sphinx development files.
379 See plugins/SphinxSearch/README for more details and server setup.
384 StatusNet supports a cheap-and-dirty system for sending update messages
385 to mobile phones and for receiving updates from the mobile. Instead of
386 sending through the SMS network itself, which is costly and requires
387 buy-in from the wireless carriers, it simply piggybacks on the email
388 gateways that many carriers provide to their customers. So, SMS
389 configuration is essentially email configuration.
391 Each user sends to a made-up email address, which they keep a secret.
392 Incoming email that is "From" the user's SMS email address, and "To"
393 the users' secret email address on the site's domain, will be
394 converted to a notice and stored in the DB.
396 For this to work, there *must* be a domain or sub-domain for which all
397 (or most) incoming email can pass through the incoming mail filter.
399 1. Run the SQL script carrier.sql in your StatusNet database. This will
402 mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
404 This will populate your database with a list of wireless carriers
405 that support email SMS gateways.
407 2. Make sure the maildaemon.php file is executable:
409 chmod +x scripts/maildaemon.php
411 Note that "daemon" is kind of a misnomer here; the script is more
412 of a filter than a daemon.
414 2. Edit /etc/aliases on your mail server and add the following line:
416 *: /path/to/statusnet/scripts/maildaemon.php
418 3. Run whatever code you need to to update your aliases database. For
419 many mail servers (Postfix, Exim, Sendmail), this should work:
423 You may need to restart your mail server for the new database to
426 4. Set the following in your config.php file:
428 $config['mail']['domain'] = 'yourdomain.example.net';
430 At this point, post-by-email and post-by-SMS-gateway should work. Note
431 that if your mail server is on a different computer from your email
432 server, you'll need to have a full installation of StatusNet, a working
433 config.php, and access to the StatusNet database from the mail server.
438 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
439 instant-messenger protocol that drives Jabber and GTalk IM. You can
440 distribute messages via XMPP using the system below; however, you
441 need to run the XMPP incoming daemon to allow incoming messages as
444 1. You may want to strongly consider setting up your own XMPP server.
445 Ejabberd, OpenFire, and JabberD are all Open Source servers.
446 Jabber, Inc. provides a high-performance commercial server.
448 2. You must register a Jabber ID (JID) with your new server. It helps
449 to choose a name like "update@example.com" or "notice" or something
450 similar. Alternately, your "update JID" can be registered on a
451 publicly-available XMPP service, like jabber.org or GTalk.
453 StatusNet will not register the JID with your chosen XMPP server;
454 you need to do this manually, with an XMPP client like Gajim,
455 Telepathy, or Pidgin.im.
457 3. Configure your site's XMPP variables, as described below in the
458 configuration section.
460 On a default installation, your site can broadcast messages using
461 XMPP. Users won't be able to post messages using XMPP unless you've
462 got the XMPP daemon running. See 'Queues and daemons' below for how
463 to set that up. Also, once you have a sizable number of users, sending
464 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
465 can really slow down your site; it may cause posting to timeout.
467 NOTE: stream_select(), a crucial function for network programming, is
468 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
469 work around this bug in StatusNet; current recommendation is to move
470 off of amd64 to another server.
475 You can send *all* messages from your microblogging site to a
476 third-party service using XMPP. This can be useful for providing
477 search, indexing, bridging, or other cool services.
479 To configure a downstream site to receive your public stream, add
480 their "JID" (Jabber ID) to your config.php as follows:
482 $config['xmpp']['public'][] = 'downstream@example.net';
484 (Don't miss those square brackets at the end.) Note that your XMPP
485 broadcasting must be configured as mentioned above. Although you can
486 send out messages at "Web time", high-volume sites should strongly
487 consider setting up queues and daemons.
492 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
493 and XMPP messages, can be 'queued' and done by off-line bots instead.
494 For this to work, you must be able to run long-running offline
495 processes, either on your main Web server or on another server you
496 control. (Your other server will still need all the above
497 prerequisites, with the exception of Apache.) Installing on a separate
498 server is probably a good idea for high-volume sites.
500 1. You'll need the "CLI" (command-line interface) version of PHP
501 installed on whatever server you use.
503 2. If you're using a separate server for queues, install StatusNet
504 somewhere on the server. You don't need to worry about the
505 .htaccess file, but make sure that your config.php file is close
506 to, or identical to, your Web server's version.
508 3. In your config.php files (both the Web server and the queues
509 server!), set the following variable:
511 $config['queue']['enabled'] = true;
513 You may also want to look at the 'daemon' section of this file for
514 more daemon options. Note that if you set the 'user' and/or 'group'
515 options, you'll need to create that user and/or group by hand.
516 They're not created automatically.
518 4. On the queues server, run the command scripts/startdaemons.sh.
520 This will run the queue handlers:
522 * queuedaemon.php - polls for queued items for inbox processing and
523 pushing out to OStatus, SMS, XMPP, etc.
524 * xmppdaemon.php - listens for new XMPP messages from users and stores
525 them as notices in the database; also pulls queued XMPP output from
526 queuedaemon.php to push out to clients.
528 These two daemons will automatically restart in most cases of failure
529 including memory leaks (if a memory_limit is set), but may still die
530 or behave oddly if they lose connections to the XMPP or queue servers.
532 Additional daemons may be also started by this script for certain
533 plugins, such as the Twitter bridge.
535 It may be a good idea to use a daemon-monitoring service, like 'monit',
536 to check their status and keep them running.
538 All the daemons write their process IDs (pids) to /var/run/ by
539 default. This can be useful for starting, stopping, and monitoring the
542 Since version 0.8.0, it's now possible to use a STOMP server instead of
543 our kind of hacky home-grown DB-based queue solution. This is strongly
544 recommended for best response time, especially when using XMPP.
546 See the "queues" config section below for how to configure to use STOMP.
547 As of this writing, the software has been tested with ActiveMQ 5.3.
552 There are two themes shipped with this version of StatusNet: "identica",
553 which is what the Identi.ca site uses, and "default", which is a good
554 basis for other sites.
556 As of right now, your ability to change the theme is site-wide; users
557 can't choose their own theme. Additionally, the only thing you can
558 change in the theme is CSS stylesheets and some image files; you can't
559 change the HTML output, like adding or removing menu items.
561 You can choose a theme using the $config['site']['theme'] element in
562 the config.php file. See below for details.
564 You can add your own theme by making a sub-directory of the 'theme'
565 subdirectory with the name of your theme. Each theme can have the
568 display.css: a CSS2 file for "default" styling for all browsers.
569 ie6.css: a CSS2 file for override styling for fixing up Internet
571 ie7.css: a CSS2 file for override styling for fixing up Internet
573 logo.png: a logo image for the site.
574 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
575 users who don't upload their own.
576 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
577 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
578 listing on profile pages.
580 You may want to start by copying the files from the default theme to
583 NOTE: the HTML generated by StatusNet changed *radically* between
584 version 0.6.x and 0.7.x. Older themes will need signification
585 modification to use the new output format.
590 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
591 Theoretically, you can add your own sub-directory to the locale/
592 subdirectory to add a new language to your system. You'll need to
593 compile the ".po" files into ".mo" files, however.
595 Contributions of translation information to StatusNet are very easy:
596 you can use the Web interface at translatewiki.net to add one
597 or a few or lots of new translations -- or even new languages. You can
598 also download more up-to-date .po files there, if you so desire.
600 For info on helping with translations, see http://status.net/wiki/Translations
605 There is no built-in system for doing backups in StatusNet. You can make
606 backups of a working StatusNet system by backing up the database and
607 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
608 and to backup the Web directory, try tar.
613 The administrator can set the "private" flag for a site so that it's
614 not visible to non-logged-in users. This might be useful for
615 workgroups who want to share a microblogging site for project
616 management, but host it on a public server.
618 Total privacy is not guaranteed or ensured. Also, privacy is
619 all-or-nothing for a site; you can't have some accounts or notices
620 private, and others public. The interaction of private sites
621 with OStatus is undefined.
623 Access to file attachments can also be restricted to logged-in users only.
624 1. Add a directory outside the web root where your file uploads will be
625 stored. Usually a command like this will work:
627 mkdir /var/www/statusnet-files
629 2. Make the file uploads directory writeable by the web server. An
630 insecure way to do this is:
632 chmod a+x /var/www/statusnet-files
634 3. Tell StatusNet to use this directory for file uploads. Add a line
635 like this to your config.php:
637 $config['attachments']['dir'] = '/var/www/statusnet-files';
642 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
643 incorrectly-stored international characters ("UTF-8"). For new
644 installations, it will now store non-ASCII characters correctly.
645 However, older installations will have the incorrect storage, and will
646 consequently show up "wrong" in browsers. See below for how to deal
649 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
650 been tracking the "git" version of the software, you will probably
651 want to upgrade and keep your existing data. There is no automated
652 upgrade procedure in StatusNet 0.9.7. Try these step-by-step
653 instructions; read to the end first before trying them.
655 0. Download StatusNet and set up all the prerequisites as if you were
657 1. Make backups of both your database and your Web directory. UNDER NO
658 CIRCUMSTANCES should you try to do an upgrade without a known-good
659 backup. You have been warned.
660 2. Shut down Web access to your site, either by turning off your Web
661 server or by redirecting all pages to a "sorry, under maintenance"
663 3. Shut down XMPP access to your site, typically by shutting down the
664 xmppdaemon.php process and all other daemons that you're running.
665 If you've got "monit" or "cron" automatically restarting your
666 daemons, make sure to turn that off, too.
667 4. Shut down SMS and email access to your site. The easy way to do
668 this is to comment out the line piping incoming email to your
669 maildaemon.php file, and running something like "newaliases".
670 5. Once all writing processes to your site are turned off, make a
671 final backup of the Web directory and database.
672 6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
673 7. Unpack your StatusNet 0.9.7 tarball and move it to "statusnet" or
674 wherever your code used to be.
675 8. Copy the config.php file and the contents of the avatar/, background/,
676 file/, and local/ subdirectories from your old directory to your new
678 9. Copy htaccess.sample to .htaccess in the new directory. Change the
679 RewriteBase to use the correct path.
680 10. Rebuild the database.
682 NOTE: this step is destructive and cannot be
683 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
684 do it without a known-good backup!
686 If your database is at version 0.8.0 or higher in the 0.8.x line, you can run a
687 special upgrade script:
689 mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
691 If you are upgrading from any 0.9.x version like 0.9.6, run this script:
693 mysql -u<rootuser> -p<rootpassword> <database> db/096to097.sql
695 Despite the name, it should work for any 0.9.x branch.
697 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
698 BACKUP run the rebuilddb.sh script like this:
700 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
702 Here, rootuser and rootpassword are the username and password for a
703 user who can drop and create databases as well as tables; typically
704 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
705 your database and rebuilds it; if there is an error you have no
706 database. Make sure you have a backup.
707 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
708 which operates slightly differently. Read the documentation in that
709 script before running it.
710 11. Use mysql or psql client to log into your database and make sure that
711 the notice, user, profile, subscription etc. tables are non-empty.
712 12. Turn back on the Web server, and check that things still work.
713 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
714 bots have changed since version 0.5; see above for details.
716 If you're upgrading from very old versions, you may want to look at
717 the fixup_* scripts in the scripts directories. These will store some
718 precooked data in the DB. All upgraders should check out the inboxes
721 NOTE: the database definition file, laconica.ini, has been renamed to
722 statusnet.ini (since this is the recommended database name). If you
723 have a line in your config.php pointing to the old name, you'll need
729 Notice inboxes are now required. If you don't have inboxes enabled,
730 StatusNet will no longer run.
735 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
736 international characters ("UTF-8"). This fix is not
737 backwards-compatible; installations from before 0.7.4 will show
738 non-ASCII characters of old notices incorrectly. This section explains
741 0. You can disable the new behaviour by setting the 'db''utf8' config
742 option to "false". You should only do this until you're ready to
743 convert your DB to the new format.
744 1. When you're ready to convert, you can run the fixup_utf8.php script
745 in the scripts/ subdirectory. If you've had the "new behaviour"
746 enabled (probably a good idea), you can give the ID of the first
747 "new" notice as a parameter, and only notices before that one will
748 be converted. Notices are converted in reverse chronological order,
749 so the most recent (and visible) ones will be converted first. The
750 script should work whether or not you have the 'db''utf8' config
752 2. When you're ready, set $config['db']['utf8'] to true, so that
753 new notices will be stored correctly.
755 Configuration options
756 =====================
758 The main configuration file for StatusNet (excepting configurations for
759 dependency software) is config.php in your StatusNet directory. If you
760 edit any other file in the directory, like lib/default.php (where most
761 of the defaults are defined), you will lose your configuration options
762 in any upgrade, and you will wish that you had been more careful.
764 Starting with version 0.9.0, a Web based configuration panel has been
765 added to StatusNet. The preferred method for changing config options is
768 A command-line script, setconfig.php, can be used to set individual
769 configuration options. It's in the scripts/ directory.
771 Starting with version 0.7.1, you can put config files in the
772 /etc/statusnet/ directory on your server, if it exists. Config files
773 will be included in this order:
775 * /etc/statusnet/statusnet.php - server-wide config
776 * /etc/statusnet/<servername>.php - for a virtual host
777 * /etc/statusnet/<servername>_<pathname>.php - for a path
778 * INSTALLDIR/config.php - for a particular implementation
780 Almost all configuration options are made through a two-dimensional
781 associative array, cleverly named $config. A typical configuration
784 $config['section']['option'] = value;
786 For brevity, the following documentation describes each section and
792 This section is a catch-all for site-wide variables.
794 name: the name of your site, like 'YourCompany Microblog'.
795 server: the server part of your site's URLs, like 'example.net'.
796 path: The path part of your site's URLs, like 'statusnet' or ''
798 fancy: whether or not your site uses fancy URLs (see Fancy URLs
799 section above). Default is false.
800 logfile: full path to a file for StatusNet to save logging
801 information to. You may want to use this if you don't have
803 logdebug: whether to log additional debug info like backtraces on
804 hard errors. Default false.
805 locale_path: full path to the directory for locale data. Unless you
806 store all your locale data in one place, you probably
807 don't need to use this.
808 language: default language for your site. Defaults to US English.
809 Note that this is overridden if a user is logged in and has
810 selected a different language. It is also overridden if the
811 user is NOT logged in, but their browser requests a different
812 langauge. Since pretty much everybody's browser requests a
813 language, that means that changing this setting has little or
814 no effect in practice.
815 languages: A list of languages supported on your site. Typically you'd
816 only change this if you wanted to disable support for one
818 "unset($config['site']['languages']['de'])" will disable
820 theme: Theme for your site (see Theme section). Two themes are
821 provided by default: 'default' and 'stoica' (the one used by
822 Identi.ca). It's appreciated if you don't use the 'stoica' theme
823 except as the basis for your own.
824 email: contact email address for your site. By default, it's extracted
825 from your Web server environment; you may want to customize it.
826 broughtbyurl: name of an organization or individual who provides the
827 service. Each page will include a link to this name in the
828 footer. A good way to link to the blog, forum, wiki,
829 corporate portal, or whoever is making the service available.
830 broughtby: text used for the "brought by" link.
831 timezone: default timezone for message display. Users can set their
832 own time zone. Defaults to 'UTC', which is a pretty good default.
833 closed: If set to 'true', will disallow registration on your site.
834 This is a cheap way to restrict accounts to only one
835 individual or group; just register the accounts you want on
836 the service, *then* set this variable to 'true'.
837 inviteonly: If set to 'true', will only allow registration if the user
838 was invited by an existing user.
839 private: If set to 'true', anonymous users will be redirected to the
840 'login' page. Also, API methods that normally require no
841 authentication will require it. Note that this does not turn
842 off registration; use 'closed' or 'inviteonly' for the
844 notice: A plain string that will appear on every page. A good place
845 to put introductory information about your service, or info about
846 upgrades and outages, or other community info. Any HTML will
848 logo: URL of an image file to use as the logo for the site. Overrides
849 the logo in the theme, if any.
850 ssllogo: URL of an image file to use as the logo on SSL pages. If unset,
851 theme logo is used instead.
852 ssl: Whether to use SSL and https:// URLs for some or all pages.
853 Possible values are 'always' (use it for all pages), 'never'
854 (don't use it for any pages), or 'sometimes' (use it for
855 sensitive pages that include passwords like login and registration,
856 but not for regular pages). Default to 'never'.
857 sslserver: use an alternate server name for SSL URLs, like
858 'secure.example.org'. You should be careful to set cookie
859 parameters correctly so that both the SSL server and the
860 "normal" server can access the session cookie and
861 preferably other cookies as well.
862 shorturllength: Length of URL at which URLs in a message exceeding 140
863 characters will be sent to the user's chosen
865 dupelimit: minimum time allowed for one person to say the same thing
866 twice. Default 60s. Anything lower is considered a user
868 textlimit: default max size for texts in the site. Defaults to 140.
869 0 means no limit. Can be fine-tuned for notices, messages,
870 profile bios and group descriptions.
875 This section is a reference to the configuration options for
876 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
877 set are listed below for clarity.
879 database: a DSN (Data Source Name) for your StatusNet database. This is
880 in the format 'protocol://username:password@hostname/databasename',
881 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
882 really know what you're doing), 'username' is the username,
883 'password' is the password, and etc.
884 ini_yourdbname: if your database is not named 'statusnet', you'll need
885 to set this to point to the location of the
886 statusnet.ini file. Note that the real name of your database
887 should go in there, not literally 'yourdbname'.
888 db_driver: You can try changing this to 'MDB2' to use the other driver
889 type for DB_DataObject, but note that it breaks the OpenID
890 libraries, which only support PEAR::DB.
891 debug: On a database error, you may get a message saying to set this
892 value to 5 to see debug messages in the browser. This breaks
893 just about all pages, and will also expose the username and
895 quote_identifiers: Set this to true if you're using postgresql.
896 type: either 'mysql' or 'postgresql' (used for some bits of
897 database-type-specific SQL in the code). Defaults to mysql.
898 mirror: you can set this to an array of DSNs, like the above
899 'database' value. If it's set, certain read-only actions will
900 use a random value out of this array for the database, rather
901 than the one in 'database' (actually, 'database' is overwritten).
902 You can offload a busy DB server by setting up MySQL replication
903 and adding the slaves to this array. Note that if you want some
904 requests to go to the 'database' (master) server, you'll need
905 to include it in this array, too.
906 utf8: whether to talk to the database in UTF-8 mode. This is the default
907 with new installations, but older sites may want to turn it off
908 until they get their databases fixed up. See "UTF-8 database"
910 schemacheck: when to let plugins check the database schema to add
911 tables or update them. Values can be 'runtime' (default)
912 or 'script'. 'runtime' can be costly (plugins check the
913 schema on every hit, adding potentially several db
914 queries, some quite long), but not everyone knows how to
915 run a script. If you can, set this to 'script' and run
916 scripts/checkschema.php whenever you install or upgrade a
922 By default, StatusNet sites log error messages to the syslog facility.
923 (You can override this using the 'logfile' parameter described above).
925 appname: The name that StatusNet uses to log messages. By default it's
926 "statusnet", but if you have more than one installation on the
927 server, you may want to change the name for each instance so
928 you can track log messages more easily.
929 priority: level to log at. Currently ignored.
930 facility: what syslog facility to used. Defaults to LOG_USER, only
931 reset if you know what syslog is and have a good reason
937 You can configure the software to queue time-consuming tasks, like
938 sending out SMS email or XMPP messages, for off-line processing. See
939 'Queues and daemons' above for how to set this up.
941 enabled: Whether to uses queues. Defaults to false.
942 subsystem: Which kind of queueserver to use. Values include "db" for
943 our hacked-together database queuing (no other server
944 required) and "stomp" for a stomp server.
945 stomp_server: "broker URI" for stomp server. Something like
946 "tcp://hostname:61613". More complicated ones are
947 possible; see your stomp server's documentation for
949 queue_basename: a root name to use for queues (stomp only). Typically
950 something like '/queue/sitename/' makes sense. If running
951 multiple instances on the same server, make sure that
952 either this setting or $config['site']['nickname'] are
953 unique for each site to keep them separate.
955 stomp_username: username for connecting to the stomp server; defaults
957 stomp_password: password for connecting to the stomp server; defaults
960 stomp_persistent: keep items across queue server restart, if enabled.
961 Under ActiveMQ, the server configuration determines if and how
962 persistent storage is actually saved.
964 If using a message queue server other than ActiveMQ, you may
965 need to disable this if it does not support persistence.
967 stomp_transactions: use transactions to aid in error detection.
968 A broken transaction will be seen quickly, allowing a message
969 to be redelivered immediately if a daemon crashes.
971 If using a message queue server other than ActiveMQ, you may
972 need to disable this if it does not support transactions.
974 stomp_acks: send acknowledgements to aid in flow control.
975 An acknowledgement of successful processing tells the server
976 we're ready for more and can help keep things moving smoothly.
978 This should *not* be turned off when running with ActiveMQ, but
979 if using another message queue server that does not support
980 acknowledgements you might need to disable this.
982 softlimit: an absolute or relative "soft memory limit"; daemons will
983 restart themselves gracefully when they find they've hit
984 this amount of memory usage. Defaults to 90% of PHP's global
985 memory_limit setting.
987 inboxes: delivery of messages to receiver's inboxes can be delayed to
988 queue time for best interactive performance on the sender.
989 This may however be annoyingly slow when using the DB queues,
990 so you can set this to false if it's causing trouble.
992 breakout: for stomp, individual queues are by default grouped up for
993 best scalability. If some need to be run by separate daemons,
994 etc they can be manually adjusted here.
996 Default will share all queues for all sites within each group.
997 Specify as <group>/<queue> or <group>/<queue>/<site>,
998 using nickname identifier as site.
1000 'main/distrib' separate "distrib" queue covering all sites
1001 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
1003 max_retries: for stomp, drop messages after N failed attempts to process.
1006 dead_letter_dir: for stomp, optional directory to dump data on failed
1007 queue processing events after discarding them.
1009 stomp_no_transactions: for stomp, the server does not support transactions,
1010 so do not try to user them. This is needed for http://www.morbidq.com/.
1012 stomp_no_acks: for stomp, the server does not support acknowledgements.
1013 so do not try to user them. This is needed for http://www.morbidq.com/.
1018 The default license to use for your users notices. The default is the
1019 Creative Commons Attribution 3.0 license, which is probably the right
1020 choice for any public site. Note that some other servers will not
1021 accept notices if you apply a stricter license than this.
1023 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1024 (default copyright), or 'private' (for private and confidential
1026 owner: for 'allrightsreserved' or 'private', an assigned copyright
1027 holder (for example, an employer for a private site). If
1028 not specified, will be attributed to 'contributors'.
1029 url: URL of the license, used for links.
1030 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1031 image: A button shown on each page for the license.
1036 This is for configuring out-going email. We use PEAR's Mail module,
1037 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1039 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1040 'smtp'. Defaults to PEAR's default, 'mail'.
1041 params: if the mail backend requires any parameters, you can provide
1042 them in an associative array.
1047 This is for configuring nicknames in the service.
1049 blacklist: an array of strings for usernames that may not be
1050 registered. A default array exists for strings that are
1051 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1052 but you may want to add others if you have other software
1053 installed in a subdirectory of StatusNet or if you just
1054 don't want certain words used as usernames.
1055 featured: an array of nicknames of 'featured' users of the site.
1056 Can be useful to draw attention to well-known users, or
1057 interesting people, or whatever.
1062 For configuring avatar access.
1064 dir: Directory to look for avatar files and to put them into.
1065 Defaults to avatar subdirectory of install directory; if
1066 you change it, make sure to change path, too.
1067 path: Path to avatars. Defaults to path for avatar subdirectory,
1068 but you can change it if you wish. Note that this will
1069 be included with the avatar server, too.
1070 server: If set, defines another server where avatars are stored in the
1071 root directory. Note that the 'avatar' subdir still has to be
1072 writeable. You'd typically use this to split HTTP requests on
1073 the client to speed up page loading, either with another
1074 virtual server or with an NFS or SAMBA share. Clients
1075 typically only make 2 connections to a single server at a
1076 time <http://ur1.ca/6ih>, so this can parallelize the job.
1078 ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
1079 to guess based on site-wide SSL settings.
1084 For configuring the public stream.
1086 localonly: If set to true, only messages posted by users of this
1087 service (rather than other services, filtered through OMB)
1088 are shown in the public stream. Default true.
1089 blacklist: An array of IDs of users to hide from the public stream.
1090 Useful if you have someone making excessive Twitterfeed posts
1091 to the site, other kinds of automated posts, testing bots, etc.
1092 autosource: Sources of notices that are from automatic posters, and thus
1093 should be kept off the public timeline. Default empty.
1098 server: Like avatars, you can speed up page loading by pointing the
1099 theme file lookup to another server (virtual or real).
1100 Defaults to NULL, meaning to use the site server.
1101 dir: Directory where theme files are stored. Used to determine
1102 whether to show parts of a theme file. Defaults to the theme
1103 subdirectory of the install directory.
1104 path: Path part of theme URLs, before the theme name. Relative to the
1105 theme server. It may make sense to change this path when upgrading,
1106 (using version numbers as the path) to make sure that all files are
1107 reloaded by caching clients or proxies. Defaults to null,
1108 which means to use the site path + '/theme'.
1109 ssl: Whether to use SSL for theme elements. Default is null, which means
1110 guess based on site SSL settings.
1111 sslserver: SSL server to use when page is HTTPS-encrypted. If
1112 unspecified, site ssl server and so on will be used.
1113 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1118 server: You can speed up page loading by pointing the
1119 theme file lookup to another server (virtual or real).
1120 Defaults to NULL, meaning to use the site server.
1121 path: Path part of Javascript URLs. Defaults to null,
1122 which means to use the site path + '/js/'.
1123 ssl: Whether to use SSL for JavaScript files. Default is null, which means
1124 guess based on site SSL settings.
1125 sslserver: SSL server to use when page is HTTPS-encrypted. If
1126 unspecified, site ssl server and so on will be used.
1127 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1128 bustframes: If true, all web pages will break out of framesets. If false,
1129 can comfortably live in a frame or iframe... probably. Default
1135 For configuring the XMPP sub-system.
1137 enabled: Whether to accept and send messages by XMPP. Default false.
1138 server: server part of XMPP ID for update user.
1139 port: connection port for clients. Default 5222, which you probably
1140 shouldn't need to change.
1141 user: username for the client connection. Users will receive messages
1142 from 'user'@'server'.
1143 resource: a unique identifier for the connection to the server. This
1144 is actually used as a prefix for each XMPP component in the system.
1145 password: password for the user account.
1146 host: some XMPP domains are served by machines with a different
1147 hostname. (For example, @gmail.com GTalk users connect to
1148 talk.google.com). Set this to the correct hostname if that's the
1149 case with your server.
1150 encryption: Whether to encrypt the connection between StatusNet and the
1151 XMPP server. Defaults to true, but you can get
1152 considerably better performance turning it off if you're
1153 connecting to a server on the same machine or on a
1155 debug: if turned on, this will make the XMPP library blurt out all of
1156 the incoming and outgoing messages as XML stanzas. Use as a
1157 last resort, and never turn it on if you don't have queues
1158 enabled, since it will spit out sensitive data to the browser.
1159 public: an array of JIDs to send _all_ notices to. This is useful for
1160 participating in third-party search and archiving services.
1165 For configuring invites.
1167 enabled: Whether to allow users to send invites. Default true.
1172 Miscellaneous tagging stuff.
1174 dropoff: Decay factor for tag listing, in seconds.
1175 Defaults to exponential decay over ten days; you can twiddle
1176 with it to try and get better results for your site.
1181 Settings for the "popular" section of the site.
1183 dropoff: Decay factor for popularity listing, in seconds.
1184 Defaults to exponential decay over ten days; you can twiddle
1185 with it to try and get better results for your site.
1190 For daemon processes.
1192 piddir: directory that daemon processes should write their PID file
1193 (process ID) to. Defaults to /var/run/, which is where this
1194 stuff should usually go on Unix-ish systems.
1195 user: If set, the daemons will try to change their effective user ID
1196 to this user before running. Probably a good idea, especially if
1197 you start the daemons as root. Note: user name, like 'daemon',
1199 group: If set, the daemons will try to change their effective group ID
1200 to this named group. Again, a name, not a numerical ID.
1205 You can get a significant boost in performance by caching some
1206 database data in memcached <http://www.danga.com/memcached/>.
1208 enabled: Set to true to enable. Default false.
1209 server: a string with the hostname of the memcached server. Can also
1210 be an array of hostnames, if you've got more than one server.
1211 base: memcached uses key-value pairs to store data. We build long,
1212 funny-looking keys to make sure we don't have any conflicts. The
1213 base of the key is usually a simplified version of the site name
1214 (like "Identi.ca" => "identica"), but you can overwrite this if
1215 you need to. You can safely ignore it if you only have one
1216 StatusNet site using your memcached server.
1217 port: Port to connect to; defaults to 11211.
1224 enabled: Whether to enable post-by-email. Defaults to true. You will
1225 also need to set up maildaemon.php.
1230 For SMS integration.
1232 enabled: Whether to enable SMS integration. Defaults to true. Queues
1233 should also be enabled.
1238 A catch-all for integration with other systems.
1240 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1247 enabled: No longer used. If you set this to something other than true,
1248 StatusNet will no longer run.
1253 For notice-posting throttles.
1255 enabled: Whether to throttle posting. Defaults to false.
1256 count: Each user can make this many posts in 'timespan' seconds. So, if count
1257 is 100 and timespan is 3600, then there can be only 100 posts
1258 from a user every hour.
1259 timespan: see 'count'.
1266 biolimit: max character length of bio; 0 means no limit; null means to use
1267 the site text limit default.
1268 backup: whether users can backup their own profiles. Defaults to true.
1269 restore: whether users can restore their profiles from backup files. Defaults
1271 delete: whether users can delete their own accounts. Defaults to false.
1272 move: whether users can move their accounts to another server. Defaults
1278 Options with new users.
1280 default: nickname of a user account to automatically subscribe new
1281 users to. Typically this would be system account for e.g.
1282 service updates or announcements. Users are able to unsub
1283 if they want. Default is null; no auto subscribe.
1284 welcome: nickname of a user account that sends welcome messages to new
1285 users. Can be the same as 'default' account, although on
1286 busy servers it may be a good idea to keep that one just for
1287 'urgent' messages. Default is null; no message.
1289 If either of these special user accounts are specified, the users should
1290 be created before the configuration is updated.
1295 The software will, by default, send statistical snapshots about the
1296 local installation to a stats server on the status.net Web site. This
1297 data is used by the developers to prioritize development decisions. No
1298 identifying data about users or organizations is collected. The data
1299 is available to the public for review. Participating in this survey
1300 helps StatusNet developers take your needs into account when updating
1303 run: string indicating when to run the statistics. Values can be 'web'
1304 (run occasionally at Web time), 'cron' (run from a cron script),
1305 or 'never' (don't ever run). If you set it to 'cron', remember to
1306 schedule the script to run on a regular basis.
1307 frequency: if run value is 'web', how often to report statistics.
1308 Measured in Web hits; depends on how active your site is.
1309 Default is 10000 -- that is, one report every 10000 Web hits,
1311 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1312 report system, but if they go evil or disappear you may
1313 need to update this to another value. Note: if you
1314 don't want to report stats, it's much better to
1315 set 'run' to 'never' than to set this value to something
1321 The software lets users upload files with their notices. You can configure
1322 the types of accepted files by mime types and a trio of quota options:
1323 per file, per user (total), per user per month.
1325 We suggest the use of the pecl file_info extension to handle mime type
1328 supported: an array of mime types you accept to store and distribute,
1329 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1330 setup your server to properly recognize the types you want to
1332 uploads: false to disable uploading files with notices (true by default).
1333 filecommand: The required MIME_Type library may need to use the 'file'
1334 command. It tries the one in the Web server's path, but if
1335 you're having problems with uploads, try setting this to the
1336 correct value. Note: 'file' must accept '-b' and '-i' options.
1338 For quotas, be sure you've set the upload_max_filesize and post_max_size
1339 in php.ini to be large enough to handle your upload. In httpd.conf
1340 (if you're using apache), check that the LimitRequestBody directive isn't
1341 set too low (it's optional, so it may not be there at all).
1343 file_quota: maximum size for a single file upload in bytes. A user can send
1344 any amount of notices with attachments as long as each attachment
1345 is smaller than file_quota.
1346 user_quota: total size in bytes a user can store on this server. Each user
1347 can store any number of files as long as their total size does
1348 not exceed the user_quota.
1349 monthly_quota: total size permitted in the current month. This is the total
1350 size in bytes that a user can upload each month.
1351 dir: directory accessible to the Web process where uploads should go.
1352 Defaults to the 'file' subdirectory of the install directory, which
1353 should be writeable by the Web user.
1354 server: server name to use when creating URLs for uploaded files.
1355 Defaults to null, meaning to use the default Web server. Using
1356 a virtual server here can speed up Web performance.
1357 path: URL path, relative to the server, to find files. Defaults to
1358 main path + '/file/'.
1359 ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
1360 guess based on other SSL settings.
1361 filecommand: command to use for determining the type of a file. May be
1362 skipped if fileinfo extension is installed. Defaults to
1364 sslserver: if specified, this server will be used when creating HTTPS
1365 URLs. Otherwise, the site SSL server will be used, with /file/ path.
1366 sslpath: if this and the sslserver are specified, this path will be used
1367 when creating HTTPS URLs. Otherwise, the attachments|path value
1373 Options for group functionality.
1375 maxaliases: maximum number of aliases a group can have. Default 3. Set
1376 to 0 or less to prevent aliases in a group.
1377 desclimit: maximum number of characters to allow in group descriptions.
1378 null (default) means to use the site-wide text limits. 0
1384 oEmbed endpoint for multimedia attachments (links in posts).
1386 endpoint: oohembed endpoint using http://oohembed.com/ software.
1391 Some stuff for search.
1393 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1394 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1395 but requires the lame old MyISAM engine for MySQL. The latter
1396 will work with InnoDB but could be miserably slow on large
1397 systems. We'll probably add another type sometime in the future,
1398 with our own indexing system (maybe like MediaWiki's).
1405 handle: boolean. Whether we should register our own PHP session-handling
1406 code (using the database and memcache if enabled). Defaults to false.
1407 Setting this to true makes some sense on large or multi-server
1408 sites, but it probably won't hurt for smaller ones, either.
1409 debug: whether to output debugging info for session storage. Can help
1410 with weird session bugs, sometimes. Default false.
1415 Users can upload backgrounds for their pages; this section defines
1418 server: the server to use for background. Using a separate (even
1419 virtual) server for this can speed up load times. Default is
1420 null; same as site server.
1421 dir: directory to write backgrounds too. Default is '/background/'
1422 subdir of install dir.
1423 path: path to backgrounds. Default is sub-path of install path; note
1424 that you may need to change this if you change site-path too.
1425 sslserver: SSL server to use when page is HTTPS-encrypted. If
1426 unspecified, site ssl server and so on will be used.
1427 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1432 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1433 notify third-party servers of updates.
1435 notify: an array of URLs for ping endpoints. Default is the empty
1436 array (no notification).
1441 Default design (colors and background) for the site. Actual appearance
1442 depends on the theme. Null values mean to use the theme defaults.
1444 backgroundcolor: Hex color of the site background.
1445 contentcolor: Hex color of the content area background.
1446 sidebarcolor: Hex color of the sidebar background.
1447 textcolor: Hex color of all non-link text.
1448 linkcolor: Hex color of all links.
1449 backgroundimage: Image to use for the background.
1450 disposition: Flags for whether or not to tile the background image.
1455 Configuration options specific to notices.
1457 contentlimit: max length of the plain-text content of a notice.
1458 Default is null, meaning to use the site-wide text limit.
1464 Configuration options specific to messages.
1466 contentlimit: max length of the plain-text content of a message.
1467 Default is null, meaning to use the site-wide text limit.
1473 Configuration options for the login command.
1475 disabled: whether to enable this command. If enabled, users who send
1476 the text 'login' to the site through any channel will
1477 receive a link to login to the site automatically in return.
1478 Possibly useful for users who primarily use an XMPP or SMS
1479 interface and can't be bothered to remember their site
1480 password. Note that the security implications of this are
1481 pretty serious and have not been thoroughly tested. You
1482 should enable it only after you've convinced yourself that
1483 it is safe. Default is 'false'.
1488 If an installation has only one user, this can simplify a lot of the
1489 interface. It also makes the user's profile the root URL.
1491 enabled: Whether to run in "single user mode". Default false.
1492 nickname: nickname of the single user. If no nickname is specified,
1493 the site owner account will be used (if present).
1498 We put out a default robots.txt file to guide the processing of
1499 Web crawlers. See http://www.robotstxt.org/ for more information
1500 on the format of this file.
1502 crawldelay: if non-empty, this value is provided as the Crawl-Delay:
1503 for the robots.txt file. see http://ur1.ca/l5a0
1504 for more information. Default is zero, no explicit delay.
1505 disallow: Array of (virtual) directories to disallow. Default is 'main',
1506 'search', 'message', 'settings', 'admin'. Ignored when site
1507 is private, in which case the entire site ('/') is disallowed.
1512 Options for the Twitter-like API.
1514 realm: HTTP Basic Auth realm (see http://tools.ietf.org/html/rfc2617
1515 for details). Some third-party tools like ping.fm want this to be
1516 'Identi.ca API', so set it to that if you want to. default = null,
1517 meaning 'something based on the site name'.
1522 We optionally put 'rel="nofollow"' on some links in some pages. The
1523 following configuration settings let you fine-tune how or when things
1524 are nofollowed. See http://en.wikipedia.org/wiki/Nofollow for more
1525 information on what 'nofollow' means.
1527 subscribers: whether to nofollow links to subscribers on the profile
1528 and personal pages. Default is true.
1529 members: links to members on the group page. Default true.
1530 peopletag: links to people listed in the peopletag page. Default true.
1531 external: external links in notices. One of three values: 'sometimes',
1532 'always', 'never'. If 'sometimes', then external links are not
1533 nofollowed on profile, notice, and favorites page. Default is
1539 We use a router class for mapping URLs to code. This section controls
1540 how that router works.
1542 cache: whether to cache the router in memcache (or another caching
1543 mechanism). Defaults to true, but may be set to false for
1544 developers (who might be actively adding pages, so won't want the
1545 router cached) or others who see strange behavior. You're unlikely
1546 to need this unless you're a developer.
1551 Settings for the HTTP client.
1553 ssl_cafile: location of the CA file for SSL. If not set, won't verify
1554 SSL peers. Default unset.
1555 curl: Use cURL <http://curl.haxx.se/> for doing HTTP calls. You must
1556 have the PHP curl extension installed for this to work.
1557 proxy_host: Host to use for proxying HTTP requests. If unset, doesn't
1558 do any HTTP proxy stuff. Default unset.
1559 proxy_port: Port to use to connect to HTTP proxy host. Default null.
1560 proxy_user: Username to use for authenticating to the HTTP proxy. Default null.
1561 proxy_password: Password to use for authenticating to the HTTP proxy. Default null.
1562 proxy_auth_scheme: Scheme to use for authenticating to the HTTP proxy. Default null.
1567 default: associative array mapping plugin name to array of arguments. To disable
1568 a default plugin, unset its value in this array.
1569 locale_path: path for finding plugin locale files. In the plugin's directory
1571 server: Server to find static files for a plugin when the page is plain old HTTP.
1572 Defaults to site/server (same as pages). Use this to move plugin CSS and
1574 sslserver: Server to find static files for a plugin when the page is HTTPS. Defaults
1575 to site/server (same as pages). Use this to move plugin CSS and JS files
1577 path: Path to the plugin files. defaults to site/path + '/plugins/'. Expects that
1578 each plugin will have a subdirectory at plugins/NameOfPlugin. Change this
1579 if you're using a CDN.
1580 sslpath: Path to use on the SSL server. Same as plugins/path.
1585 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1586 powerful plugin architecture. Important events in the code are named,
1587 like 'StartNoticeSave', and other software can register interest
1588 in those events. When the events happen, the other software is called
1589 and has a choice of accepting or rejecting the events.
1591 In the simplest case, you can add a function to config.php and use the
1592 Event::addHandler() function to hook an event:
1594 function AddGoogleLink($action)
1596 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1600 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1602 This adds a menu item to the end of the main navigation menu. You can
1603 see the list of existing events, and parameters that handlers must
1604 implement, in EVENTS.txt.
1606 The Plugin class in lib/plugin.php makes it easier to write more
1607 complex plugins. Sub-classes can just create methods named
1608 'onEventName', where 'EventName' is the name of the event (case
1609 matters!). These methods will be automatically registered as event
1610 handlers by the Plugin constructor (which you must call from your own
1611 class's constructor).
1613 Several example plugins are included in the plugins/ directory. You
1614 can enable a plugin with the following line in config.php:
1616 addPlugin('Example', array('param1' => 'value1',
1617 'param2' => 'value2'));
1619 This will look for and load files named 'ExamplePlugin.php' or
1620 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1621 plugins that ship with StatusNet) or in the local/ directory (for
1622 plugins you write yourself or that you get from somewhere else) or
1625 Plugins are documented in their own directories.
1630 The primary output for StatusNet is syslog, unless you configured a
1631 separate logfile. This is probably the first place to look if you're
1632 getting weird behaviour from StatusNet.
1634 If you're tracking the unstable version of StatusNet in the git
1635 repository (see below), and you get a compilation error ("unexpected
1636 T_STRING") in the browser, check to see that you don't have any
1637 conflicts in your code.
1639 If you upgraded to StatusNet 0.9.x without reading the "Notice
1640 inboxes" section above, and all your users' 'Personal' tabs are empty,
1641 read the "Notice inboxes" section above.
1646 These are some myths you may see on the Web about StatusNet.
1647 Documentation from the core team about StatusNet has been pretty
1648 sparse, so some backtracking and guesswork resulted in some incorrect
1651 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1652 extremely bad idea. It's a tool built into DB_DataObject that will
1653 emit oodles of print lines directly to the browser of your users.
1654 Among these lines will be your database username and password. Do
1655 not enable this option on a production Web site for any reason.
1657 - "Edit dataobject.ini with the following settings..." dataobject.ini
1658 is a development file for the DB_DataObject framework and is not
1659 used by the running software. It was removed from the StatusNet
1660 distribution because its presence was confusing. Do not bother
1661 configuring dataobject.ini, and do not put your database username
1662 and password into the file on a production Web server; unscrupulous
1663 persons may try to read it to get your passwords.
1668 If you're adventurous or impatient, you may want to install the
1669 development version of StatusNet. To get it, use the git version
1670 control tool <http://git-scm.com/> like so:
1672 git clone git@gitorious.org:statusnet/mainline.git
1674 This is the version of the software that runs on Identi.ca and the
1675 status.net hosted service. Using it is a mixed bag. On the positive
1676 side, it usually includes the latest security and bug fix patches. On
1677 the downside, it may also include changes that require admin
1678 intervention (like running a script or even raw SQL!) that may not be
1679 documented yet. It may be a good idea to test this version before
1680 installing it on your production machines.
1682 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1687 There are several ways to get more information about StatusNet.
1689 * There is a mailing list for StatusNet developers and admins at
1690 http://mail.status.net/mailman/listinfo/statusnet-dev
1691 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1692 * The StatusNet wiki, http://status.net/wiki/
1693 * The StatusNet blog, http://status.net/blog/
1694 * The StatusNet status update, <http://status.status.net/> (!)
1699 * Microblogging messages to http://support.status.net/ are very welcome.
1700 * The microblogging group http://identi.ca/group/statusnet is a good
1701 place to discuss the software.
1702 * StatusNet has a bug tracker for any defects you may find, or ideas for
1703 making things better. http://status.net/bugs
1708 The following is an incomplete list of developers who've worked on
1709 StatusNet. Apologies for any oversight; please let evan@status.net know
1710 if anyone's been overlooked in error.
1712 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1713 * Zach Copley, StatusNet, Inc.
1714 * Earle Martin, StatusNet, Inc.
1715 * Marie-Claude Doyon, designer, StatusNet, Inc.
1716 * Sarven Capadisli, StatusNet, Inc.
1717 * Robin Millette, StatusNet, Inc.
1728 * Tryggvi Björgvinsson
1732 * Ken Sheppardson (Trac server, man-about-town)
1733 * Tiago 'gouki' Faria (i18n manager)
1735 * Leslie Michael Orchard
1739 * Tobias Diekershoff
1750 * Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
1751 * Brion Vibber, StatusNet, Inc.
1752 * James Walker, StatusNet, Inc.
1753 * Samantha Doherty, designer, StatusNet, Inc.
1755 Thanks also to the developers of our upstream library code and to the
1756 thousands of people who have tried out Identi.ca, installed StatusNet,
1757 told their friends, and built the Open Microblogging network to what