Qvitter/README.md

59 lines
2.5 KiB
Markdown
Raw Normal View History

2013-08-19 22:30:57 +09:00
Qvitter
==========================================
* Author: Hannes Mannerheim (<h@nnesmannerhe.im>)
2015-07-07 02:28:54 +09:00
* Last mod.: July, 2015
* Version: 5-alpha
2013-08-19 22:30:57 +09:00
* GitHub: <https://github.com/hannesmannerheim/qvitter>
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
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.
2015-07-07 02:28:54 +09:00
4. 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
2015-07-07 02:28:54 +09:00
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-07-07 02:28:54 +09:00
$config['site']['qvitter']['urlshortenerapiurl'] = 'http://qttr.at/yourls-api.php';
$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-07-07 02:28:54 +09:00
$config['thumbnail']['maxsize'] = 3000; // recommended setting to get more high-res image previews
2014-11-28 05:07:38 +09:00
````
2014-11-28 05:04:41 +09:00
2015-07-07 02:28:54 +09:00
The settings should be self-explanatory. In doubt, as in the !qvitter-group on quitter.se, or email h@nnesmannerhe.im
Notes
-----
Qvitter is tested with the latest GNU social nightly and also an older version: GNU social version 1.1.1-alpha2 (7e47026085fa4f2071e694d9c3e3fe2aa5142135, 24 aug 2014).