README
------
-Laconica 0.6.3 ("Gardening at Night")
-24 November 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 and security improvement version from version
-0.6.2 (release 13 Nov 2008). Notable features of version 0.6.3 include:
-
-- 'nudge' functionality to tell a user that they're missed.
-- Links to related RSS/Atom feeds on all pages.
-- Favor/disfavor icons changed to images.
-- Better checks to prevent remote subscribing to a local user, causing
- "ghost profiles" (dupes in people search or subscriptions lists).
-- Twitter friend sync. Users who set up their Twitter accounts will
- be automatically connected to other local users who have Twitter
- accounts and who they're subscribed to on Twitter.
-- List view of subscriptions/subscribers.
-- Subscribe/unsubscribe button on subscriptions/subscribers list.
-- Optionally hide certain users from the public stream.
-- Give public area a few more tabs.
-- Add Featured users tab to public area.
-- Add Most favorited notices tab to public area.
-- Users can give themselves tags.
-- Users can tag their subscribers or subscriptions.
-- Users can send @-replies to tagged subsets of their contact list
- using @#tag.
-- Subscribe/unsubscribe with Ajax form.
-- Post notice with Ajax form.
-- Script to optionally add notice inboxes for only some users.
-- Incremental caching of notice streams using memcached.
-- Use cached favorites info to avoid excess DB hits for faves.
-- Optionally use Sphinx Search for notice search.
-- Optionally use Sphinx Search for people search.
-- FOAF URL link on profile page.
-- HTML correction for repeated @id attributes in favorites forms.
+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
=============
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.2.tar.gz
+ tar zxf laconica-0.7.0.tar.gz
- ...which will make a laconica-0.6.2 subdirectory in your current
+ ...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.2 /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
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.
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
-----------
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.2. 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
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:
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.
+ 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
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.6.2 without reading the "Notice inboxes"
+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.
================
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
+ git clone http://laconi.ca/software/laconica.git
-To keep it up-to-date, use 'darcs pull'. Watch for conflicts!
+To keep it up-to-date, use 'git pull'. Watch for conflicts!
Further information
===================
* Erik Stambaugh
* 'drry'
* Gina Haeussge
-* Ken Sheppardson (Trac server, man-about-town)
-* Tiago 'gouki' Faria (entrans)
* Tryggvi Björgvinsson
+* Adrian Lang
+* Ori Avtalion
+* Meitar Moscovitz
+* Ken Sheppardson (Trac server, man-about-town)
+* Tiago 'gouki' Faria (i18n managerx)
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,
projects / quix0rs-gnu-social.git / blobdiff