1
0
mirror of https://github.com/mainflux/mainflux.git synced 2025-05-12 19:29:30 +08:00

24 lines
1012 B
Markdown
Raw Normal View History

MF-1311 - Add Notifications service (#1324) * Add repo to Notify Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Remove notify Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add initial repo implementation Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add Subscriptions repo implementation Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add working version of main method Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add Notifier API Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add API layer Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add Notifier interface Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix SMTP notifier main Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix email sending Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix main log Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add Readme and fix env vars Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Update README Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Remove commented code Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Rename notifiers to notify Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Move Consumer API to writers Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix contact naming Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix spacing in init.go Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix API Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add mocks Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add initial service test Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Use pagination Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Update List method Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix listing Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Rename SubscriptionPage to Page Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Finish service tests Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add DB tests Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add API tests Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add more API tests Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Remove Things dependency Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add API docs Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add docs Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix Things references Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix AuthN typo Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix linter warnings Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Add license comments Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix test order Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Use service error for wrappers Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix repo setup test Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Use total const in tests Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Use constant contacts Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix code formatting Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Rename notifier implementation Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Rename Notify to Notifiers Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Resolve remarks Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix naming and docs Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix docker-compose Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Rename Subscriptions to Notifiers service Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix logging Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix formatting and typo Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Resolve remarks Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com> * Fix topic request Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com>
2021-02-01 14:08:10 +01:00
# Notifiers service
Notifiers service provides a service for sending notifications using Notifiers.
Notifiers service can be configured to use different types of Notifiers to send
different types of notifications such as SMS messages, emails, or push notifications.
Service is extensible so that new implementations of Notifiers can be easily added.
Notifiers **are not standalone services** but rather dependencies used by Notifiers service
for sending notifications over specific protocols.
## Configuration
The service is configured using the environment variables.
The environment variables needed for service configuration depend on the underlying Notifier.
An example of the service configuration for SMTP Notifier can be found [in SMTP Notifier documentation](smtp/README.md).
Note that any unset variables will be replaced with their
default values.
## Usage
Subscriptions service will start consuming messages and sending notifications when a message is received.
2021-06-23 13:31:46 +02:00
[doc]: https://docs.mainflux.io