ticketfrei/README.md

128 lines
4 KiB
Markdown
Raw Normal View History

2018-01-19 15:42:43 +00:00
# Ticketfrei social bot
2017-06-17 12:57:43 +00:00
2018-03-24 10:58:15 +00:00
Version: 2.0beta
2018-03-24 10:58:15 +00:00
Ticketfrei is a mastodon/twitter/mail bot to dodge ticket controllers in public
transport systems.
2017-06-17 12:57:43 +00:00
2018-03-24 10:58:15 +00:00
The functionality is simple: it retweets every tweet where it is mentioned.
2017-06-17 12:57:43 +00:00
This leads to a community which evolves around it; if you see ticket
2018-03-24 10:58:15 +00:00
controllers, you tweet their location and mention the bot. The bot then
retweets your tweet and others can read the info and think twice if they want
to buy a ticket. If enough people, a critical mass, participate for the bot to
become reliable, you have positive self-reinforcing dynamics.
2017-06-17 12:57:43 +00:00
2018-03-24 10:58:15 +00:00
Today, you can use a Twitter, a Mastodon, and Mail with the account. They will
communicate with each other; if someone warns others via Mail, Twitter and
Mastodon users will also see the message. And vice versa.
2017-06-17 12:57:43 +00:00
2018-03-24 10:58:15 +00:00
In version 2, this bot has received a frontend website. On this website, people
can register an own bot for their city - the website manages multiple bots for
multiple citys. This way, you do not have to host it yourself.
2017-06-17 12:57:43 +00:00
2018-03-24 10:58:15 +00:00
In the promotion folder, you will find some (german) promotion material you can
use to build up such a community in your city.
2017-06-17 12:57:43 +00:00
2018-03-24 10:58:15 +00:00
Website: ticketfrei.links-tech.org
2018-03-24 10:58:15 +00:00
More information: https://wiki.links-tech.org/IT/Ticketfrei
2017-11-28 14:11:09 +00:00
2018-03-24 10:58:15 +00:00
## Do you want Ticketfrei in your city?
2017-07-11 19:51:37 +00:00
2018-03-24 10:58:15 +00:00
Just got to ticketfrei.links-tech.org or another website where this software is
running.
2017-11-28 14:11:09 +00:00
2018-03-24 10:58:15 +00:00
* Register a twitter account
* Register a Mastodon account
* Register on the ticketfrei site
* Configure account
* The hard part: do the promotion! You need a community.
2017-11-28 14:11:09 +00:00
2018-03-24 10:58:15 +00:00
### Maintaining
2018-03-24 10:58:15 +00:00
There is one security hole: people could start mentioning the bot with useless
information, turning it into a spammer. That's why it has to be maintained; if
someone spams the bot, mute them and undo the retweet. So it won't retweet
their future tweets and the useless retweet is deleted if someone tries to
check if something was retweeted in the last hour or something.
2018-03-24 10:58:15 +00:00
To this date, we have never heard of this happening though.
2018-03-24 10:58:15 +00:00
### blacklisting
2018-03-24 10:58:15 +00:00
You also need to edit the goodlist and the blacklist. You can do this on the
website, in the settings of your bot.
2018-03-24 10:58:15 +00:00
Just add the words to the goodlist, which you want to require. A report is only
spread, if it contains at least one of them. If you want to RT everything, just
add a ```*```.
2017-06-17 22:35:34 +00:00
2018-03-24 10:58:15 +00:00
There is also a blacklist, which you can use to automatically sort out
malicious tweets. Be careful though, our filter can't read the intention with
which a word was used. Maybe you wanted it there.
2017-10-17 13:27:24 +00:00
2018-03-24 10:58:15 +00:00
## Do you want to offer a Ticketfrei website to others?
2017-06-17 23:44:22 +00:00
2018-03-24 10:58:15 +00:00
If you want to offer this website to others, feel free to do so. If you have questions, just open
a GitHub issue or write to tech@lists.links-tech.org, we are happy to help and share best practices.
2017-06-17 23:44:22 +00:00
2018-03-24 10:58:15 +00:00
We wrote these installation notes, so you can set up the website easily:
2017-06-17 12:57:43 +00:00
2018-03-24 10:58:15 +00:00
### Install
2017-10-17 13:27:24 +00:00
2018-03-24 10:58:15 +00:00
To Do:
```shell
sudo apt install python3 virtualenv uwsgi uwsgi-plugin-python3 nginx
```
2018-03-24 10:58:15 +00:00
* set up nginx
* set up LetsEncrypt https://certbot.eff.org/
* set up mariadb
* set up uwsgi
2017-10-17 13:27:24 +00:00
2018-03-24 10:58:15 +00:00
Install the necessary packages, create and activate virtualenv:
2018-02-16 11:02:58 +00:00
2018-03-24 10:58:15 +00:00
```shell
virtualenv -p python3 .
. bin/activate
```
Install the dependencies:
```shell
pip install tweepy pytoml Mastodon.py bottle pyjwt pylibscrypt
2018-03-24 10:58:15 +00:00
```
2018-02-16 11:02:58 +00:00
2018-03-24 10:58:15 +00:00
Configure the bot:
2018-02-16 11:02:58 +00:00
2018-03-24 10:58:15 +00:00
```shell
cp config.toml.example config.toml
vim config.toml
2018-02-16 11:02:58 +00:00
```
2018-03-24 10:58:15 +00:00
This configuration is only for the admin. Users can log into
twitter/mastodon/mail and configure their personal bot on the settings page.
Deploy ticketfrei with uwsgi:
```shell
echo "Enter your domain name into the following prompt:" && read DOMAIN
# configure nginx
sudo sed -r "s/example.org/$DOMAIN/g" deployment/example.org.conf > /etc/nginx/sites-enabled/$DOMAIN.conf
# create folder for socket
sudo mkdir /var/run/ticketfrei
sudo chown tech:www-data -R /var/run/ticketfrei
# start up nginx
sudo service nginx restart
# create and start the frontend systemd service
sudo cp deployment/ticketfrei-web.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl start ticketfrei-web.service
```