expandurl-mastodon/README.md

73 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

**expandurl-mastodon** is a Mastodon bot that expands shortened URLs.
2018-05-11 06:57:41 +02:00
If you want the bot to expand an URL, reply to the post with the URL in it and
2018-05-11 07:33:23 +02:00
mention the bot account (`@expandurl@botsin.space` for example).
![Example screenshot](https://doc.schlomp.space/expandurl-mastodon/expandurl_screenshot.jpg)
2018-05-13 06:11:47 +02:00
2018-05-11 07:33:23 +02:00
This bot uses the same visibility as you, but posts unlisted instead of public.
It retains the sensitive flag and spoiler warnings.
2018-05-20 18:31:27 +02:00
Some tracking parameters, like those beginning with
[utm_](https://en.wikipedia.org/wiki/UTM_parameters) are stripped. It also tries
to rewrite [AMP](https://en.wikipedia.org/wiki/Accelerated_Mobile_Pages) URLs to
point at the real webpages.
2018-05-11 07:33:23 +02:00
Please report any bugs via the
2018-06-04 21:04:38 +02:00
[issue tracker on schlomp.space](https://schlomp.space/tastytea/expandurl-mastodon/issues)
2018-05-11 07:33:23 +02:00
or to [@tastytea@soc.ialis.me](https://soc.ialis.me/@tastytea).
# Install
## Dependencies
2019-01-31 18:01:15 +01:00
* Tested OS: Linux
* C++ compiler (tested: gcc 6/7/8)
* [cmake](https://cmake.org/) (tested: 3.9 / 3.11)
* [curlpp](http://www.curlpp.org/) (tested: 0.8)
* [mastodon-cpp](https://schlomp.space/tastytea/mastodon-cpp) (at least: 0.106)
2019-01-31 18:01:15 +01:00
* [jsoncpp](https://github.com/open-source-parsers/jsoncpp) (tested: 1.8 / 1.7)
* [libxdg-basedir](http://repo.or.cz/w/libxdg-basedir.git) (tested: 1.2)
* Optional:
* Manpage: [asciidoc](http://asciidoc.org/) (tested: 8.6)
## Get sourcecode
2018-05-21 13:05:59 +02:00
### Latest release
2018-06-04 21:04:38 +02:00
https://schlomp.space/tastytea/expandurl-mastodon/releases
2018-05-21 13:05:59 +02:00
### Development version
```SH
git clone https://schlomp.space/tastytea/expandurl-mastodon.git
```
## Compile
```SH
mkdir build
cd build/
cmake ..
make
```
2019-01-31 18:34:37 +01:00
cmake options:
* `-DCMAKE_BUILD_TYPE=Debug` for a debug build
* `-DWITH_MAN=NO` to not compile the manpage
Install with `make install`.
# Usage
2019-01-31 18:01:15 +01:00
Have a look at the [manpage](https://schlomp.space/tastytea/expandurl-mastodon/src/branch/master/expandurl-mastodon.1.adoc).
# Copyright
```PLAIN
2019-04-20 01:47:23 +02:00
Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>.
2018-06-04 00:59:28 +02:00
License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
This program comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.
```