started reworking the README
This commit is contained in:
parent
ba9b28f254
commit
061fb62bdc
157
README.md
157
README.md
|
|
@ -1,114 +1,107 @@
|
|||
# Ticketfrei social bot
|
||||
|
||||
Version: 1.0
|
||||
Version: 2.0beta
|
||||
|
||||
Ticketfrei is a mastodon/twitter/mail bot to dodge ticket controllers
|
||||
in public transport systems.
|
||||
Ticketfrei is a mastodon/twitter/mail bot to dodge ticket controllers in public
|
||||
transport systems.
|
||||
|
||||
The functionality is simple: it retweets every tweet where it is
|
||||
mentioned.
|
||||
The functionality is simple: it retweets every tweet where it is mentioned.
|
||||
|
||||
This leads to a community which evolves around it; if you see ticket
|
||||
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.
|
||||
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.
|
||||
|
||||
In the promotion folder, you will find some promotion material you
|
||||
can use to build up such a community in your city. It is in german
|
||||
though =/
|
||||
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.
|
||||
|
||||
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
|
||||
few steps:
|
||||
Website: ticketfrei.links-tech.org
|
||||
|
||||
First you need to install python3 and virtualenv with your favourite
|
||||
package manager.
|
||||
More information: https://wiki.links-tech.org/IT/Ticketfrei
|
||||
|
||||
Create and activate virtualenv:
|
||||
## Do you want Ticketfrei in your city?
|
||||
|
||||
```shell
|
||||
sudo apt install python3 virtualenv uwsgi uwsgi-plugin-python nginx
|
||||
virtualenv -p python3 .
|
||||
. bin/activate
|
||||
```
|
||||
Just got to ticketfrei.links-tech.org or another website where this software is
|
||||
running.
|
||||
|
||||
Install the dependencies:
|
||||
```shell
|
||||
pip install tweepy pytoml requests Mastodon.py bottle pyjwt
|
||||
```
|
||||
* 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.
|
||||
|
||||
Configure the bot:
|
||||
```shell
|
||||
cp config.toml.example config.toml
|
||||
vim config.toml
|
||||
```
|
||||
### Maintaining
|
||||
|
||||
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.
|
||||
|
||||
You have to configure all of the accounts via config.toml; it should
|
||||
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.
|
||||
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.
|
||||
|
||||
### blacklisting
|
||||
|
||||
You also need to edit the goodlist and the blacklist. They are in the
|
||||
"goodlists" and "blacklists" folders. All text files in those
|
||||
directories will be used, so you should delete our templates; but
|
||||
feel free to use them as an orientation.
|
||||
You also need to edit the goodlist and the blacklist. You can do this on the
|
||||
website, in the settings of your bot.
|
||||
|
||||
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 ```*```.
|
||||
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 ```*```.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### 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
|
||||
can use screen:
|
||||
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.
|
||||
|
||||
We wrote these installation notes, so you can set up the website easily:
|
||||
|
||||
### Install
|
||||
|
||||
To Do:
|
||||
|
||||
```shell
|
||||
sudo apt-get install screen
|
||||
echo "if [ -z "$STY" ]; then screen -RR; fi" >> ~/.bash_login
|
||||
screen
|
||||
python3 ticketfrei.py
|
||||
sudo apt install python3 virtualenv uwsgi uwsgi-plugin-python nginx
|
||||
```
|
||||
|
||||
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
|
||||
database manually for now.
|
||||
|
||||
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
|
||||
)
|
||||
```shell
|
||||
virtualenv -p python3 .
|
||||
. bin/activate
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue