Update README
This commit is contained in:
7
LICENSE.txt
Normal file
7
LICENSE.txt
Normal file
@ -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.
|
15
README.md
15
README.md
@ -4,21 +4,21 @@ Ein Python-Skript, das den TI-Status überwacht und neue Meldungen über Apprise
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Überwacht die TI-Status-API auf neue Meldungen
|
- Überwacht die [TI-Status-API](https://github.com/gematik/api-tilage) auf neue Meldungen
|
||||||
- Sendet Benachrichtigungen über Apprise (unterstützt viele Dienste wie Mattermost, Slack, Telegram, Discord, etc.)
|
- 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 + ...)
|
- **Mehrere Endpunkte gleichzeitig** (Mattermost + Slack + Telegram + ...)
|
||||||
- **Konfigurierbare Benachrichtigungsregeln** (Filter, Zeiten, Verzögerungen)
|
- **Konfigurierbare Benachrichtigungsregeln** (Filter, Zeiten, Verzögerungen)
|
||||||
- Konfiguration über .env Datei
|
- Konfiguration über .env Datei
|
||||||
- Markdown-Formatierung der Nachrichten
|
- Markdown-Formatierung der Nachrichten
|
||||||
- Vermeidet Duplikate durch lokale Statusverfolgung
|
- Vermeidet Duplikate durch lokale Statusverfolgung
|
||||||
- Debug-Ausgaben für bessere Transparenz
|
- Debug-Ausgaben für bessere Transparenz
|
||||||
- Umfassende Test-Tools
|
- Umfassendes Test-Tool
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Repository klonen:
|
1. Repository klonen:
|
||||||
```bash
|
```bash
|
||||||
git clone <repository-url>
|
git clone https://gitea.medisoftware.org/Markus/TI-Status2Mattermost.git
|
||||||
cd TI-Status2Mattermost
|
cd TI-Status2Mattermost
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -40,6 +40,9 @@ pip install -r requirements.txt
|
|||||||
|
|
||||||
1. Kopiere die Beispiel-Konfiguration:
|
1. Kopiere die Beispiel-Konfiguration:
|
||||||
```bash
|
```bash
|
||||||
|
# Windows:
|
||||||
|
copy env.example .env
|
||||||
|
# Linux/Mac:
|
||||||
cp env.example .env
|
cp env.example .env
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -49,7 +52,7 @@ cp env.example .env
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Mattermost Webhook
|
# Mattermost Webhook
|
||||||
APPRISE_URL_MATTERMOST=mattermost://username:password@mattermost.medisoftware.org/channel?webhook=your_webhook_id
|
APPRISE_URL_MATTERMOST=mattermost://username:password@<your-mattermost-server>/channel?webhook=your_webhook_id
|
||||||
|
|
||||||
# Slack (optional)
|
# Slack (optional)
|
||||||
APPRISE_URL_SLACK=slack://token_a/token_b/token_c/#channel
|
APPRISE_URL_SLACK=slack://token_a/token_b/token_c/#channel
|
||||||
@ -188,4 +191,4 @@ Apprise unterstützt über 80 verschiedene Benachrichtigungsdienste, darunter:
|
|||||||
|
|
||||||
## Lizenz
|
## Lizenz
|
||||||
|
|
||||||
[Deine Lizenz hier]
|
[MIT License](LICENSE.txt)
|
@ -1,6 +1,6 @@
|
|||||||
# Apprise Konfiguration
|
# Apprise Konfiguration
|
||||||
# Beispiel für Mattermost Webhook:
|
# Beispiel für Mattermost Webhook:
|
||||||
# APPRISE_URL=mattermost://username:password@mattermost.medisoftware.org/channel?webhook=your_webhook_id
|
# APPRISE_URL=mattermost://username:password@<your-mattermost-server>/channel?webhook=your_webhook_id
|
||||||
|
|
||||||
# Beispiel für andere Dienste:
|
# Beispiel für andere Dienste:
|
||||||
# APPRISE_URL=slack://token_a/token_b/token_c/#channel
|
# APPRISE_URL=slack://token_a/token_b/token_c/#channel
|
||||||
@ -11,7 +11,7 @@
|
|||||||
# Mehrere URLs können durch Kommas getrennt werden
|
# Mehrere URLs können durch Kommas getrennt werden
|
||||||
|
|
||||||
# Mattermost Webhook
|
# Mattermost Webhook
|
||||||
APPRISE_URL_MATTERMOST=mattermost://username:password@mattermost.medisoftware.org/channel?webhook=your_webhook_id
|
APPRISE_URL_MATTERMOST=mattermost://username:password@<your-mattermost-server>/channel?webhook=your_webhook_id
|
||||||
|
|
||||||
# Slack (optional)
|
# Slack (optional)
|
||||||
# APPRISE_URL_SLACK=slack://token_a/token_b/token_c/#channel
|
# APPRISE_URL_SLACK=slack://token_a/token_b/token_c/#channel
|
||||||
|
Reference in New Issue
Block a user