91 lines
3.3 KiB
Markdown
91 lines
3.3 KiB
Markdown
Qvitter
|
|
==========================================
|
|
|
|
* Author: Hannes Mannerheim (<h@nnesmannerhe.im>)
|
|
* Last mod.: Nov, 2014
|
|
* Version: 4
|
|
* 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
|
|
|
|
2. Put all files in /plugins/Qvitter
|
|
|
|
3. Replace your lib/apiauthaction.php file with the one supplied in
|
|
edited-gnu-social-files/lib/apiauthaction.php. (not needed if you
|
|
are running the latest GNU Social nightly!)
|
|
|
|
4. Add `addPlugin('Qvitter');` to your /config.php file.
|
|
|
|
5. 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.
|
|
|
|
6. Users can go to ://{instance}/settings/qvitter and enable or disable Qvitter.
|
|
|
|
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:
|
|
|
|
````
|
|
// Qvitter-settings
|
|
$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';
|
|
````
|
|
|
|
Note: Qvitter is tested with GNU Social version 1.1.1-alpha2 (7e47026085fa4f2071e694d9c3e3fe2aa5142135).
|
|
|
|
|
|
TODO
|
|
----
|
|
|
|
1. rtl is a little broken, also mobile rtl
|
|
|
|
1. DM's
|
|
|
|
1. user actions-cog wheel in users lists, ellipsis button in queets, with block etc
|
|
|
|
1. lists
|
|
|
|
1. proxy to non-https for getting conversations the instance doesn't have via jsonp
|
|
|
|
1. preview different types of attachments, not just images. e.g. mp3's, torrents etc etc
|
|
|
|
1. Join _new_ external groups and follow _new_ external users ("New" meaning users/groups that the server don't know yet)
|
|
|
|
1. Creating groups, make admin, block user
|
|
|
|
1. Search users
|
|
|
|
1. Recommended users
|
|
|
|
1. Filters (hide queets containing strings, e.g. mute users)
|
|
|
|
1. More languages, maybe make proper po/mo-files
|
|
|
|
1. Admin-interface
|
|
|
|
1. New "expand queet" api for getting conversation, retweets, favs and attachment in the same request
|
|
|
|
1. Node.js long polling server and an new api that serve aggregate of all polling users requests in one go |