Browse Source

Add readme and license

master
Jan-Lukas Else 9 months ago
parent
commit
a541dbd52c
2 changed files with 48 additions and 0 deletions
  1. +21
    -0
      LICENSE
  2. +27
    -0
      README.md

+ 21
- 0
LICENSE View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2020 Jan-Lukas Else
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.

+ 27
- 0
README.md View File

@ -0,0 +1,27 @@
# JSON Feed to Telegram Bot
This is a simple Telegram bot, written in Go, that is able to check a JSON Feed for updates and sends the latest article to a Telegram channel.
## How to use
You should configure this bot to run behind a reverse proxy. It is listening to port 8080 by default. It is recommended to use Docker to run this bot. That let's your remap the port, easily set environment variables etc.
## How to trigger posting to Telegram
A recheck of the JSON Feed is triggered when the path `/hook` is called using a HTTP POST request.
## Configuration
Some environment variables are required:
`LAST_ARTICLE_FILE`: file path to the file where the URL of the last sent article should be saved
`FEED`: URL to the JSON Feed
`BOT_TOKEN`: The token for the Telegram bot
`CHANNEL`: The channel or user ID to which notifications should be send
## License
This project is licensed under the MIT license, so you can do basically everything with it, but nevertheless, please contribute your improvements to make it better for everyone. See the LICENSE file.

Loading…
Cancel
Save