Statusnet-ladistribution is a project mainly written in PHP and JAVASCRIPT, based on the AGPL-3.0 license.
Fork of Status.net with modifications for La Distribution
StatusNet 0.9.6 "Man on the Moon" 29 October 2010
This is the README file for StatusNet, the Open Source microblogging platform. It includes installation instructions, descriptions of options you can set, warnings, tips, and general info for administrators. Information on using StatusNet can be found in the "doc" subdirectory or in the "help" section on-line.
StatusNet is a Free and Open Source microblogging platform. It helps people in a community, company or group to exchange short (140 characters, by default) messages over the Web. Users can choose which people to "follow" and receive only their friends' or colleagues' status messages. It provides a similar service to sites like Twitter, Google Buzz, or Yammer.
With a little work, status messages can be sent to mobile phones, instant messenger programs (GTalk/Jabber), and specially-designed desktop clients that support the Twitter API.
StatusNet supports an open standard called OStatus http://ostatus.org/ that lets users in different networks follow each other. It enables a distributed social network spread all across the Web.
StatusNet was originally developed for the Open Software Service, Identi.ca http://identi.ca/. It is shared with you in hope that you too make an Open Software Service available to your users. To learn more, please see the Open Software Service Definition 1.1:
http://www.opendefinition.org/ossdStatusNet, Inc. http://status.net/ also offers this software as a Web service, requiring no installation on your part. See http://status.net/signup for details. The software run on status.net is identical to the software available for download, so you can move back and forth between a hosted version or a version installed on your own servers.
A commercial software subscription is available from StatusNet Inc. It includes 24-hour technical support and developer support. More information at http://status.net/contact or email [email protected].
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program, in the file "COPYING". If not, see http://www.gnu.org/licenses/.
IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
*different requirements* from the "regular" GPL. In particular, if
you make modifications to the StatusNet source code on your server,
you *MUST MAKE AVAILABLE* the modified version of the source code
to your users under the same license. This is a legal requirement
of using the software, and if you do not wish to share your
modifications, *YOU MAY NOT INSTALL STATUSNET*.Documentation in the /doc-src/ directory is available under the Creative Commons Attribution 3.0 Unported license, with attribution to "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
CSS and images in the /theme/ directory are available under the Creative Commons Attribution 3.0 Unported license, with attribution to "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
Our understanding and intention is that if you add your own theme that uses only CSS and images, those files are not subject to the copyleft requirements of the Affero General Public License 3.0. See http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not legal advice; consult your lawyer.
Additional library software has been made available in the 'extlib' directory. All of it is Free Software and can be distributed under liberal terms, but those terms may differ in detail from the AGPL's particulars. See each package's license file in the extlib directory for additional terms.
This is a security, bug and feature release since version 0.9.5 released on 10 September 2010.
For best compatibility with client software and site federation, and a lot of bug fixes, it is highly recommended that all public sites upgrade to the new version.
Notable changes this version:
Changes from 0.9.6 release candidate 1:
A full changelog is available at http://status.net/wiki/StatusNet_0.9.6.
The following software packages are required for this software to run correctly.
Your PHP installation must include the following PHP extensions:
For some functionality, you will also need the following extensions:
You will almost definitely get 2-3 times better performance from your site if you install a PHP bytecode cache/accelerator. Some well-known examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer is a proprietary accelerator installed on some hosting sites.
A number of external PHP libraries are used to provide basic functionality and optional functionality for your system. For your convenience, they are available in the "extlib" directory of this package, and you do not have to download and install them. However, you may want to keep them up-to-date with the latest upstream version, and the URLs are listed here for your convenience.
A design goal of StatusNet is that the basic Web functionality should work on even the most restrictive commercial hosting services. However, additional functionality, such as receiving messages by Jabber/GTalk, require that you be able to run long-running processes on your account. In addition, posting by email or from SMS require that you be able to install a mail filter in your mail server.
Installing the basic StatusNet Web component is relatively easy, especially if you've previously installed PHP/MySQL packages.
Unpack the tarball you downloaded on your Web server. Usually a command like this will work:
tar zxf statusnet-0.9.6.tar.gz
...which will make a statusnet-0.9.6 subdirectory in your current directory. (If you don't have shell access on your Web server, you may have to unpack the tarball on your local computer and FTP the files to the server.)
Move the tarball to a directory of your choosing in your Web root directory. Usually something like this will work:
mv statusnet-0.9.6 /var/www/statusnet
This will make your StatusNet instance available in the statusnet path of your server, like "http://example.net/statusnet". "microblog" or "statusnet" might also be good path names. If you know how to configure virtual hosts on your web server, you can try setting up "http://micro.example.net/" or the like.
Make your target directory writeable by the Web server.
chmod a+w /var/www/statusnet/
On some systems, this will probably work:
chgrp www-data /var/www/statusnet/ chmod g+w /var/www/statusnet/
If your Web server runs as another user besides "www-data", try that user's default group instead. As a last resort, you can create a new group like "statusnet" and add the Web server's user to the group.
You should also take this moment to make your avatar, background, and file subdirectories writeable by the Web server. An insecure way to do this is:
chmod a+w /var/www/statusnet/avatar chmod a+w /var/www/statusnet/background chmod a+w /var/www/statusnet/file
You can also make the avatar, background, and file directories writeable by the Web server group, as noted above.
Create a database to hold your microblog data. Something like this should work:
mysqladmin -u "username" --password="password" create statusnet
Note that StatusNet must have its own database; you can't share the database with another program. You can name it whatever you want, though.
(If you don't have shell access to your server, you may need to use a tool like PHPAdmin to create a database. Check your hosting service's documentation for how to create a new MySQL database.)
Create a new database account that StatusNet will use to access the database. If you have shell access, this will probably work from the MySQL shell:
GRANT ALL on statusnet.* TO 'statusnetuser'@'localhost' IDENTIFIED BY 'statusnetpassword';
You should change 'statusnetuser' and 'statusnetpassword' to your preferred new username and password. You may want to test logging in to MySQL as this new user.
In a browser, navigate to the StatusNet install script; something like:
http://yourserver.example.com/statusnet/install.php
Enter the database connection information and your site name. The install program will configure your site and install the initial, almost-empty database.
You should now be able to navigate to your microblog's main directory and see the "Public Timeline", which will be empty. If not, magic has happened! You can now register a new user, post some notices, edit your profile, etc. However, you may want to wait to do that stuff if you think you can set up "fancy URLs" (see below), since some URLs are stored in the database.
By default, StatusNet will use URLs that include the main PHP program's name in them. For example, a user's home profile might be found at:
http://example.org/statusnet/index.php/statusnet/fredOn certain systems that don't support this kind of syntax, they'll look like this:
http://example.org/statusnet/index.php?p=statusnet/fredIt's possible to configure the software so it looks like this instead:
http://example.org/statusnet/fredThese "fancy URLs" are more readable and memorable for users. To use fancy URLs, you must either have Apache 2.x with .htaccess enabled and mod_rewrite enabled, -OR- know how to configure "url redirection" in your server.
Copy the htaccess.sample file to .htaccess in your StatusNet directory. Note: if you have control of your server's httpd.conf or similar configuration files, it can greatly improve performance to import the .htaccess file into your conf file instead. If you're not sure how to do it, you may save yourself a lot of headache by just leaving the .htaccess file.
Change the "RewriteBase" in the new .htaccess file to be the URL path to your StatusNet installation on your server. Typically this will be the path to your StatusNet directory relative to your Web root.
Add or uncomment or change a line in your config.php file so it says:
$config['site']['fancy'] = true;
You should now be able to navigate to a "fancy" URL on your server, like:
http://example.net/statusnet/main/registerIf you changed your HTTP server configuration, you may need to restart the server first.
If it doesn't work, double-check that AllowOverride for the StatusNet directory is 'All' in your Apache configuration file. This is usually /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu) /etc/apache2/sites-available/default. See the Apache documentation for .htaccess files for more details:
http://httpd.apache.org/docs/2.2/howto/htaccess.htmlAlso, check that mod_rewrite is installed and enabled:
http://httpd.apache.org/docs/2.2/mod/mod_rewrite.htmlTo use a Sphinx server to search users and notices, you'll need to enable the SphinxSearch plugin. Add to your config.php:
addPlugin('SphinxSearch');
$config['sphinx']['server'] = 'searchhost.local';You also need to install, compile and enable the sphinx pecl extension for php on the client side, which itself depends on the sphinx development files.
See plugins/SphinxSearch/README for more details and server setup.
StatusNet supports a cheap-and-dirty system for sending update messages to mobile phones and for receiving updates from the mobile. Instead of sending through the SMS network itself, which is costly and requires buy-in from the wireless carriers, it simply piggybacks on the email gateways that many carriers provide to their customers. So, SMS configuration is essentially email configuration.
Each user sends to a made-up email address, which they keep a secret. Incoming email that is "From" the user's SMS email address, and "To" the users' secret email address on the site's domain, will be converted to a notice and stored in the DB.
For this to work, there must be a domain or sub-domain for which all (or most) incoming email can pass through the incoming mail filter.
Run the SQL script carrier.sql in your StatusNet database. This will usually work:
mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
This will populate your database with a list of wireless carriers that support email SMS gateways.
Make sure the maildaemon.php file is executable:
chmod +x scripts/maildaemon.php
Note that "daemon" is kind of a misnomer here; the script is more of a filter than a daemon.
Edit /etc/aliases on your mail server and add the following line:
*: /path/to/statusnet/scripts/maildaemon.php
Run whatever code you need to to update your aliases database. For many mail servers (Postfix, Exim, Sendmail), this should work:
newaliases
You may need to restart your mail server for the new database to take effect.
Set the following in your config.php file:
$config['mail']['domain'] = 'yourdomain.example.net';
At this point, post-by-email and post-by-SMS-gateway should work. Note that if your mail server is on a different computer from your email server, you'll need to have a full installation of StatusNet, a working config.php, and access to the StatusNet database from the mail server.
XMPP (eXtended Message and Presence Protocol, http://xmpp.org/) is the instant-messenger protocol that drives Jabber and GTalk IM. You can distribute messages via XMPP using the system below; however, you need to run the XMPP incoming daemon to allow incoming messages as well.
You may want to strongly consider setting up your own XMPP server. Ejabberd, OpenFire, and JabberD are all Open Source servers. Jabber, Inc. provides a high-performance commercial server.
You must register a Jabber ID (JID) with your new server. It helps to choose a name like "[email protected]" or "notice" or something similar. Alternately, your "update JID" can be registered on a publicly-available XMPP service, like jabber.org or GTalk.
StatusNet will not register the JID with your chosen XMPP server; you need to do this manually, with an XMPP client like Gajim, Telepathy, or Pidgin.im.
Configure your site's XMPP variables, as described below in the configuration section.
On a default installation, your site can broadcast messages using XMPP. Users won't be able to post messages using XMPP unless you've got the XMPP daemon running. See 'Queues and daemons' below for how to set that up. Also, once you have a sizable number of users, sending a lot of SMS, OMB, and XMPP messages whenever someone posts a message can really slow down your site; it may cause posting to timeout.
NOTE: stream_select(), a crucial function for network programming, is broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't work around this bug in StatusNet; current recommendation is to move off of amd64 to another server.
You can send all messages from your microblogging site to a third-party service using XMPP. This can be useful for providing search, indexing, bridging, or other cool services.
To configure a downstream site to receive your public stream, add their "JID" (Jabber ID) to your config.php as follows:
$config['xmpp']['public'][] = '[email protected]';(Don't miss those square brackets at the end.) Note that your XMPP broadcasting must be configured as mentioned above. Although you can send out messages at "Web time", high-volume sites should strongly consider setting up queues and daemons.
Some activities that StatusNet needs to do, like broadcast OStatus, SMS, and XMPP messages, can be 'queued' and done by off-line bots instead. For this to work, you must be able to run long-running offline processes, either on your main Web server or on another server you control. (Your other server will still need all the above prerequisites, with the exception of Apache.) Installing on a separate server is probably a good idea for high-volume sites.
You'll need the "CLI" (command-line interface) version of PHP installed on whatever server you use.
If you're using a separate server for queues, install StatusNet somewhere on the server. You don't need to worry about the .htaccess file, but make sure that your config.php file is close to, or identical to, your Web server's version.
In your config.php files (both the Web server and the queues server!), set the following variable:
$config['queue']['enabled'] = true;
You may also want to look at the 'daemon' section of this file for more daemon options. Note that if you set the 'user' and/or 'group' options, you'll need to create that user and/or group by hand. They're not created automatically.
On the queues server, run the command scripts/startdaemons.sh.
This will run the queue handlers:
These two daemons will automatically restart in most cases of failure including memory leaks (if a memory_limit is set), but may still die or behave oddly if they lose connections to the XMPP or queue servers.
Additional daemons may be also started by this script for certain plugins, such as the Twitter bridge.
It may be a good idea to use a daemon-monitoring service, like 'monit', to check their status and keep them running.
All the daemons write their process IDs (pids) to /var/run/ by default. This can be useful for starting, stopping, and monitoring the daemons.
Since version 0.8.0, it's now possible to use a STOMP server instead of our kind of hacky home-grown DB-based queue solution. This is strongly recommended for best response time, especially when using XMPP.
See the "queues" config section below for how to configure to use STOMP. As of this writing, the software has been tested with ActiveMQ 5.3.
There are two themes shipped with this version of StatusNet: "identica", which is what the Identi.ca site uses, and "default", which is a good basis for other sites.
As of right now, your ability to change the theme is site-wide; users can't choose their own theme. Additionally, the only thing you can change in the theme is CSS stylesheets and some image files; you can't change the HTML output, like adding or removing menu items.
You can choose a theme using the $config['site']['theme'] element in the config.php file. See below for details.
You can add your own theme by making a sub-directory of the 'theme' subdirectory with the name of your theme. Each theme can have the following files:
display.css: a CSS2 file for "default" styling for all browsers. ie6.css: a CSS2 file for override styling for fixing up Internet Explorer 6. ie7.css: a CSS2 file for override styling for fixing up Internet Explorer 7. logo.png: a logo image for the site. default-avatar-profile.png: a 96x96 pixel image to use as the avatar for users who don't upload their own. default-avatar-stream.png: Ditto, but 48x48. For streams of notices. default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions listing on profile pages.
You may want to start by copying the files from the default theme to your own directory.
NOTE: the HTML generated by StatusNet changed radically between version 0.6.x and 0.7.x. Older themes will need signification modification to use the new output format.
Translations in StatusNet use the gettext system http://www.gnu.org/software/gettext/. Theoretically, you can add your own sub-directory to the locale/ subdirectory to add a new language to your system. You'll need to compile the ".po" files into ".mo" files, however.
Contributions of translation information to StatusNet are very easy: you can use the Web interface at translatewiki.net to add one or a few or lots of new translations -- or even new languages. You can also download more up-to-date .po files there, if you so desire.
For info on helping with translations, see http://status.net/wiki/Translations
There is no built-in system for doing backups in StatusNet. You can make backups of a working StatusNet system by backing up the database and the Web directory. To backup the database use mysqldump http://ur1.ca/7xo and to backup the Web directory, try tar.
The administrator can set the "private" flag for a site so that it's not visible to non-logged-in users. This might be useful for workgroups who want to share a microblogging site for project management, but host it on a public server.
Total privacy is not guaranteed or ensured. Also, privacy is all-or-nothing for a site; you can't have some accounts or notices private, and others public. The interaction of private sites with OStatus is undefined.
Access to file attachments can also be restricted to logged-in users only.
Add a directory outside the web root where your file uploads will be stored. Usually a command like this will work:
mkdir /var/www/statusnet-files
Make the file uploads directory writeable by the web server. An insecure way to do this is:
chmod a+x /var/www/statusnet-files
Tell StatusNet to use this directory for file uploads. Add a line like this to your config.php:
$config['attachments']['dir'] = '/var/www/statusnet-files';
IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some incorrectly-stored international characters ("UTF-8"). For new installations, it will now store non-ASCII characters correctly. However, older installations will have the incorrect storage, and will consequently show up "wrong" in browsers. See below for how to deal with this situation.
If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've been tracking the "git" version of the software, you will probably want to upgrade and keep your existing data. There is no automated upgrade procedure in StatusNet 0.9.6. Try these step-by-step instructions; read to the end first before trying them.
Rebuild the database. (You can safely skip this step and go to #12 if you're upgrading from another 0.9.x version).
NOTE: this step is destructive and cannot be reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't do it without a known-good backup!
If your database is at version 0.8.0 or above, you can run a special upgrade script:
mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sqlOtherwise, go to your StatusNet directory and AFTER YOU MAKE A BACKUP run the rebuilddb.sh script like this:
./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sqlHere, rootuser and rootpassword are the username and password for a user who can drop and create databases as well as tables; typically that's not the user StatusNet runs as. Note that rebuilddb.sh drops your database and rebuilds it; if there is an error you have no database. Make sure you have a backup. For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh, which operates slightly differently. Read the documentation in that script before running it.
If you're upgrading from very old versions, you may want to look at the fixup_* scripts in the scripts directories. These will store some precooked data in the DB. All upgraders should check out the inboxes options below.
NOTE: the database definition file, laconica.ini, has been renamed to statusnet.ini (since this is the recommended database name). If you have a line in your config.php pointing to the old name, you'll need to update it.
Notice inboxes are now required. If you don't have inboxes enabled, StatusNet will no longer run.
StatusNet 0.7.4 introduced a fix for some incorrectly-stored international characters ("UTF-8"). This fix is not backwards-compatible; installations from before 0.7.4 will show non-ASCII characters of old notices incorrectly. This section explains what to do.
The main configuration file for StatusNet (excepting configurations for dependency software) is config.php in your StatusNet directory. If you edit any other file in the directory, like lib/default.php (where most of the defaults are defined), you will lose your configuration options in any upgrade, and you will wish that you had been more careful.
Starting with version 0.9.0, a Web based configuration panel has been added to StatusNet. The preferred method for changing config options is to use this panel.
A command-line script, setconfig.php, can be used to set individual configuration options. It's in the scripts/ directory.
Starting with version 0.7.1, you can put config files in the /etc/statusnet/ directory on your server, if it exists. Config files will be included in this order:
Almost all configuration options are made through a two-dimensional associative array, cleverly named $config. A typical configuration line will be:
$config['section']['option'] = value;For brevity, the following documentation describes each section and option.
This section is a catch-all for site-wide variables.
name: the name of your site, like 'YourCompany Microblog'. server: the server part of your site's URLs, like 'example.net'. path: The path part of your site's URLs, like 'statusnet' or '' (installed in root). fancy: whether or not your site uses fancy URLs (see Fancy URLs section above). Default is false. logfile: full path to a file for StatusNet to save logging information to. You may want to use this if you don't have access to syslog. logdebug: whether to log additional debug info like backtraces on hard errors. Default false. locale_path: full path to the directory for locale data. Unless you store all your locale data in one place, you probably don't need to use this. language: default language for your site. Defaults to US English. Note that this is overridden if a user is logged in and has selected a different language. It is also overridden if the user is NOT logged in, but their browser requests a different langauge. Since pretty much everybody's browser requests a language, that means that changing this setting has little or no effect in practice. languages: A list of languages supported on your site. Typically you'd only change this if you wanted to disable support for one or another language: "unset($config['site']['languages']['de'])" will disable support for German. theme: Theme for your site (see Theme section). Two themes are provided by default: 'default' and 'stoica' (the one used by Identi.ca). It's appreciated if you don't use the 'stoica' theme except as the basis for your own. email: contact email address for your site. By default, it's extracted from your Web server environment; you may want to customize it. broughtbyurl: name of an organization or individual who provides the service. Each page will include a link to this name in the footer. A good way to link to the blog, forum, wiki, corporate portal, or whoever is making the service available. broughtby: text used for the "brought by" link. timezone: default timezone for message display. Users can set their own time zone. Defaults to 'UTC', which is a pretty good default. closed: If set to 'true', will disallow registration on your site. This is a cheap way to restrict accounts to only one individual or group; just register the accounts you want on the service, then set this variable to 'true'. inviteonly: If set to 'true', will only allow registration if the user was invited by an existing user. private: If set to 'true', anonymous users will be redirected to the 'login' page. Also, API methods that normally require no authentication will require it. Note that this does not turn off registration; use 'closed' or 'inviteonly' for the behaviour you want. notice: A plain string that will appear on every page. A good place to put introductory information about your service, or info about upgrades and outages, or other community info. Any HTML will be escaped. logo: URL of an image file to use as the logo for the site. Overrides the logo in the theme, if any. ssllogo: URL of an image file to use as the logo on SSL pages. If unset, theme logo is used instead. ssl: Whether to use SSL and https:// URLs for some or all pages. Possible values are 'always' (use it for all pages), 'never' (don't use it for any pages), or 'sometimes' (use it for sensitive pages that include passwords like login and registration, but not for regular pages). Default to 'never'. sslserver: use an alternate server name for SSL URLs, like 'secure.example.org'. You should be careful to set cookie parameters correctly so that both the SSL server and the "normal" server can access the session cookie and preferably other cookies as well. shorturllength: Length of URL at which URLs in a message exceeding 140 characters will be sent to the user's chosen shortening service. dupelimit: minimum time allowed for one person to say the same thing twice. Default 60s. Anything lower is considered a user or UI error. textlimit: default max size for texts in the site. Defaults to 140. 0 means no limit. Can be fine-tuned for notices, messages, profile bios and group descriptions.
This section is a reference to the configuration options for DB_DataObject (see http://ur1.ca/7xp). The ones that you may want to set are listed below for clarity.
database: a DSN (Data Source Name) for your StatusNet database. This is in the format 'protocol://username:password@hostname/databasename', where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you really know what you're doing), 'username' is the username, 'password' is the password, and etc. ini_yourdbname: if your database is not named 'statusnet', you'll need to set this to point to the location of the statusnet.ini file. Note that the real name of your database should go in there, not literally 'yourdbname'. db_driver: You can try changing this to 'MDB2' to use the other driver type for DB_DataObject, but note that it breaks the OpenID libraries, which only support PEAR::DB. debug: On a database error, you may get a message saying to set this value to 5 to see debug messages in the browser. This breaks just about all pages, and will also expose the username and password quote_identifiers: Set this to true if you're using postgresql. type: either 'mysql' or 'postgresql' (used for some bits of database-type-specific SQL in the code). Defaults to mysql. mirror: you can set this to an array of DSNs, like the above 'database' value. If it's set, certain read-only actions will use a random value out of this array for the database, rather than the one in 'database' (actually, 'database' is overwritten). You can offload a busy DB server by setting up MySQL replication and adding the slaves to this array. Note that if you want some requests to go to the 'database' (master) server, you'll need to include it in this array, too. utf8: whether to talk to the database in UTF-8 mode. This is the default with new installations, but older sites may want to turn it off until they get their databases fixed up. See "UTF-8 database" above for details. schemacheck: when to let plugins check the database schema to add tables or update them. Values can be 'runtime' (default) or 'script'. 'runtime' can be costly (plugins check the schema on every hit, adding potentially several db queries, some quite long), but not everyone knows how to run a script. If you can, set this to 'script' and run scripts/checkschema.php whenever you install or upgrade a plugin.
By default, StatusNet sites log error messages to the syslog facility. (You can override this using the 'logfile' parameter described above).
appname: The name that StatusNet uses to log messages. By default it's "statusnet", but if you have more than one installation on the server, you may want to change the name for each instance so you can track log messages more easily. priority: level to log at. Currently ignored. facility: what syslog facility to used. Defaults to LOG_USER, only reset if you know what syslog is and have a good reason to change it.
You can configure the software to queue time-consuming tasks, like sending out SMS email or XMPP messages, for off-line processing. See 'Queues and daemons' above for how to set this up.
enabled: Whether to uses queues. Defaults to false. subsystem: Which kind of queueserver to use. Values include "db" for our hacked-together database queuing (no other server required) and "stomp" for a stomp server. stomp_server: "broker URI" for stomp server. Something like "tcp://hostname:61613". More complicated ones are possible; see your stomp server's documentation for details. queue_basename: a root name to use for queues (stomp only). Typically something like '/queue/sitename/' makes sense. If running multiple instances on the same server, make sure that either this setting or $config['site']['nickname'] are unique for each site to keep them separate.
stomp_username: username for connecting to the stomp server; defaults to null. stomp_password: password for connecting to the stomp server; defaults to null.
stomp_persistent: keep items across queue server restart, if enabled. Under ActiveMQ, the server configuration determines if and how persistent storage is actually saved.
If using a message queue server other than ActiveMQ, you may
need to disable this if it does not support persistence.stomp_transactions: use transactions to aid in error detection. A broken transaction will be seen quickly, allowing a message to be redelivered immediately if a daemon crashes.
If using a message queue server other than ActiveMQ, you may
need to disable this if it does not support transactions.stomp_acks: send acknowledgements to aid in flow control. An acknowledgement of successful processing tells the server we're ready for more and can help keep things moving smoothly.
This should *not* be turned off when running with ActiveMQ, but
if using another message queue server that does not support
acknowledgements you might need to disable this.softlimit: an absolute or relative "soft memory limit"; daemons will restart themselves gracefully when they find they've hit this amount of memory usage. Defaults to 90% of PHP's global memory_limit setting.
inboxes: delivery of messages to receiver's inboxes can be delayed to queue time for best interactive performance on the sender. This may however be annoyingly slow when using the DB queues, so you can set this to false if it's causing trouble.
breakout: for stomp, individual queues are by default grouped up for best scalability. If some need to be run by separate daemons, etc they can be manually adjusted here.
Default will share all queues for all sites within each group.
Specify as <group>/<queue> or <group>/<queue>/<site>,
using nickname identifier as site.
'main/distrib' separate "distrib" queue covering all sites
'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'max_retries: for stomp, drop messages after N failed attempts to process. Defaults to 10.
dead_letter_dir: for stomp, optional directory to dump data on failed queue processing events after discarding them.
stomp_no_transactions: for stomp, the server does not support transactions, so do not try to user them. This is needed for http://www.morbidq.com/.
stomp_no_acks: for stomp, the server does not support acknowledgements. so do not try to user them. This is needed for http://www.morbidq.com/.
The default license to use for your users notices. The default is the Creative Commons Attribution 3.0 license, which is probably the right choice for any public site. Note that some other servers will not accept notices if you apply a stricter license than this.
type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved' (default copyright), or 'private' (for private and confidential information). owner: for 'allrightsreserved' or 'private', an assigned copyright holder (for example, an employer for a private site). If not specified, will be attributed to 'contributors'. url: URL of the license, used for links. title: Title for the license, like 'Creative Commons Attribution 3.0'. image: A button shown on each page for the license.
This is for configuring out-going email. We use PEAR's Mail module, see: http://pear.php.net/manual/en/package.mail.mail.factory.php
backend: the backend to use for mail, one of 'mail', 'sendmail', and 'smtp'. Defaults to PEAR's default, 'mail'. params: if the mail backend requires any parameters, you can provide them in an associative array.
This is for configuring nicknames in the service.
blacklist: an array of strings for usernames that may not be registered. A default array exists for strings that are used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme') but you may want to add others if you have other software installed in a subdirectory of StatusNet or if you just don't want certain words used as usernames. featured: an array of nicknames of 'featured' users of the site. Can be useful to draw attention to well-known users, or interesting people, or whatever.
For configuring avatar access.
dir: Directory to look for avatar files and to put them into. Defaults to avatar subdirectory of install directory; if you change it, make sure to change path, too. path: Path to avatars. Defaults to path for avatar subdirectory, but you can change it if you wish. Note that this will be included with the avatar server, too. server: If set, defines another server where avatars are stored in the root directory. Note that the 'avatar' subdir still has to be writeable. You'd typically use this to split HTTP requests on the client to speed up page loading, either with another virtual server or with an NFS or SAMBA share. Clients typically only make 2 connections to a single server at a time http://ur1.ca/6ih, so this can parallelize the job. Defaults to null. ssl: Whether to access avatars using HTTPS. Defaults to null, meaning to guess based on site-wide SSL settings.
For configuring the public stream.
localonly: If set to true, only messages posted by users of this service (rather than other services, filtered through OMB) are shown in the public stream. Default true. blacklist: An array of IDs of users to hide from the public stream. Useful if you have someone making excessive Twitterfeed posts to the site, other kinds of automated posts, testing bots, etc. autosource: Sources of notices that are from automatic posters, and thus should be kept off the public timeline. Default empty.
server: Like avatars, you can speed up page loading by pointing the theme file lookup to another server (virtual or real). Defaults to NULL, meaning to use the site server. dir: Directory where theme files are stored. Used to determine whether to show parts of a theme file. Defaults to the theme subdirectory of the install directory. path: Path part of theme URLs, before the theme name. Relative to the theme server. It may make sense to change this path when upgrading, (using version numbers as the path) to make sure that all files are reloaded by caching clients or proxies. Defaults to null, which means to use the site path + '/theme'. ssl: Whether to use SSL for theme elements. Default is null, which means guess based on site SSL settings. sslserver: SSL server to use when page is HTTPS-encrypted. If unspecified, site ssl server and so on will be used. sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
server: You can speed up page loading by pointing the theme file lookup to another server (virtual or real). Defaults to NULL, meaning to use the site server. path: Path part of Javascript URLs. Defaults to null, which means to use the site path + '/js/'. ssl: Whether to use SSL for JavaScript files. Default is null, which means guess based on site SSL settings. sslserver: SSL server to use when page is HTTPS-encrypted. If unspecified, site ssl server and