Merge commit 'jeff-themovie/invite-enabled' into 0.8.x

[quix0rs-gnu-social.git] / README

diff --git a/README b/README
index cd663d931b97f4bc6653f71adf78de418894c427..e02fa02d31bc42e21ab9296f701df4c29cce8b43 100644 (file)
--- a/README
+++ b/README
@@ -180,6 +180,7 @@ and the URLs are listed here for your convenience.
 - PEAR HTTP_Request is an oEmbed dependency.
 - PEAR Validate is an oEmbed dependency.
 - PEAR Net_URL2 is an oEmbed dependency.
 - PEAR HTTP_Request is an oEmbed dependency.
 - PEAR Validate is an oEmbed dependency.
 - PEAR Net_URL2 is an oEmbed dependency.

+- Console_GetOpt for parsing command-line options.

 
 A design goal of Laconica is that the basic Web functionality should
 work on even the most restrictive commercial hosting services.
 
 A design goal of Laconica is that the basic Web functionality should
 work on even the most restrictive commercial hosting services.


@@ -1080,6 +1081,13 @@ debug: if turned on, this will make the XMPP library blurt out all of
 public: an array of JIDs to send _all_ notices to. This is useful for
        participating in third-party search and archiving services.
 
 public: an array of JIDs to send _all_ notices to. This is useful for
        participating in third-party search and archiving services.
 

+invite
+------
+
+For configuring invites.
+
+enabled: Whether to allow users to send invites. Default true.
+

 tag
 ---
 
 tag
 ---
 


@@ -1231,6 +1239,10 @@ supported: an array of mime types you accept to store and distribute,
            setup your server to properly reckognize the types you want to
            support.
 uploads:   false to disable uploading files with notices (true by default).
            setup your server to properly reckognize the types you want to
            support.
 uploads:   false to disable uploading files with notices (true by default).

+filecommand: The required MIME_Type library may need to use the 'file'
+            command. It tries the one in the Web server's path, but if
+            you're having problems with uploads, try setting this to the
+            correct value. Note: 'file' must accept '-b' and '-i' options.

 
 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
 
 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


@@ -1273,6 +1285,18 @@ type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
       systems. We'll probably add another type sometime in the future,
       with our own indexing system (maybe like MediaWiki's).
 
       systems. We'll probably add another type sometime in the future,
       with our own indexing system (maybe like MediaWiki's).
 

+sessions
+--------
+
+Session handling.
+
+handle: boolean. Whether we should register our own PHP session-handling
+       code (using the database and memcache if enabled). Defaults to false.
+       Setting this to true makes some sense on large or multi-server
+       sites, but it probably won't hurt for smaller ones, either.
+debug: whether to output debugging info for session storage. Can help
+       with weird session bugs, sometimes. Default false.
+

 Troubleshooting
 ===============
 
 Troubleshooting
 ===============