Git Product home page Git Product logo

notifier's Introduction

Notifier

A gif showing the project in action

A simple microservice which accepts incoming notifications, and questions and redirects them to notification sinks such as Telegram, Email etc.

Building

$ go get -u github.com/swaggo/swag/cmd/swag
$ go generate . && go build .

You can also use the provided dockerfile.

Configuration

Put this to notifier-config.yaml at ./notifier-config.yaml, /etc/notifier/notifier-config.yaml or ~/.config/notifier/notifier-config.yaml:

http:
  jwt_secret: <jwt secret here> # enter jwt secret here (some random characters)
  addr: :8080
sinks:
  - type: telegram
    bot_token: <bot token here>
    chat_id: <chat id to post messages to>
  - type: email
    from: "[email protected]"
    to:
      - "[email protected]"
    smtp_address: "mail.example.com:587"
    smtp_username: "[email protected]"
    smtp_password: "cocker12"
    starttls: true
users:
  - username: user # used to login via web and view API docs at :8080
    password: pass
  - username: my-script
    token: JzvFZ9Rt0lAq6loSrr6nKN4AwfTYfEK1PnhZwWb # Add it in the `Authorization` header to authenticate

Api docs

See docs/swagger.md. Or go to the IP of the server and log-in.

License

This project is licensed under the MIT.

notifier's People

Contributors

alufers avatar

Stargazers

msenturk avatar MiXerek avatar Bartek Pacia avatar Patrycja avatar Can Evgin avatar Enjoyer avatar Filip Grzywok avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

ptrcnull msenturk

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.