thorunimore 1.2.11

Authentication gateway bot for the Unimore Informatica Telegram group

thorunimore

A moderator bot for the Unimore Informatica group

Installation

1. Create a new venv and enter it:

   python -m venv venv
   source venv/bin/activate
   

2. Download through PyPI:

   pip install thorunimore
   

3. Install the packages required to connect to the desired SQL database:

   • For PostgreSQL:

     pip install psycopg2-binary
     

Running

Development

1. Set the following env variables:

   • The URI of the SQL database you want to use

     SQLALCHEMY_DATABASE_URI=postgresql://steffo@/thor_dev
     

   • A Google OAuth 2.0 client id and client secret

     GOOGLE_CLIENT_ID=000000000000-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.apps.googleusercontent.com
     GOOGLE_CLIENT_SECRET=aaaaaaaaaaaaaaaaaaaaaaaa
     

   • A random string of characters used to sign Telegram data

     SECRET_KEY=Questo è proprio un bel test.
     

   • api_id and api_hash for a Telegram application

     TELEGRAM_API_ID=1234567
     TELEGRAM_API_HASH=abcdefabcdefabcdefabcdefabcdefab
     

   • The username and token of the Telegram bot

     TELEGRAM_BOT_USERNAME=thorunimorebot
     TELEGRAM_BOT_TOKEN=1111111111:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
     

   • The desired logging level and format

     LOG_LEVEL=DEBUG
     LOG_FORMAT={asctime}\t| {name}\t| {message}
     

   • The url at which web is hosted

     BASE_URL=http://lo.steffo.eu:30008
     

   • The url to join the Telegram group

     GROUP_URL=https://t.me/joinchat/AAAAAAAAAAAAAAAAAAAAAA
     

2. Run both the following processes:

   python -m thorunimore.telegram &
   python -m thorunimore.web &
   

Production

1. Install gunicorn in the previously created venv:

   pip install gunicorn
   

2. Create the bot-thorunimore systemd unit by creating the /etc/systemd/system/bot-thorunimore.service file:

   [Unit]
   Name=bot-thorunimore
   Description=A moderator bot for the Unimore Informatica group
   Requires=network-online.target postgresql.service
   After=network-online.target nss-lookup.target
   
   [Service]
   Type=exec
   User=thorunimore
   WorkingDirectory=/opt/thorunimore
   ExecStart=/opt/thorunimore/venv/bin/python -OO -m thorunimore.telegram
   Environment=PYTHONUNBUFFERED=1
   
   [Install]
   WantedBy=multi-user.target
   

3. Create the web-thorunimore systemd unit by creating the /etc/systemd/system/web-thorunimore.service file:

   [Unit]
   Name=web-thorunimore
   Description=Thorunimore Gunicorn Server
   Wants=network-online.target postgresql.service
   After=network-online.target nss-lookup.target
   
   [Service]
   Type=exec
   User=thorunimore
   WorkingDirectory=/opt/thorunimore
   ExecStart=/opt/thorunimore/venv/bin/gunicorn -b 127.0.0.1:30008 thorunimore.web.__main__:reverse_proxy_app
   
   [Install]
   WantedBy=multi-user.target
   

4. Create the /etc/systemd/system/bot-thorunimore.d/override.conf and /etc/systemd/system/web-thorunimore.d/override.conf files:

   [Service]
   Environment="SQLALCHEMY_DATABASE_URI=postgresql://thorunimore@/thor_prod"
   Environment="GOOGLE_CLIENT_ID=000000000000-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.apps.googleusercontent.com"
   Environment="GOOGLE_CLIENT_SECRET=aaaaaaaaaaaaaaaaaaaaaaaa"
   Environment="SECRET_KEY=Questo è proprio un bel server."
   Environment="TELEGRAM_API_ID=1234567"
   Environment="TELEGRAM_API_HASH=abcdefabcdefabcdefabcdefabcdefab"
   Environment="TELEGRAM_BOT_USERNAME=thorunimorebot"
   Environment="TELEGRAM_BOT_TOKEN=1111111111:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
   Environment="LOG_LEVEL=DEBUG"
   Environment="LOG_FORMAT={asctime}\t| {name}\t| {message}"
   Environment="BASE_URL=https://thor.steffo.eu"
   Environment="GROUP_URL=https://t.me/joinchat/AAAAAAAAAAAAAAAAAAAAAA"
   

5. Start (and optionally enable) both services:

   systemctl start "*-thorunimore"
   systemctl enable "*-thorunimore"
   

6. Reverse-proxy the web service:

   <VirtualHost *:80>
   
   ServerName "thor.steffo.eu"
   Redirect permanent "/" "https://thor.steffo.eu/"
   
   </VirtualHost>
   
   <VirtualHost *:443>
   
   ServerName "thor.steffo.eu"
   
   ProxyPass "/" "http://127.0.0.1:30008/"
   ProxyPassReverse "/" "http://127.0.0.1:30008/"
   RequestHeader set "X-Forwarded-Proto" expr=%{REQUEST_SCHEME}
   
   SSLEngine on
   SSLCertificateFile "/root/.acme.sh/*.steffo.eu/fullchain.cer"
   SSLCertificateKeyFile "/root/.acme.sh/*.steffo.eu/*.steffo.eu.key"
   
   </VirtualHost>
   

   a2ensite rp-thorunimore