https://github.com/openware/postmaster

Notification Hub for openware stack
https://github.com/openware/postmaster

amqp-client consumer micro-service

Last synced: 7 months ago
JSON representation

Notification Hub for openware stack

• Host: GitHub
• URL: https://github.com/openware/postmaster
• Owner: openware
• License: mit
• Created: 2019-01-21T15:28:13.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-11-13T13:00:33.000Z (over 6 years ago)
• Last Synced: 2024-12-15T19:06:18.806Z (about 1 year ago)
• Topics: amqp-client, consumer, micro-service
• Language: Go
• Homepage: https://www.openware.com
• Size: 131 KB
• Stars: 14
• Watchers: 11
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# postmaster

[![Build Status](https://ci.openware.work/api/badges/openware/postmaster/status.svg)](https://ci.openware.work/openware/postmaster)

> :incoming_envelope: Notification Hub for openware stack.

Event API client for

* [Barong](https://www.github.com/rubykube/barong)

* [Peatio](https://www.github.com/rubykube/peatio)

## Overview

Consume mail events from RabbitMQ and send emails over SMTP.

![Overview](./resources/overview.png)

## Usage

Start worker by running command below

```sh

$ go run ./cmd/postmaster/main.go

```

### Environment variables

| Variable               | Description                          | Required | Default              |

|------------------------|--------------------------------------|----------|----------------------|

| `POSTMASTER_ENV`       | Environment, reacts on "production"  | *no*     |                      |

| `POSTMASTER_LOG_LEVEL` | Level of logging                     | *no*     | `debug`              |

| `RABBITMQ_HOST`        | Host of RabbitMQ daemon              | *no*     | `localhost`          |

| `RABBITMQ_PORT`        | Port of RabbitMQ daemon              | *no*     | `5672`               |

| `RABBITMQ_USERNAME`    | RabbitMQ username                    | *no*     | `guest`              |

| `RABBITMQ_PASSWORD`    | RabbitMQ password                    | *no*     | `guest`              |

| `SMTP_PASSWORD`        | Password used for auth to SMTP       | *yes*    |                      |

| `SMTP_PORT`            | Post of SMTP server                  | *no*     | `25`                 |

| `SMTP_HOST`            | Host of SMTP server                  | *no*     | `smtp.sendgrid.net`  |

| `SMTP_USER`            | User used for auth to SMTP           | *no*     | `apikey`             |

| `SENDER_EMAIL`         | Email address of mail sender         | *yes*    |                      |

| `SENDER_NAME `         | Name of mail sender                  | *no*     | `Postmaster`         |

## License

Project released under the terms of the MIT [license](./LICENSE).