0.15.0

Compatibility

Pairs withAmazon SNS Broker
ProductNotiway Notify

Installation

Environment Variables

VariableRequiredDefaultDescription
Infra__Plugins__Buffer__NameYesSet to SQS
Infra__Plugins__Buffer__VersionYesSet to 0.15.0
Infra__Plugins__Buffer__Config__QueueUrlYesFull URL of the SQS queue to consume from
Infra__Plugins__Buffer__Config__RegionYesAWS region where the queue is located (e.g., us-east-1)
Infra__Plugins__Buffer__Config__MaxMessagesNo10Maximum number of messages to receive per poll (1-10)

Infrastructure

  1. Create an SQS queue — standard queue is recommended for most use cases.
  2. If using with SNS Broker — subscribe the SQS queue to the SNS topic so notifications fan out to all instances.
  3. IAM permissions — the Notiway service needs sqs:ReceiveMessage, sqs:DeleteMessage, and sqs:GetQueueAttributes on the queue.

Docker Compose

docker-compose.yml
services:
  notiway:
    image: notiway/notify:aws-0.6.0
    ports:
      - "5000:8080"
    environment:
      - Infra__Plugins__Buffer__Name=SQS
      - Infra__Plugins__Buffer__Version=0.15.0
      - Infra__Plugins__Buffer__Config__QueueUrl=https://sqs.us-east-1.amazonaws.com/123456789012/notiway-queue
      - Infra__Plugins__Buffer__Config__Region=us-east-1
      - Infra__Plugins__Buffer__Config__MaxMessages=10
      - AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}
      - AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}