First cut at some JSON Activity Streams output

[quix0rs-gnu-social.git] / README

diff --git a/README b/README
index 6343e3e02465c778611b16261b18c7d377d4c71b..c27182395c2d11adedccf76e86ac4e05fbf9db57 100644 (file)
--- a/README
+++ b/README
@@ -1276,6 +1276,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
 -------
@@ -1538,6 +1544,52 @@ external: external links in notices. One of three values: 'sometimes',
     nofollowed on profile, notice, and favorites page. Default is
     'sometimes'.
 
+router
+------
+
+We use a router class for mapping URLs to code. This section controls
+how that router works.
+
+cache: whether to cache the router in memcache (or another caching
+    mechanism). Defaults to true, but may be set to false for
+    developers (who might be actively adding pages, so won't want the
+    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
 =======