- Automatisches verschicken von Nachrichten mittels API von Stashcat
- Die Credentials für Hermine/Stashcat sowie die Passphrase muss auf dem Server hinterlegt werden! (Siehe config files)
- Entwickelt um auch auf kleineren, eingeschränkteren Webspaces lauffähig zu sein, zudem ist der Stashcat-Api part losgelöst von Frameworks entwickelt um ggf. einfacher in anderer Software integriert werden zu können.
Nebst dem üblichen composer install
- Start
composer dump-env prod DATABASE_URLan die eigene Datenbank anpassen- Kopiere Konfigurationsdateien aus
/config_examplesin/config/legacykopieren und den eigenen Bedürfnissen anpassen. - Führe
doctrine:migrations:migrateaus - Cron-Job einrichten (jede Minute):
php bin/console daemon:tick(siehe unten).
Die Installation wird in diesem Beispiel auf einem Debian 12 und eigener MySQL-DB durchgeführt.
sudo apt updatesudo apt install -y lsb-release ca-certificates apt-transport-https software-properties-common gnupg2
echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/sury-php.list
curl -fsSL https://packages.sury.org/php/apt.gpg| sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/sury-keyring.gpg
sudo apt updatesudo apt install apache2 php8.1 php8.1-curl php8.1-xml php8.1-mysql php8.1-cli php8.1-mbstring
sudo apt install mariadb-server mariadb-client
sudo apt install git curl unzip
Ausführliche Anleitung zu Composer: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-composer-on-debian-11
-
curl -sS https://getcomposer.org/installer -o composer-setup.php -
HASH="$(curl -sS https://composer.github.io/installer.sig)" -
php -r "if (hash_file('SHA384', 'composer-setup.php') === '$HASH') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;" -
sudo php composer-setup.php --install-dir=/usr/local/bin --filename=composer -
rm composer-setup.php
cd /opt/sudo git clone https://github.com/sebiw/HermineBot.gitcd HermineBot/
cp config_examples/*.php config/legacy/
Nach Bedarf auch die "config_examples/command_api_endpoints.json" nach config/legacy/ kopieren
nano /opt/HermineBot/config/legacy/env.api.php'baseUrl' => "https://api.thw-messenger.de/"'userEmail' => "<Mail-Adresse des Hermine-Accounts>",'userPassword' => "<Passwort des Hermine-Accounts>",'userPassphrase' => "<Verschlüsselungskennwort des Hermine-Accounts>",
nano /opt/HermineBot/config/legacy/env.app.php"stashcat_event_company" => "THW OV <Ortschaft>""allowed_channel" => [ "<T_OV_Testchannel>","<T_OV_Testchannel2>" ]#Channels eintragen, in die der Bot Nachrichten senden darf"base_url" => "http://localhost:80/"#DNS-Name oder IP bei Bedarf an den Server anpassen
sudo a2enmod rewritesudo systemctl restart apache2.service
sudo nano /etc/apache2/sites-enabled/000-default.conf- Folgenden Block in die Config einfügen/anpassen:
DocumentRoot /opt/HermineBot/public
<Directory /opt/HermineBot/public>
Options -Indexes +FollowSymLinks
AllowOverride All
Require all granted
</Directory> - Danach den Apache neustarten:
sudo systemctl restart apache2.service
- Zu root werden
sudo su - - MySQL-Client starten
mysql - DB anlegen
create database hermine_bot; - DB-User anlegen
CREATE USER '<DB-Benutzernamen>'@localhost IDENTIFIED BY '<Passwort>'; - DB-User Berechtigungen vergeben
GRANT ALL PRIVILEGES ON hermine_bot.* TO '<DB-Benutzernamen>'@'localhost'; - MySQL-Client beenden
quit; - Aus Root-Kontext raus
exit
nano .env.local
Zugangsdaten nie in die eingecheckte
.enveintragen, sondern nur in.env.local(wird von Git ignoriert).
- Config bearbeiten:
DATABASE_URL="mysql://<DB-Benutzernamen>:<Passwort>@127.0.0.1:3306/hermine_bot?charset=utf8mb4"#DB-Benutzername und Passwort eintragen und die server_Version rausnehmen\
composer install
composer dump-env prod
php bin/console doctrine:migrations:migrate
sudo chown www-data:www-data -R /opt/HermineBot/
Ohne Cron-Job verschickt der Bot keine geplanten Nachrichten. Als Webserver-Benutzer einrichten (sudo crontab -u www-data -e):
* * * * * php /opt/HermineBot/bin/console daemon:tick
Nur für den ersten Administrator nötig; weitere Nutzer (auch API-Nutzer) danach in der Oberfläche unter „Nutzer“.
php bin/console security:hash-password
- Zu root werden
sudo su - - MySQL-Client starten
mysql - Datenbank wählen
use hermine_bot; - Benutzer in DB anlegen
INSERT INTO user (id, username, roles, password) VALUES (1, '<Benutzername>', '["ROLE_ADMIN"]', '<Generierter Passwort-Hash>'); - MySQL-Client beenden
quit; - Aus Root-Kontext raus
exit
- Webseite, wie in env.app.php konfiguriert, aufrufen.
- Mit den Anmeldedaten, die per MySQL-Command angelegt wurden, anmelden
php /opt/HermineBot/bin/console hermine:send-message -c <Hermine-Channel> -m "<Nachricht>"
Achtung: Die Nachricht geht sofort und echt an den Channel – zum Testen nur einen Test-Channel aus
allowed_channelverwenden.
Ich arbeite nicht für StashCat und habe auch ansonsten keinen Bezug zur stashcat GmbH. Es war ein Hobby-Projekt um die Funktionen für den im THW eingesetzten Stashcat-Brand "Hermine" zu erweitern.
Hintergrund: Ich wollte automatisiert z.B. auf anstehende reguläre Dienste hinweisen und unter anderem die HU/AU/SP-Termine der OV-Fahrzeugflotte einpflegen damit wir rechtzeitig dran denken.
Liebe stashcat GmbH - bitte nicht hauen, wenn das so nicht geplant ist von euch. Will mir nur das Leben im THW nur ein wenig einfacher machen 😘