Merge branch '0.8.x' of git://gitorious.org/laconica/dev into dev/0.8.x

1 files changed, 91 insertions, 0 deletions

diff --git a/README b/README
index 4f9382960..9cbe84f0e 100644
--- a/README
+++ b/README
@@ -694,6 +694,13 @@ to users on a remote site. (Or not... it's not well tested.) The
 Upgrading
 =========
 
+IMPORTANT NOTE: Laconica 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 Laconica 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
@@ -783,6 +790,29 @@ problem.
 3. When fixup_inboxes is finished, you can set the enabled flag to
    'true'.
 
+UTF-8 Database
+--------------
+
+Laconica 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.
+
+0. You can disable the new behaviour by setting the 'db''utf8' config
+   option to "false". You should only do this until you're ready to
+   convert your DB to the new format.
+1. When you're ready to convert, you can run the fixup_utf8.php script
+   in the scripts/ subdirectory. If you've had the "new behaviour"
+   enabled (probably a good idea), you can give the ID of the first
+   "new" notice as a parameter, and only notices before that one will
+   be converted. Notices are converted in reverse chronological order,
+   so the most recent (and visible) ones will be converted first. The
+   script should work whether or not you have the 'db''utf8' config
+   option enabled.
+2. When you're ready, set $config['db']['utf8'] to true, so that
+   new notices will be stored correctly.
+
 Configuration options
 =====================
 
@@ -910,6 +940,10 @@ mirror: you can set this to an array of DSNs, like the above
 	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.
 
 syslog
 ------
@@ -1136,6 +1170,63 @@ welcome: nickname of a user account that sends welcome messages to new
 If either of these special user accounts are specified, the users should
 be created before the configuration is updated.
 
+snapshot
+--------
+
+The software will, by default, send statistical snapshots about the
+local installation to a stats server on the laconi.ca Web site. This
+data is used by the developers to prioritize development decisions. No
+identifying data about users or organizations is collected. The data
+is available to the public for review. Participating in this survey
+helps Laconica developers take your needs into account when updating
+the software.
+
+run: string indicating when to run the statistics. Values can be 'web'
+     (run occasionally at Web time), 'cron' (run from a cron script),
+     or 'never' (don't ever run). If you set it to 'cron', remember to
+     schedule the script to run on a regular basis.
+frequency: if run value is 'web', how often to report statistics.
+           Measured in Web hits; depends on how active your site is.
+           Default is 10000 -- that is, one report every 10000 Web hits,
+           on average.
+reporturl: URL to post statistics to. Defaults to Laconica developers'
+           report system, but if they go evil or disappear you may
+           need to update this to another value. Note: if you
+           don't want to report stats, it's much better to
+           set 'run' to 'never' than to set this value to something
+           nonsensical.
+
+
+attachments
+-----------
+
+The software lets users upload files with their notices. You can configure
+the types of accepted files by mime types and a trio of quota options:
+per file, per user (total), per user per month.
+
+We suggest the use of the pecl file_info extension to handle mime type
+detection.
+
+supported: an array of mime types you accept to store and distribute,
+           like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
+           setup your server to properly reckognize the types you want to
+           support.
+
+For quotas, be sure you've set the upload_max_filesize and post_max_size
+in php.ini to be large enough to handle your upload. In httpd.conf
+(if you're using apache), check that the LimitRequestBody directive isn't
+set too low (it's optional, so it may not be there at all).
+
+file_quota: maximum size for a single file upload in bytes. A user can send
+            any amount of notices with attachments as long as each attachment
+            is smaller than file_quota.
+user_quota: total size in bytes a user can store on this server. Each user
+            can store any number of files as long as their total size does
+            not exceed the user_quota.
+monthly_quota: total size permitted in the current month. This is the total
+            size in bytes that a user can upload each month.
+
+
 Troubleshooting
 ===============