README.md 2.76 KB
Newer Older
hannes's avatar
upload  
hannes committed
1 2 3 4
Qvitter
==========================================

* Author:    Hannes Mannerheim (<h@nnesmannerhe.im>)
hannes's avatar
hannes committed
5
* Last mod.: July, 2015
6
* Version:   5-alpha
hannes's avatar
upload  
hannes committed
7 8 9 10 11
* 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  
hannes's avatar
hannes committed
12 13
your option) any later version.

hannes's avatar
upload  
hannes committed
14 15 16
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  
hannes's avatar
hannes committed
17 18
more details.

hannes's avatar
upload  
hannes committed
19
You should have received a copy of the  GNU Affero General Public License  
hannes's avatar
hannes committed
20 21
along with Qvitter. If not, see <http://www.gnu.org/licenses/>.

hannes's avatar
upload  
hannes committed
22 23 24
Setup
-----

25
1. Install GNU social
hannes's avatar
upload  
hannes committed
26

hannes's avatar
hannes committed
27
2. Put all files in local/plugins/Qvitter
hannes's avatar
hannes committed
28

hannes's avatar
hannes committed
29
3. Add `addPlugin('Qvitter');` to your /config.php file.
hannes's avatar
hannes committed
30

31 32 33
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:
hannes's avatar
hannes committed
34

hannes's avatar
hannes committed
35 36
````
// Qvitter-settings
hannes's avatar
hannes committed
37

hannes's avatar
hannes committed
38 39 40 41
$config['site']['qvitter']['enabledbydefault'] = true;
$config['site']['qvitter']['defaultbackgroundcolor'] = '#f4f4f4';
$config['site']['qvitter']['defaultlinkcolor'] = '#0084B4';
$config['site']['qvitter']['timebetweenpolling'] = 5000;
hannes's avatar
hannes committed
42 43
$config['site']['qvitter']['urlshortenerapiurl'] = 'http://qttr.at/yourls-api.php';
$config['site']['qvitter']['urlshortenersignature'] = 'b6afeec983';
44
$config['site']['qvitter']['sitebackground'] = 'img/vagnsmossen.jpg';
45
$config['site']['qvitter']['favicon'] = 'img/favicon.ico?v=4';
hannes's avatar
hannes committed
46
$config['site']['qvitter']['sprite'] = Plugin::staticPath('Qvitter', '').'img/sprite.png?v=40';
47
$config['site']['qvitter']['enablewelcometext'] = true;
hannes's avatar
hannes committed
48 49
// $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>';
50
$config['site']['qvitter']['blocked_ips'] = array();
hannes's avatar
hannes committed
51
$config['thumbnail']['maxsize'] = 3000; // recommended setting to get more high-res image previews
hannes's avatar
hannes committed
52
````
hannes's avatar
hannes committed
53

maliktunga's avatar
maliktunga committed
54
The settings should be self-explanatory. In doubt, ask in the !qvitter group on quitter.se, or email h@nnesmannerhe.im
hannes's avatar
hannes committed
55 56 57 58 59 60


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).