SchoolGuy/ticketfrei
1
0
Fork 0
forked from ticketfrei/ticketfrei
Code Issues Pull requests Releases Wiki Activity

started reworking the README

Browse source
This commit is contained in:
b3yond 2018-03-24 11:58:15 +01:00
parent ba9b28f254
commit 061fb62bdc
1 changed files with 75 additions and 82 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

157
README.md
View file

@ -1,114 +1,107 @@
# Ticketfrei social bot # Ticketfrei social bot
Version: 1.0 Version: 2.0beta
Ticketfrei is a mastodon/twitter/mail bot to dodge ticket controllers Ticketfrei is a mastodon/twitter/mail bot to dodge ticket controllers in public
in public transport systems. transport systems.
The functionality is simple: it retweets every tweet where it is The functionality is simple: it retweets every tweet where it is mentioned.
mentioned.
This leads to a community which evolves around it; if you see ticket This leads to a community which evolves around it; if you see ticket
controllers, you tweet their location and mention the bot. The bot controllers, you tweet their location and mention the bot. The bot then
then retweets your tweet and others can read the info and think twice retweets your tweet and others can read the info and think twice if they want
if they want to buy a ticket. If enough people, a critical mass, to buy a ticket. If enough people, a critical mass, participate for the bot to
participate for the bot to become reliable, you have positive become reliable, you have positive self-reinforcing dynamics.
self-reinforcing dynamics.
In the promotion folder, you will find some promotion material you Today, you can use a Twitter, a Mastodon, and Mail with the account. They will
can use to build up such a community in your city. It is in german communicate with each other; if someone warns others via Mail, Twitter and
though =/ Mastodon users will also see the message. And vice versa.
Website: https://wiki.links-tech.org/IT/Ticketfrei 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.
## Install In the promotion folder, you will find some (german) promotion material you can
use to build up such a community in your city.
Setting up a ticketfrei bot for your city is quite easy. Here are the Website: ticketfrei.links-tech.org
few steps:
First you need to install python3 and virtualenv with your favourite More information: https://wiki.links-tech.org/IT/Ticketfrei
package manager.
Create and activate virtualenv: ## Do you want Ticketfrei in your city?
```shell Just got to ticketfrei.links-tech.org or another website where this software is
sudo apt install python3 virtualenv uwsgi uwsgi-plugin-python nginx running.
virtualenv -p python3 .
. bin/activate
```
Install the dependencies: * Register a twitter account
```shell * Register a Mastodon account
pip install tweepy pytoml requests Mastodon.py bottle pyjwt * Register on the ticketfrei site
``` * Configure account
* The hard part: do the promotion! You need a community.
Configure the bot: ### Maintaining
```shell
cp config.toml.example config.toml
vim config.toml
```
You can use a Twitter, a Mastodon, and Mail with the account. They There is one security hole: people could start mentioning the bot with useless
will communicate with each other; if someone warns others via Mail, information, turning it into a spammer. That's why it has to be maintained; if
Twitter and Mastodon users will also see the message. And vice versa. 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
You have to configure all of the accounts via config.toml; it should check if something was retweeted in the last hour or something.
be fairly intuitive to enter the right values.
## Maintaining
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.
To this date, we have never heard of this happening though. To this date, we have never heard of this happening though.
### blacklisting ### blacklisting
You also need to edit the goodlist and the blacklist. They are in the You also need to edit the goodlist and the blacklist. You can do this on the
"goodlists" and "blacklists" folders. All text files in those website, in the settings of your bot.
directories will be used, so you should delete our templates; but
feel free to use them as an orientation.
Just add the words to the goodlist, which you want to require. A Just add the words to the goodlist, which you want to require. A report is only
report is only spread, if it contains at least one of them. If you spread, if it contains at least one of them. If you want to RT everything, just
want to RT everything, just add a ```*```. add a ```*```.
There is also a blacklist, which you can use to automatically sort There is also a blacklist, which you can use to automatically sort out
out malicious tweets. Be careful though, our filter can't read the malicious tweets. Be careful though, our filter can't read the intention with
intention with which a word was used. Maybe you wanted it there. which a word was used. Maybe you wanted it there.
### screen ## Do you want to offer a Ticketfrei website to others?
To keep the bots running when you are logged out of the shell, you If you want to offer this website to others, feel free to do so. If you have questions, just open
can use screen: a GitHub issue or write to tech@lists.links-tech.org, we are happy to help and share best practices.
We wrote these installation notes, so you can set up the website easily:
### Install
To Do:
```shell ```shell
sudo apt-get install screen sudo apt install python3 virtualenv uwsgi uwsgi-plugin-python nginx
echo "if [ -z "$STY" ]; then screen -RR; fi" >> ~/.bash_login
screen
python3 ticketfrei.py
``` ```
To log out of the screen session, press "ctrl+a", and then "d". * set up nginx
* set up LetsEncrypt https://certbot.eff.org/
* set up mariadb
* set up uwsgi
### Manually creating the database Install the necessary packages, create and activate virtualenv:
Unfortunately, if you want to help developing, you have to create the ```shell
database manually for now. virtualenv -p python3 .
. bin/activate
At the moment, we use a SQLITE3 database. If you are in the repo
directory, just open it with ```sqlitebrowser ticketfrei.sqlite```.
Then execute following SQL to create the tables:
```sql
CREATE TABLE `user` (
`id` INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT UNIQUE,
`email` TEXT,
`pass_hashed` TEXT,
`enabled` INTEGER
)
``` ```
Install the dependencies:
```shell
pip install tweepy pytoml requests Mastodon.py bottle pyjwt
```
Configure the bot:
```shell
cp config.toml.example config.toml
vim config.toml
```
This configuration is only for the admin. Users can log into
twitter/mastodon/mail and configure their personal bot on the settings page.