diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..3c2b2b2 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,7 @@ +Copyright 2025 medisoftware + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 2611e2b..f4d0397 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,21 @@ Ein Python-Skript, das den TI-Status überwacht und neue Meldungen über Apprise ## Features -- Überwacht die TI-Status-API auf neue Meldungen -- Sendet Benachrichtigungen über Apprise (unterstützt viele Dienste wie Mattermost, Slack, Telegram, Discord, etc.) +- Überwacht die [TI-Status-API](https://github.com/gematik/api-tilage) auf neue Meldungen +- Sendet Benachrichtigungen über [Apprise](https://github.com/caronc/apprise#supported-notifications) (unterstützt alle verbreiteten Dienste wie Mattermost, Slack, Telegram, Discord, SMTP, Teams, etc.) - **Mehrere Endpunkte gleichzeitig** (Mattermost + Slack + Telegram + ...) - **Konfigurierbare Benachrichtigungsregeln** (Filter, Zeiten, Verzögerungen) - Konfiguration über .env Datei - Markdown-Formatierung der Nachrichten - Vermeidet Duplikate durch lokale Statusverfolgung - Debug-Ausgaben für bessere Transparenz -- Umfassende Test-Tools +- Umfassendes Test-Tool ## Installation 1. Repository klonen: ```bash -git clone +git clone https://gitea.medisoftware.org/Markus/TI-Status2Mattermost.git cd TI-Status2Mattermost ``` @@ -40,6 +40,9 @@ pip install -r requirements.txt 1. Kopiere die Beispiel-Konfiguration: ```bash +# Windows: +copy env.example .env +# Linux/Mac: cp env.example .env ``` @@ -49,7 +52,7 @@ cp env.example .env ```bash # Mattermost Webhook -APPRISE_URL_MATTERMOST=mattermost://username:password@mattermost.medisoftware.org/channel?webhook=your_webhook_id +APPRISE_URL_MATTERMOST=mattermost://username:password@/channel?webhook=your_webhook_id # Slack (optional) APPRISE_URL_SLACK=slack://token_a/token_b/token_c/#channel @@ -188,4 +191,4 @@ Apprise unterstützt über 80 verschiedene Benachrichtigungsdienste, darunter: ## Lizenz -[Deine Lizenz hier] \ No newline at end of file +[MIT License](LICENSE.txt) \ No newline at end of file diff --git a/env.example b/env.example index e8b9d2e..ca81757 100644 --- a/env.example +++ b/env.example @@ -1,6 +1,6 @@ # Apprise Konfiguration # Beispiel für Mattermost Webhook: -# APPRISE_URL=mattermost://username:password@mattermost.medisoftware.org/channel?webhook=your_webhook_id +# APPRISE_URL=mattermost://username:password@/channel?webhook=your_webhook_id # Beispiel für andere Dienste: # APPRISE_URL=slack://token_a/token_b/token_c/#channel @@ -11,7 +11,7 @@ # Mehrere URLs können durch Kommas getrennt werden # Mattermost Webhook -APPRISE_URL_MATTERMOST=mattermost://username:password@mattermost.medisoftware.org/channel?webhook=your_webhook_id +APPRISE_URL_MATTERMOST=mattermost://username:password@/channel?webhook=your_webhook_id # Slack (optional) # APPRISE_URL_SLACK=slack://token_a/token_b/token_c/#channel