Qvitter/README.md

95 lines
4.4 KiB
Markdown
Raw Normal View History

2013-08-19 22:30:57 +09:00
Qvitter
==========================================
* Author: Hannes Mannerheim (<h@nnesmannerhe.im>)
2015-10-27 01:56:12 +09:00
* Last mod.: Oct, 2015
* Version: 5-alpha
2016-01-18 09:26:59 +09:00
* Homepage: <https://git.gnu.io/h2p/Qvitter>
2013-08-19 22:30:57 +09:00
Qvitter is free software: you can redistribute it and / or modify it
under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version three of the License or (at
2015-07-07 02:28:54 +09:00
your option) any later version.
2013-08-19 22:30:57 +09:00
Qvitter is distributed in hope that it will be useful but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILTY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
2015-07-07 02:28:54 +09:00
more details.
2013-08-19 22:30:57 +09:00
You should have received a copy of the GNU Affero General Public License
2015-07-07 02:28:54 +09:00
along with Qvitter. If not, see <http://www.gnu.org/licenses/>.
2013-08-19 22:30:57 +09:00
Setup
-----
1. Install GNU social _directly under a domain_ (Qvitter is not compatible with
subdirectory installs) with _fancy urls_ enabled (if your instance has
"index.php" in its URLs, Qvitter will not work properly) _and HTTPS enabled_ (it's
2015-10-27 01:56:12 +09:00
always best to use HTTPS from the beginning, there will be issues with federation
if you choose to enable HTTPS later)
2013-08-19 22:30:57 +09:00
2015-07-07 02:28:54 +09:00
2. Put all files in local/plugins/Qvitter
2015-07-07 02:28:54 +09:00
3. Add `addPlugin('Qvitter');` to your /config.php file.
4. It's highly recommended to use the StoreRemoteMedia plugin. It will cache attachments from remote instances locally and make them appear in the streams. Add `addPlugin('StoreRemoteMedia');` to your /config.php file. (Only available in newer GNU social)
5. There are settings in QvitterPlugin.php, but for easy updates, put them in config.php instead. Example:
2014-11-28 05:04:41 +09:00
2014-11-28 05:08:41 +09:00
````
// Qvitter-settings
2014-11-28 05:04:41 +09:00
$config['site']['qvitter']['enabledbydefault'] = true;
$config['site']['qvitter']['defaultbackgroundcolor'] = '#f4f4f4';
$config['site']['qvitter']['defaultlinkcolor'] = '#0084B4';
$config['site']['qvitter']['timebetweenpolling'] = 5000;
2015-10-27 01:56:12 +09:00
$config['site']['qvitter']['urlshortenerapiurl'] = 'http://qttr.at/yourls-api.php'; // if your site is on HTTPS, use url to shortener.php here
2015-07-07 02:28:54 +09:00
$config['site']['qvitter']['urlshortenersignature'] = 'b6afeec983';
$config['site']['qvitter']['sitebackground'] = 'img/vagnsmossen.jpg';
2015-01-28 05:22:17 +09:00
$config['site']['qvitter']['favicon'] = 'img/favicon.ico?v=4';
2015-06-06 23:20:26 +09:00
$config['site']['qvitter']['sprite'] = Plugin::staticPath('Qvitter', '').'img/sprite.png?v=40';
2015-02-05 05:40:56 +09:00
$config['site']['qvitter']['enablewelcometext'] = true;
2015-07-07 02:28:54 +09:00
// $config['site']['qvitter']['customwelcometext']['sv'] = '<h1>Välkommen till Quitter.se en federerad<sup>1</sup> mikrobloggsallmänning!</h1><p>Etc etc...</p>';
// $config['site']['qvitter']['customwelcometext']['en'] = '<h1>Welcome to Quitter.se a federated microblog common!</h1><p>Etc etc...</p>';
$config['site']['qvitter']['blocked_ips'] = array();
2015-10-27 01:56:12 +09:00
// Recommended GNU social settings
2015-07-07 02:28:54 +09:00
$config['thumbnail']['maxsize'] = 3000; // recommended setting to get more high-res image previews
2015-10-27 01:56:12 +09:00
$config['profile']['delete'] = true; // twitter users are used to being able to remove their accounts
$config['profile']['changenick'] = true; // twitter users are used to being able to change their nicknames
$config['public']['localonly'] = true; // only local users in the public timeline (qvitter always has a timeline for the whole known network)
addPlugin('StoreRemoteMedia'); // makes remote images appear in the feed
2014-11-28 05:07:38 +09:00
````
2014-11-28 05:04:41 +09:00
2015-07-24 08:05:58 +09:00
The settings should be self-explanatory. In doubt, ask in the !qvitter group on quitter.se, or email h@nnesmannerhe.im
2015-07-07 02:28:54 +09:00
2015-10-27 01:56:12 +09:00
6. For better performance, disable checkschema (instructions in GNU social's config.php),
but don't forget to run it when updating plugins (including Qvitter).
7. To change the logo, edit /img/sprite.png. For easier git-updates, put it in GNU social's locale folder, and edit the sprite path setting above.
Translation
-----
1. Translation files reside in /locale and /doc folders.
2. When translating .json files, don't translate the placeholder strings inside curly brackets {}
API
-----
Qvitter uses GNU social's built in "twitter compatible" API. The API was designed to be
compatible with Twitter's API v1.0. Some documentation is here: <http://skilledtests.com/wiki/Twitter-compatible_API>
Twitter's API v1.1 documentation is also useful, but may be partly incorrect.
2016-01-15 23:26:30 +09:00
Qvitter extends this API in a few undocumented ways. See onRouterInitialized() in QvitterPlugin.php
2015-10-27 01:56:12 +09:00
for ideas about paths for the API extensions.
2015-07-07 02:28:54 +09:00
Notes
-----
2016-01-08 00:07:15 +09:00
Qvitter is tested with the latest GNU social nightly