From f286c127ba978812ad29ea1b272fac86863cb161 Mon Sep 17 00:00:00 2001 From: b3yond Date: Sat, 13 Oct 2018 18:56:09 +0200 Subject: [PATCH] brought README.md up to date --- README.md | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 4e45a6b..560d899 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # Ticketfrei social bot -Version: 2.0beta - Ticketfrei is a mastodon/twitter/mail bot to dodge ticket controllers in public transport systems. @@ -13,19 +11,19 @@ your tweet and others can read the info and think twice whether they want to buy a ticket or not. If enough people, a critical mass, participate for the bot to become reliable, you have positive self-reinforcing dynamics. -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. +Today, you can use a Twitter, Mastodon, Telegram, and Mail with the account. +They will communicate with each other; if someone warns others via Mail, +Telegram, Twitter and Mastodon users will also see the message. And vice versa. -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. +In version 2, this repository contains a web application. 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. In the promotion folder, you'll find some promotion material you can use to build up such a community in your city. Unfortunately it is in german - but it's editable, feel free to translate it! -Website: https://ticketfrei.links-tech.org +Website (our flagship instance): https://ticketfrei.links-tech.org More information: https://wiki.links-tech.org/IT/Ticketfrei @@ -34,9 +32,11 @@ More information: https://wiki.links-tech.org/IT/Ticketfrei Just go to https://ticketfrei.links-tech.org or another website where this software is running. -* Register a twitter account -* Register a Mastodon account * Register on the ticketfrei site +* Optionally: register bots: + * Register a Twitter account + * Register a Mastodon account + * Register a Telegram bot * Configure account * The hard part: do the promotion! You need a community. @@ -50,7 +50,7 @@ to check if something was retweeted in the last hour or something. To this date, we have never heard of this happening though. -### blockisting +### Blocklisting You also need to edit the goodlist and the blocklist. You can do this on the website, in the settings of your bot. @@ -70,9 +70,9 @@ a GitHub issue or write to tech@lists.links-tech.org, we are happy to help and s We wrote these installation notes, so you can set up the website easily: -### Install +### Install from the git repository -To Do: +This guide assumes you are on a Debian 9 Server: ```shell sudo apt install python3 virtualenv uwsgi uwsgi-plugin-python3 nginx git exim4 @@ -101,10 +101,11 @@ cp config.toml.example config.toml vim config.toml ``` -This configuration is only for the admin. Users can log into +This configuration is only for the admin. Moderators can log into twitter/mastodon/mail and configure their personal bot on the settings page. Set up LetsEncrypt: + ```shell sudo apt-get install python-certbot-nginx -t stretch-backports sudo certbot --authenticator webroot --installer nginx --agree-tos --redirect --hsts @@ -176,11 +177,15 @@ less /var/log/syslog # for the nginx web server: less /var/log/nginx/example.org_error.log + +# for the mail server +less /var/log/exim4/mainlog ``` ### Development Install -If you want to install it locally to develop on it: +If you want to install it locally to develop on it, note that twitter and mail +will probably not work. You should test them on a server instead. ```shell sudo apt install python3 virtualenv uwsgi uwsgi-plugin-python3 nginx git