]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - README
Annihilate profile_tag_inbox.
[quix0rs-gnu-social.git] / README
diff --git a/README b/README
index 5731ab3433283aa38ef49f375e3fde4fd712ab0c..5f58179bfe4e7cc874ac7279de5eb356f44ccd18 100644 (file)
--- a/README
+++ b/README
@@ -220,14 +220,12 @@ and the URLs are listed here for your convenience.
   version may render your StatusNet site unable to send or receive XMPP
   messages.
 - Facebook library. Used for the Facebook application.
-- PEAR Services_oEmbed. Used for some multimedia integration.
-- PEAR HTTP_Request is an oEmbed dependency.
-- PEAR Validate is an oEmbed dependency.
-- PEAR Net_URL2 is an oEmbed dependency.
+- PEAR Validate is used for URL and email validation.
 - Console_GetOpt for parsing command-line options.
 - libomb. a library for implementing OpenMicroBlogging 0.1, the
   predecessor to OStatus.
 - HTTP_Request2, a library for making HTTP requests.
+- PEAR Net_URL2 is an HTTP_Request2 dependency.
 
 A design goal of StatusNet is that the basic Web functionality should
 work on even the most restrictive commercial hosting services.
@@ -739,6 +737,12 @@ 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.
 
+NOTE: the 1.0.0 version of StatusNet changed the URLs for all admin
+panels from /admin/* to /panel/*. This now allows the (popular)
+username 'admin', but blocks the considerably less popular username
+'panel'. If you have an existing user named 'panel', you should rename
+them before upgrading.
+
 Notice inboxes
 --------------
 
@@ -875,9 +879,7 @@ sslserver: use an alternate server name for SSL URLs, like
     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.
+shorturllength: ignored. See 'url' section below.
 dupelimit: minimum time allowed for one person to say the same thing
     twice. Default 60s. Anything lower is considered a user
     or UI error.
@@ -1278,6 +1280,12 @@ Profile management.
 
 biolimit: max character length of bio; 0 means no limit; null means to use
     the site text limit default.
+backup: whether users can backup their own profiles. Defaults to true.
+restore: whether users can restore their profiles from backup files. Defaults
+        to true.
+delete: whether users can delete their own accounts. Defaults to false.
+move: whether users can move their accounts to another server. Defaults
+      to true.  
 
 newuser
 -------
@@ -1385,12 +1393,22 @@ desclimit: maximum number of characters to allow in group descriptions.
     null (default) means to use the site-wide text limits. 0
     means no limit.
 
-oohembed
+oembed
 --------
 
-oEmbed endpoint for multimedia attachments (links in posts).
+oEmbed endpoint for multimedia attachments (links in posts). Will also
+work as 'oohembed' for backwards compatibility.
 
-endpoint: oohembed endpoint using http://oohembed.com/ software.
+endpoint: oohembed endpoint using http://oohembed.com/ software. Defaults to
+         'http://oohembed.com/oohembed/'.
+order: Array of methods to check for OEmbed data. Methods include 'built-in'
+       (use a built-in function to simulate oEmbed for some sites),
+       'well-known' (use well-known public oEmbed endpoints),
+       'discovery' (discover using <link> headers in HTML), 'service' (use
+       a third-party service, like oohembed or embed.ly. Default is
+       array('built-in', 'well-known', 'service', 'discovery'). Note that very
+       few sites implement oEmbed; 'discovery' is going to fail 99% of the
+       time.
 
 search
 ------
@@ -1464,6 +1482,8 @@ Configuration options specific to notices.
 contentlimit: max length of the plain-text content of a notice.
     Default is null, meaning to use the site-wide text limit.
     0 means no limit.
+defaultscope: default scope for notices. Defaults to 0; set to
+             1 to keep notices private to this site by default.
 
 message
 -------
@@ -1540,6 +1560,22 @@ external: external links in notices. One of three values: 'sometimes',
     nofollowed on profile, notice, and favorites page. Default is
     'sometimes'.
 
+url
+---
+
+Everybody loves URL shorteners. These are some options for fine-tuning
+how and when the server shortens URLs.
+
+shortener: URL shortening service to use by default. Users can override
+           individually. 'ur1.ca' by default.
+maxlength: If an URL is strictly longer than this limit, it will be
+           shortened. Note that the URL shortener service may return an
+           URL longer than this limit. Defaults to 25. Users can
+           override. If set to 0, all URLs will be shortened.
+maxnoticelength: If a notice is strictly longer than this limit, all
+           URLs in the notice will be shortened. Users can override.
+           -1 means the text limit for notices.
+
 router
 ------
 
@@ -1552,6 +1588,40 @@ cache: whether to cache the router in memcache (or another caching
     router cached) or others who see strange behavior. You're unlikely
     to need this unless you're a developer.
 
+http
+----
+
+Settings for the HTTP client.
+
+ssl_cafile: location of the CA file for SSL. If not set, won't verify
+           SSL peers. Default unset.
+curl: Use cURL <http://curl.haxx.se/> for doing HTTP calls. You must
+      have the PHP curl extension installed for this to work.
+proxy_host: Host to use for proxying HTTP requests. If unset, doesn't
+           do any HTTP proxy stuff. Default unset.
+proxy_port: Port to use to connect to HTTP proxy host. Default null.
+proxy_user: Username to use for authenticating to the HTTP proxy. Default null.
+proxy_password: Password to use for authenticating to the HTTP proxy. Default null.
+proxy_auth_scheme: Scheme to use for authenticating to the HTTP proxy. Default null.
+
+plugins
+-------
+
+default: associative array mapping plugin name to array of arguments. To disable
+        a default plugin, unset its value in this array.
+locale_path: path for finding plugin locale files. In the plugin's directory
+            by default.
+server: Server to find static files for a plugin when the page is plain old HTTP.
+       Defaults to site/server (same as pages). Use this to move plugin CSS and
+       JS files to a CDN.
+sslserver: Server to find static files for a plugin when the page is HTTPS. Defaults
+          to site/server (same as pages). Use this to move plugin CSS and JS files
+          to a CDN.
+path: Path to the plugin files. defaults to site/path + '/plugins/'. Expects that
+      each plugin will have a subdirectory at plugins/NameOfPlugin. Change this
+      if you're using a CDN.
+sslpath: Path to use on the SSL server. Same as plugins/path.
+
 Plugins
 =======