Qvitter/README.md

96 lines
3.5 KiB
Markdown
Raw Normal View History

2013-08-19 22:30:57 +09:00
Qvitter
==========================================
* Author: Hannes Mannerheim (<h@nnesmannerhe.im>)
* Last mod.: Nov, 2014
* Version: 4
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
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
-----
1. Install GNU Social
2013-08-19 22:30:57 +09:00
2. Put all files in /plugins/Qvitter
2013-09-03 01:13:15 +09:00
2014-05-16 11:26:10 +09:00
3. Replace your lib/apiauthaction.php file with the one supplied in
2015-01-27 01:24:27 +09:00
edited-gnu-social-files/lib/apiauthaction.php.
2013-08-19 22:30:57 +09:00
4. Add `addPlugin('Qvitter');` to your /config.php file.
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
opt-out for users. If you set `$settings['enabledbydefault'] = false;` Qvitter will
be opt-in instead.
7. Users can go to ://{instance}/settings/qvitter and enable or disable Qvitter.
2014-11-28 05:04:41 +09:00
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:
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;
$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';
$config['thumbnail']['maxsize'] = 3000;
2014-11-28 05:07:38 +09:00
````
2014-11-28 05:04:41 +09:00
Note: Qvitter is tested with GNU Social version 1.1.1-alpha2 (7e47026085fa4f2071e694d9c3e3fe2aa5142135).
2013-11-23 08:31:04 +09:00
2013-08-19 22:30:57 +09:00
TODO
----
1. rtl is a little broken, also mobile rtl
2014-09-25 06:20:35 +09:00
1. DM's
1. user actions-cog wheel in users lists, ellipsis button in queets, with block etc
2014-09-25 06:20:35 +09:00
1. lists
2014-09-25 06:20:35 +09:00
1. proxy to non-https for getting conversations the instance doesn't have via jsonp
2013-08-19 22:30:57 +09:00
2014-09-25 06:20:35 +09:00
1. preview different types of attachments, not just images. e.g. mp3's, torrents etc etc
2013-08-19 22:30:57 +09:00
2014-09-25 06:20:35 +09:00
1. Join _new_ external groups and follow _new_ external users ("New" meaning users/groups that the server don't know yet)
2014-11-28 05:04:41 +09:00
1. Creating groups, make admin, block user
2013-08-19 22:30:57 +09:00
2014-11-28 05:04:41 +09:00
1. Search users
2013-08-19 22:30:57 +09:00
2014-11-28 05:04:41 +09:00
1. Recommended users
2013-08-19 22:30:57 +09:00
2014-11-28 05:04:41 +09:00
1. Filters (hide queets containing strings, e.g. mute users)
2013-08-19 22:30:57 +09:00
2014-11-28 05:04:41 +09:00
1. More languages, maybe make proper po/mo-files
2013-08-19 22:30:57 +09:00
2014-11-28 05:04:41 +09:00
1. Admin-interface
2013-08-19 22:30:57 +09:00
2014-11-28 05:04:41 +09:00
1. New "expand queet" api for getting conversation, retweets, favs and attachment in the same request
2013-08-19 22:30:57 +09:00
1. Node.js long polling server and an new api that serve aggregate of all polling users requests in one go