README
------
-Laconica 0.6.1
-6 October 2008
+Laconica 0.7.0 ("Rockville")
+30 January 2009
This is the README file for Laconica, the Open Source microblogging
platform. It includes installation instructions, descriptions of
group to exchange short (140 character) 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, Jaiku, Pownce and Plurk.
+like Twitter, Jaiku and Plurk.
With a little work, status messages can be sent to mobile phones,
instant messenger programs (GTalk/Jabber), and specially-designed
New this version
================
-This is a minor feature improvement version from version 0.6.0
-(release 22 Sep 2008). Notable features of version 0.6.1 include:
-
-- Direct messages (DMs) and Favorites (faves) are now available
- through the Twitter-like API.
-- All of the Twitter commands (see http://ur1.ca/7ru) are available
- through SMS, IM, Web and API, although some are not functional (for
- features Laconica does not yet support)
-- 20 additional languages supported at various levels (some pretty
- basic).
-- Significant additional caching using memcached for most database
- queries. Using memcached can significantly speed up a Laconica
- instance with this version.
-- All required external libraries are now available in extlib/
- subdirectory.
-- Many bug fixes.
-- Continued but poorly-documented experimental support for Postgresql.
-
-NOTE: the database definition file, stoica.ini, has been renamed to
-laconica.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.
+This is a major feature release, and includes some bug fixes from the
+previous version (0.6.4, released December 14 2008.)
+
+- Support for groups. Users can join groups and send themed notices
+ to those groups. All other members of the group receive the notices.
+- Laconica-specific extensions to the Twitter API.
+- A Facebook application.
+- A massive UI redesign. The HTML generated by Laconica has changed
+ significantly, to make theming easier and to give a more open look
+ by default. Also, sidebar.
+- Massive code hygiene changes to move towards compliance with the PEAR
+ coding standards and to support the new UI redesign.
+- Began the breakup of util.php -- moved about 30% of code to a views
+ hierarchy.
+- UI elements for statistical information (like top posters or most
+ popular groups) added in a sidebar.
+- include Javascript badge by Kent Brewster.
+- Updated online documentation.
+- Cropping of user avatars using Jcrop.
+- fix for Twitter bridge to not send "Expect:" headers.
+- add 'dm' as a synonym for 'd' in commands.
+- Upgrade upstream version of jQuery to 1.3.
+- Upgrade upstream version of PHP-OpenID to 2.1.2.
+- Move OpenMicroBlogging specification to its own repository.
+- Make tag-based RSS streams work.
+- Additional locales: Bulgarian, Catalan, Greek, Hebrew, simplified
+ Chinese, Telugu, Taiwanese Chinese, Vietnamese,
+- PostgreSQL updates.
+- Nasty bug in Twitter bridge that wouldn't verify with Twitter
Prerequisites
=============
*must* support the MyISAM storage engine -- the default for most
MySQL servers -- *and* the InnoDB storage engine.
- A Web server. Preferably, you should have Apache 2.2.x with the
- mod_rewrite extension installed and enabled.
+ mod_rewrite extension installed and enabled.
Your PHP installation must include the following PHP extensions:
- MySQL. For accessing the database.
- GD. For scaling down avatar images.
- mbstring. For handling Unicode (UTF-8) encoded strings.
+- gettext. For multiple languages. Default on many PHP installs.
For some functionality, you will also need the following extensions:
server to store the data in.
- Mailparse. Efficient parsing of email requires this extension.
Submission by email or SMS-over-email uses this extension.
-
+- Sphinx Search. A client for the sphinx server, an alternative
+ to MySQL or Postgresql fulltext search. You will also need a
+ Sphinx server to serve the search queries.
+
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
but won't work with OpenID.
http://pear.php.net/package/DB
- OAuth.php from http://oauth.googlecode.com/svn/code/php/
-- markdown.php from http://michelf.com/projects/php-markdown/
+- markdown.php from http://michelf.com/projects/php-markdown/
- PEAR Mail, for sending out mail notifications
http://pear.php.net/package/Mail
- PEAR Net_SMTP, if you use the SMTP factory for notifications
http://pear.php.net/package/Net_SMTP
+- PEAR Net_Socket, if you use the SMTP factory for notifications
+ http://pear.php.net/package/Net_Socket
- XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
library available for PHP. http://xmpphp.googlecode.com/. Note that
as of this writing the version of this library that is available in
version (patches have been submitted). Upgrading to the upstream
version may render your Laconica site unable to send or receive XMPP
messages.
+- Facebook library. Used for the Facebook application.
A design goal of Laconica is that the basic Web functionality should
work on even the most restrictive commercial hosting services.
1. Unpack the tarball you downloaded on your Web server. Usually a
command like this will work:
-
- tar zxf laconica-0.6.0.tar.gz
-
- ...which will make a laconica-0.6.0 subdirectory in your current
+
+ tar zxf laconica-0.7.0.tar.gz
+
+ ...which will make a laconica-0.7.0 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.)
-
+
2. Move the tarball to a directory of your choosing in your Web root
directory. Usually something like this will work:
-
- mv laconica-0.6.0 /var/www/mublog
-
+
+ mv laconica-0.7.0 /var/www/mublog
+
This will make your Laconica instance available in the mublog path of
your server, like "http://example.net/mublog". "microblog" or
"laconica" 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.
-
+
3. You should also take this moment to make your avatar subdirectory
writeable by the Web server. An insecure way to do this is:
-
+
chmod a+w /var/www/mublog/avatar
-
+
On some systems, this will probably work:
-
+
chgrp www-data /var/www/mublog/avatar
chmod g+w /var/www/mublog/avatar
4. Create a database to hold your microblog data. Something like this
should work:
-
+
mysqladmin -u "username" --password="password" create laconica
-
+
Note that Laconica 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.)
You may want to test by logging into the database and checking that
the tables were created. Here's an example:
-
+
SHOW TABLES;
-
+
6. Create a new database account that Laconica will use to access the
database. If you have shell access, this will probably work from the
MySQL shell:
-
+
GRANT SELECT,INSERT,DELETE,UPDATE on laconica.*
TO 'lacuser'@'localhost'
IDENTIFIED BY 'lacpassword';
-
+
You should change 'lacuser' and 'lacpassword' to your preferred new
username and password. You may want to test logging in as this new
user and testing that you can SELECT from some of the tables in the
DB (use SHOW TABLES to see which ones are there).
-
+
7. Copy the config.php.sample in the Laconica directory to config.php.
8. Edit config.php to set the basic configuration for your system.
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.
-
+ "fancy URLs" (see below), since some URLs are stored in the database.
+
Fancy URLs
----------
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.
-
+
2. Change the "RewriteBase" in the new .htaccess file to be the URL path
to your Laconica installation on your server. Typically this will
be the path to your Laconica directory relative to your Web root.
3. 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:
earlier than 2.2.x, try changing the regular expressions in the
htaccess.sample file that use "\w" to just use ".".
+Sphinx
+------
+
+To use a Sphinx server to search users and notices, 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.
+"pecl install sphinx" should take care of that. Add "extension=sphinx.so"
+to your php.ini and reload apache to enable it.
+
+You can update your MySQL or Postgresql databases to drop their fulltext
+search indexes, since they're now provided by sphinx.
+
+On the sphinx server side, a script reads the main database and build
+the keyword index. A cron job reads the database and keeps the sphinx
+indexes up to date. scripts/sphinx-cron.sh should be called by cron
+every 5 minutes, for example. scripts/sphinx.sh is an init.d script
+to start and stop the sphinx search daemon.
+
SMS
---
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 message and stored in the DB.
+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.
2. Make sure the maildaemon.php file is executable:
- chmod +x scripts/maildaemon.php
-
+ chmod +x scripts/maildaemon.php
+
Note that "daemon" is kind of a misnomer here; the script is more
of a filter than a daemon.
-
+
2. Edit /etc/aliases on your mail server and add the following line:
*: /path/to/laconica/scripts/maildaemon.php
3. 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.
4. 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 Laconica, a working
1. 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.
-
+
2. You must register a Jabber ID (JID) with your new server. It helps
to choose a name like "update@example.com" or "notice" or something
similar. Alternately, your "update JID" can be registered on a
publicly-available XMPP service, like jabber.org or GTalk.
-
+
Laconica 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.
-
+
3. 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
their "JID" (Jabber ID) to your config.php as follows:
$config['xmpp']['public'][] = 'downstream@example.net';
-
+
(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
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.
-
+
4. On the queues server, run the command scripts/startdaemons.sh. It
needs as a parameter the install path; if you run it from the
Laconica dir, "." should suffice.
-
+
This will run six (for now) queue handlers:
* xmppdaemon.php - listens for new XMPP messages from users and stores
default. This can be useful for starting, stopping, and monitoring the
daemons.
+Twitter Friends Syncing
+-----------------------
+
+As of Laconica 0.6.3, users may set a flag in their settings ("Subscribe
+to my Twitter friends here" under the Twitter tab) to have Laconica
+attempt to locate and subscribe to "friends" (people they "follow") on
+Twitter who also have accounts on your Laconica system, and who have
+previously set up a link for automatically posting notices to Twitter.
+
+Optionally, there is a script (./scripts/synctwitterfriends.php), meant
+to be run periodically from a job scheduler (e.g.: cron under Unix), to
+look for new additions to users' friends lists. Note that the friends
+syncing only subscribes users to each other, it does not unsubscribe
+users when they stop following each other on Twitter.
+
+Sample cron job:
+
+# Update Twitter friends subscriptions every half hour
+0,30 * * * * /path/to/php /path/to/laconica/scripts/synctwitterfriends.php>&/dev/null
+
Sitemaps
--------
bots where to find all the sitemap files; it *must* be in the main
installation directory or higher. Both types of file must be
available through HTTP.
-
+
2. To generate your sitemaps, run the following command on your server:
php scripts/sitemap.php -f index-file-path -d sitemap-directory -u URL-prefix-for-sitemaps
you want the sitemaps stored, like './sitemaps/' (make sure the dir
exists). URL-prefix-for-sitemaps is the full URL for the sitemap dir,
typically something like 'http://example.net/mublog/sitemaps/'.
-
+
You can use several methods for submitting your sitemap index to
search engines to get your site indexed. One is to add a line like the
following to your robots.txt file:
You may want to start by copying the files from the default theme to
your own directory.
+NOTE: the HTML generated by Laconica changed *radically* between
+version 0.6.x and 0.7.x. Older themes will need signification
+modification to use the new output format.
+
Translation
-----------
Backups
-------
-There is no builtin system for doing backups in Laconica. You can make
+There is no built-in system for doing backups in Laconica. You can make
backups of a working Laconica 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.
+Private
+-------
+
+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.
+
+Note that this is an experimental feature; 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.
+Finally, the interaction of private sites with OpenMicroBlogging is
+undefined. Remote users won't be able to subscribe to users on a
+private site, but users of the private site may be able to subscribe
+to users on a remote site. (Or not... it's not well tested.) The
+"proper behaviour" hasn't been defined here, so handle with care.
+
Upgrading
=========
If you've been using Laconica 0.6, 0.5 or lower, or if you've been
-tracking the "darcs" version of the software, you will probably want
+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 Laconica 0.6.1. Try these step-by-step instructions; read
+procedure in Laconica 0.7.0. Try these step-by-step instructions; read
to the end first before trying them.
0. Download Laconica and set up all the prerequisites as if you were
RewriteBase to use the correct path.
10. Rebuild the database. Go to your Laconica directory and run the
rebuilddb.sh script like this:
-
+
./scripts/rebuilddb.sh rootuser rootpassword database db/laconica.sql
-
+
Here, 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 Laconica runs as.
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.
+precooked data in the DB. All upgraders should check out the inboxes
+options below.
NOTE: the database definition file, stoica.ini, has been renamed to
laconica.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
+--------------
+
+Before version 0.6.2, the page showing all notices from people the
+user is subscribed to ("so-and-so with friends") was calculated at run
+time. Starting with 0.6.2, we have a new data structure for holding a
+user's "notice inbox". (Note: distinct from the "message inbox", which
+is the "inbox" tab in the UI. The notice inbox appears under the
+"Personal" tab.)
+
+Notices are added to the inbox when they're created. This speeds up
+the query considerably, and also allows us the opportunity, in the
+future, to add different kind of notices to an inbox -- like @-replies
+or subscriptions to search terms or hashtags.
+
+Notice inboxes are enabled by default for new installations. If you
+are upgrading an existing site, this means that your users will see
+empty "Personal" pages. The following steps will help you fix the
+problem.
+
+0. $config['inboxes']['enabled'] can be set to one of three values. If
+ you set it to 'false', the site will work as before. Support for this
+ will probably be dropped in future versions.
+1. Setting the flag to 'transitional' means that you're in transition.
+ In this mode, the code will run the "new query" or the "old query"
+ based on whether the user's inbox has been updated.
+2. After setting the flag to "transitional", you can run the
+ fixup_inboxes.php script to create the inboxes. You may want to set
+ the memory limit high. You can re-run it without ill effect.
+3. When fixup_inboxes is finished, you can set the enabled flag to
+ 'true'.
+
Configuration options
=====================
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.7.1, you can put config files in the
+/etc/laconica/ directory on your server, if it exists. Config files
+will be included in this order:
+
+* /etc/laconica/laconica.php - server-wide config
+* /etc/laconica/<servername>.php - for a virtual host
+* /etc/laconica/<servername>_<pathname>.php - for a path
+* INSTALLDIR/config.php - for a particular implementation
+
Almost all configuration options are made through a two-dimensional
associative array, cleverly named $config. A typical configuration
line will be:
(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 Laconica to save logging
+logfile: full path to a file for Laconica to save logging
information to. You may want to use this if you don't have
access to syslog.
locale_path: full path to the directory for locale data. Unless you
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.
db
--
database: a DSN (Data Source Name) for your Laconica database. This is
in the format 'protocol://username:password@hostname/databasename',
- where 'protocol' is 'mysql' (or possibly 'postgresql', if you
+ 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 'laconica', you'll need
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
+ 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.
'smtp'. Defaults to PEAR's default, 'mail'.
params: if the mail backend requires any parameters, you can provide
them in an associative array.
-
+
nickname
--------
but you may want to add others if you have other software
installed in a subdirectory of Laconica 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.
avatar
------
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.
theme
-----
dropoff: Decay factor for tag listing, in seconds.
Defaults to exponential decay over ten days; you can twiddle
with it to try and get better results for your site.
-
+
daemon
------
server: a string with the hostname of the memcached server. Can also
be an array of hostnames, if you've got more than one server.
+sphinx
+------
+
+You can get a significant boost in performance using Sphinx Search
+instead of your database server to search for users and notices.
+(http://sphinxsearch.com/).
+
+enabled: Set to true to enable. Default false.
+server: a string with the hostname of the sphinx server.
+port: an integer with the port number of the sphinx server.
+
integration
-----------
that here instead. Status updates on Twitter will then have
links to your site.
+inboxes
+-------
+
+For notice inboxes.
+
+enabled: A three-valued flag for whether to use notice inboxes (see
+ upgrading info above for notes about this change). Can be
+ 'false', 'true', or '"transitional"'.
+
+throttle
+--------
+
+For notice-posting throttles.
+
+enabled: Whether to throttle posting. Defaults to false.
+count: Each user can make this many posts in 'timespan' seconds. So, if count
+ is 100 and timespan is 3600, then there can be only 100 posts
+ from a user every hour.
+timespan: see 'count'.
+
+profile
+-------
+
+Profile management.
+
+banned: an array of usernames and/or profile IDs of 'banned' profiles.
+ The site will reject any notices by these users -- they will
+ not be accepted at all. (Compare with blacklisted users above,
+ whose posts just won't show up in the public stream.)
+
Troubleshooting
===============
separate logfile. This is probably the first place to look if you're
getting weird behaviour from Laconica.
-If you're tracking the unstable version of Laconica in the darcs
+If you're tracking the unstable version of Laconica in the git
repository (see below), and you get a compilation error ("unexpected
T_STRING") in the browser, check to see that you don't have any
conflicts in your code.
+If you upgraded to Laconica 0.7.0 without reading the "Notice inboxes"
+section above, and all your users' 'Personal' tabs are empty, read the
+"Notice inboxes" section above.
+
Myths
=====
emit oodles of print lines directly to the browser of your users.
Among these lines will be your database username and password. Do
not enable this option on a production Web site for any reason.
-
+
- "Edit dataobject.ini with the following settings..." dataobject.ini
is a development file for the DB_DataObject framework and is not
used by the running software. It was removed from the Laconica
================
If you're adventurous or impatient, you may want to install the
-development version of Laconica. To get it, use the darcs version
-control tool (http://darcs.net/) like so:
+development version of Laconica. To get it, use the git version
+control tool (http://git-scm.com/) like so:
- darcs get http://laconi.ca/darcs/ mublog
-
-To keep it up-to-date, use 'darcs pull'. Watch for conflicts!
+ git clone http://laconi.ca/software/laconica.git
+
+To keep it up-to-date, use 'git pull'. Watch for conflicts!
Further information
===================
* Zach Copley, Control Yourself, Inc.
* Earle Martin, Control Yourself, Inc.
* Marie-Claude Doyon, designer, Control Yourself, Inc.
+* Sarven Capadisli, Control Yourself, Inc.
+* Robin Millette, Control Yourself, Inc.
* Ciaran Gultnieks
* Michael Landers
* Ori Avtalion
* Erik Stambaugh
* 'drry'
* Gina Haeussge
+* Tryggvi Björgvinsson
+* Adrian Lang
+* Ori Avtalion
+* Meitar Moscovitz
* Ken Sheppardson (Trac server, man-about-town)
-* Tiago 'gouki' Faria (entrans)
+* Tiago 'gouki' Faria (i18n managerx)
-Thanks also to the thousands of people who have tried out Identi.ca,
-installed Laconi.ca, told their friends, and built the Open
-Microblogging network to what it is today.
+Thanks also to the developers of our upstream library code and to the
+thousands of people who have tried out Identi.ca, installed Laconi.ca,
+told their friends, and built the Open Microblogging network to what
+it is today.
projects / quix0rs-gnu-social.git / blobdiff