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

* Author:    Hannes Mannerheim (<h@nnesmannerhe.im>)
5 6
* Last mod.: Nov, 2014
* Version:   4
hannes's avatar
upload  
hannes committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
* 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  
your option) any later version.                                            
                                                                           
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  
more details.                                                              
                                                                           
You should have received a copy of the  GNU Affero General Public License  
along with Qvitter. If not, see <http://www.gnu.org/licenses/>.            
                                                                           
Setup
-----

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

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

hannes's avatar
hannes committed
29
3. Replace your lib/apiauthaction.php file with the one supplied in 
30 31
edited-gnu-social-files/lib/apiauthaction.php. (this might not be needed if you are
running the latest GNU social nightly)
hannes's avatar
upload  
hannes committed
32

33 34
4. Add `addPlugin('Qvitter');` to your /config.php file.

35 36 37
5. It's recommended to set this setting in your /config.php file: `$config['thumbnail']['maxsize'] = 3000;`

6. There are a few settings in /plugins/Qvitter/QvitterPlugin.php. By default Qvitter is 
hannes's avatar
hannes committed
38 39 40
opt-out for users. If you set `$settings['enabledbydefault'] = false;` Qvitter will
be opt-in instead.

41
7. Users can go to ://{instance}/settings/qvitter and enable or disable Qvitter.
hannes's avatar
hannes committed
42

hannes's avatar
hannes committed
43 44 45 46 47 48
Optional
-----

For easy updates, you can use /config.php to override the settings in /plugins/Qvitter/QvitterPlugin.php.
For example, add this to your /config.php file:

hannes's avatar
hannes committed
49 50
````
// Qvitter-settings
hannes's avatar
hannes committed
51 52 53 54 55 56
$config['site']['qvitter']['enabledbydefault'] = true;
$config['site']['qvitter']['defaultbackgroundcolor'] = '#f4f4f4';
$config['site']['qvitter']['defaultlinkcolor'] = '#0084B4';
$config['site']['qvitter']['timebetweenpolling'] = 5000;
$config['site']['qvitter']['urlshortenerapiurl'] = 'http://qttr.at/yourls-api.php';	
$config['site']['qvitter']['urlshortenersignature'] = 'b6afeec983';	
57
$config['site']['qvitter']['sitebackground'] = 'img/vagnsmossen.jpg';
58
$config['site']['qvitter']['favicon'] = 'img/favicon.ico?v=4';
59
$config['site']['qvitter']['blocked_ips'] = array();
60
$config['thumbnail']['maxsize'] = 3000;
hannes's avatar
hannes committed
61
````
hannes's avatar
hannes committed
62

63
Note: Qvitter is tested with GNU Social version 1.1.1-alpha2 (7e47026085fa4f2071e694d9c3e3fe2aa5142135).
hannes's avatar
hannes committed
64

hannes's avatar
upload  
hannes committed
65 66 67 68

TODO
----

69
1. rtl is a little broken, also mobile rtl
hannes's avatar
hannes committed
70 71 72

1. DM's

73
1. user actions-cog wheel in users lists, ellipsis button in queets, with block etc
hannes's avatar
hannes committed
74

75
1. lists
hannes's avatar
hannes committed
76 77

1. proxy to non-https for getting conversations the instance doesn't have via jsonp
hannes's avatar
upload  
hannes committed
78

hannes's avatar
hannes committed
79
1. preview different types of attachments, not just images. e.g. mp3's, torrents etc etc
hannes's avatar
upload  
hannes committed
80

hannes's avatar
hannes committed
81 82
1. Join _new_ external groups and follow _new_ external users ("New" meaning users/groups that the server don't know yet) 

hannes's avatar
hannes committed
83
1. Creating groups, make admin, block user
hannes's avatar
upload  
hannes committed
84

hannes's avatar
hannes committed
85
1. Search users
hannes's avatar
upload  
hannes committed
86

hannes's avatar
hannes committed
87
1. Recommended users
hannes's avatar
upload  
hannes committed
88

hannes's avatar
hannes committed
89
1. Filters (hide queets containing strings, e.g. mute users)
hannes's avatar
upload  
hannes committed
90

hannes's avatar
hannes committed
91
1. More languages, maybe make proper po/mo-files
hannes's avatar
upload  
hannes committed
92

hannes's avatar
hannes committed
93
1. Admin-interface
hannes's avatar
upload  
hannes committed
94

hannes's avatar
hannes committed
95
1. New "expand queet" api for getting conversation, retweets, favs and attachment in the same request
hannes's avatar
upload  
hannes committed
96

97
1. Node.js long polling server and an new api that serve aggregate of all polling users requests in one go