]> git.mxchange.org Git - quix0rs-gnu-social.git/commitdiff
document logincommand/disabled in README
authorEvan Prodromou <evan@status.net>
Mon, 14 Dec 2009 23:09:45 +0000 (18:09 -0500)
committerEvan Prodromou <evan@status.net>
Mon, 14 Dec 2009 23:09:45 +0000 (18:09 -0500)
README

diff --git a/README b/README
index 51a8e91cc5e9542d0e72a2b0032f1b6771d10284..3e712af8c0a522456ed30297b88da811279ffb95 100644 (file)
--- a/README
+++ b/README
@@ -1407,6 +1407,21 @@ contentlimit: max length of the plain-text content of a message.
               Default is null, meaning to use the site-wide text limit.
               0 means no limit.
 
+logincommand
+------------
+
+Configuration options for the login command.
+
+disabled: whether to enable this command. If enabled, users who send
+         the text 'login' to the site through any channel will
+         receive a link to login to the site automatically in return.
+         Possibly useful for users who primarily use an XMPP or SMS
+         interface and can't be bothered to remember their site
+         password. Note that the security implications of this are
+         pretty serious and have not been thoroughly tested. You
+         should enable it only after you've convinced yourself that
+         it is safe. Default is 'false'.
+
 Plugins
 =======