0.16.0

Compatibility


Pairs with	Amazon SNS Broker
Product	Notiway Notify

Installation

Environment Variables

Variable	Required	Default	Description
`Infra__Plugins__Buffer__Name`	Yes	—	Set to `SQS`
`Infra__Plugins__Buffer__Version`	Yes	—	Set to `0.16.0`
`Infra__Plugins__Buffer__Config__QueueUrl`	Yes	—	Full URL of the SQS queue to consume from
`Infra__Plugins__Buffer__Config__Region`	Yes	—	AWS region where the queue is located (e.g., `us-east-1`)
`Infra__Plugins__Buffer__Config__MaxMessages`	No	`10`	Maximum number of messages to receive per poll (1-10)
`Infra__Plugins__Buffer__Config__WaitTimeSeconds`	No	`20`	Long polling wait time in seconds (0-20)

AWS credentials are resolved using the default AWS credential chain (environment variables, IAM role, instance profile, etc.).

Infrastructure

Create an SQS queue — standard queue is recommended for most use cases.
If using with SNS Broker — subscribe the SQS queue to the SNS topic so notifications fan out to all instances.
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:portable-0.5.0
    ports:
      - "5000:8080"
    environment:
      - Infra__Plugins__Buffer__Name=SQS
      - Infra__Plugins__Buffer__Version=0.16.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
      - Infra__Plugins__Buffer__Config__WaitTimeSeconds=20
      - AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}
      - AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}