X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=README;h=ccdd9e674e7ddfd7966fe4f0c404b17aeedd38c0;hb=b2664e1ae2e2cf66585cdd8696d88efdd053eb3b;hp=0bf1319c6d4d4b1b0c0345b3f5168d566323ef2a;hpb=e70a79d6ab5e9cd8894490d4fc0d3b855e807edc;p=quix0rs-gnu-social.git diff --git a/README b/README index 0bf1319c6d..ccdd9e674e 100644 --- a/README +++ b/README @@ -553,25 +553,53 @@ our kind of hacky home-grown DB-based queue solution. See the "queues" config section below for how to configure to use STOMP. As of this writing, the software has been tested with ActiveMQ ( -Twitter Friends Syncing ------------------------ +Twitter Bridge +-------------- + +* OAuth + +As of 0.8.1, OAuth is used to to access protected resources on Twitter +instead of HTTP Basic Auth. To use Twitter bridging you will need +to register your instance of Laconica as an application on Twitter +(http://twitter.com/apps), and update the following variables in your +config.php with the consumer key and secret Twitter generates for you: + + $config['twitter']['consumer_key'] = 'YOURKEY'; + $config['twitter']['consumer_secret'] = 'YOURSECRET'; + +When registering your application with Twitter set the type to "Browser" +and your Callback URL to: + + http://example.org/mublog/twitter/authorization + +The default access type should be, "Read & Write". + +* Importing statuses from Twitter + +To allow your users to import their friends' Twitter statuses, you will +need to enable the bidirectional Twitter bridge in config.php: + + $config['twitterbridge']['enabled'] = true; -As of Laconica 0.6.3, users may set a flag in their settings ("Subscribe -to my Twitter friends here" under the Twitter tab) to have Laconica -attempt to locate and subscribe to "friends" (people they "follow") on -Twitter who also have accounts on your Laconica system, and who have -previously set up a link for automatically posting notices to Twitter. +and run the TwitterStatusFetcher daemon (scripts/twitterstatusfetcher.php). +Additionally, you will want to set the integration source variable, +which will keep notices posted to Twitter via Laconica from looping +back. The integration source should be set to the name of your +application, exactly as you specified it on the settings page for your +Laconica application on Twitter, e.g.: -Optionally, there is a script (./scripts/synctwitterfriends.php), meant -to be run periodically from a job scheduler (e.g.: cron under Unix), to -look for new additions to users' friends lists. Note that the friends -syncing only subscribes users to each other, it does not unsubscribe -users when they stop following each other on Twitter. + $config['integration']['source'] = 'YourApp'; -Sample cron job: +* Twitter Friends Syncing -# Update Twitter friends subscriptions every half hour -0,30 * * * * /path/to/php /path/to/laconica/scripts/synctwitterfriends.php>&/dev/null +Users may set a flag in their settings ("Subscribe to my Twitter friends +here" under the Twitter tab) to have Laconica attempt to locate and +subscribe to "friends" (people they "follow") on Twitter who also have +accounts on your Laconica system, and who have previously set up a link +for automatically posting notices to Twitter. + +As of 0.8.0, this is no longer accomplished via a cron job. Instead you +must run the SyncTwitterFriends daemon (scripts/synctwitterfreinds.php). Built-in Facebook Application ----------------------------- @@ -940,6 +968,8 @@ closed: If set to 'true', will disallow registration on your site. the service, *then* set this variable to 'true'. inviteonly: If set to 'true', will only allow registration if the user was invited by an existing user. +openidonly: If set to 'true', will only allow registrations and logins + through OpenID. private: If set to 'true', anonymous users will be redirected to the 'login' page. Also, API methods that normally require no authentication will require it. Note that this does not turn @@ -964,12 +994,12 @@ sslserver: use an alternate server name for SSL URLs, like shorturllength: Length of URL at which URLs in a message exceeding 140 characters will be sent to the user's chosen shortening service. -design: a default design (colors and background) for the site. - Sub-items are: backgroundcolor, contentcolor, sidebarcolor, - textcolor, linkcolor, backgroundimage, disposition. dupelimit: minimum time allowed for one person to say the same thing twice. Default 60s. Anything lower is considered a user or UI error. +textlimit: default max size for texts in the site. Defaults to 140. + 0 means no limit. Can be fine-tuned for notices, messages, + profile bios and group descriptions. db -- @@ -1170,6 +1200,14 @@ For configuring invites. enabled: Whether to allow users to send invites. Default true. +openid +------ + +For configuring OpenID. + +enabled: Whether to allow users to register and login using OpenID. Default + true. + tag --- @@ -1231,6 +1269,30 @@ enabled: Set to true to enable. Default false. server: a string with the hostname of the sphinx server. port: an integer with the port number of the sphinx server. +emailpost +--------- + +For post-by-email. + +enabled: Whether to enable post-by-email. Defaults to true. You will + also need to set up maildaemon.php. + +sms +--- + +For SMS integration. + +enabled: Whether to enable SMS integration. Defaults to true. Queues + should also be enabled. + +twitter +------- + +For Twitter integration + +enabled: Whether to enable Twitter integration. Defaults to true. + Queues should also be enabled. + integration ----------- @@ -1272,6 +1334,8 @@ banned: an array of usernames and/or profile IDs of 'banned' profiles. The site will reject any notices by these users -- they will not be accepted at all. (Compare with blacklisted users above, whose posts just won't show up in the public stream.) +biolimit: max character length of bio; 0 means no limit; null means to use + the site text limit default. newuser ------- @@ -1368,6 +1432,9 @@ Options for group functionality. maxaliases: maximum number of aliases a group can have. Default 3. Set to 0 or less to prevent aliases in a group. +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 -------- @@ -1432,6 +1499,38 @@ notify third-party servers of updates. notify: an array of URLs for ping endpoints. Default is the empty array (no notification). +design +------ + +Default design (colors and background) for the site. Actual appearance +depends on the theme. Null values mean to use the theme defaults. + +backgroundcolor: Hex color of the site background. +contentcolor: Hex color of the content area background. +sidebarcolor: Hex color of the sidebar background. +textcolor: Hex color of all non-link text. +linkcolor: Hex color of all links. +backgroundimage: Image to use for the background. +disposition: Flags for whether or not to tile the background image. + +notice +------ + +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. + +message +------- + +Configuration options specific to messages. + +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. + Plugins =======