amplifysecurity/alpine-sqs

Alpine SQS (alpine-sqs)

[!NOTE] alpine-sqs仓库由Amplify Security维护，并发布于https://hub.docker.com/r/amplifysecurity/alpine-sqs%EF%BC%8C%E7%9B%B4%E8%87%B3%E7%89%B9%E5%AE%9A%E5%8A%9F%E8%83%BD%E5%90%88%E5%B9%B6%E5%88%B0%E5%8E%9F%E5%A7%8B%E4%BB%93%E5%BA%93https://github.com/roribio/alpine-sqs%E3%80%82

!https://raw.githubusercontent.com/roribio/alpine-sqs/master/banner.png

镜像概述和主要用途

Alpine SQS提供Amazon Simple Queue Service (AWS-SQS)的容器化Java实现，基于ElasticMQ运行在Alpine Linux上，并使用Oracle Java 8 Server-JRE。它与AWS的API、CLI及Amazon Java SDK兼容，可加速本地开发过程，避免产生基础设施成本。本镜像的目标是维护一个更新的ElasticMQ Docker环境，集成Web UI以可视化队列和消息。

核心功能和特性

• 轻量级基础：基于Alpine Linux，显著减小镜像体积
• AWS SQS兼容：支持AWS API、CLI和Java SDK，无缝迁移
• 集成Web UI：通过sqs-insight提供队列和消息可视化界面
• 自动更新：保持ElasticMQ服务器为最新版本
• 可自定义配置：支持挂载自定义配置文件覆盖默认行为
• 默认队列：预配置"default"队列，开箱即可使用
• 死信队列：默认配置"dlq"死信队列

使用场景和适用范围

• 本地开发环境：开发依赖SQS的应用程序时，无需连接AWS云服务
• 功能测试：验证队列消息处理逻辑，快速迭代开发
• 集成测试：在CI/CD流程中模拟SQS服务，确保应用兼容性
• 演示环境：展示依赖消息队列的应用功能，无需云资源

安装与使用说明

前提条件

• 安装最新版Docker
• 如需自行构建，建议安装最新版Docker Compose

安装方式

1. 从Docker Hub拉取镜像

bash
docker pull roribio16/alpine-sqs

2. 从源码构建

bash
git clone https://github.com/roribio/alpine-sqs.git

运行方法

1. docker run 方式

适用于直接从Docker Hub拉取镜像的场景：

bash
docker run --name alpine-sqs -p 9324:9324 -p 9326:9326 -d roribio16/alpine-sqs:latest

自定义配置：通过挂载卷使用自定义配置文件（如elasticmq.conf和sqs-insight.conf）：

bash
docker run --name alpine-sqs -p 9324:9324 -p 9326:9326 -v /opt/alpine-sqs:/opt/custom -d roribio16/alpine-sqs:latest

未在/opt/custom目录中提供的配置文件将使用默认配置（位于容器/opt/config目录）

2. docker-compose up 方式

适用于已克隆仓库的场景，使用预构建镜像：

bash
docker-compose up -d

3. docker-compose up --build 方式

从源码构建并运行：

bash
docker-compose -f docker-compose.build up -d --build

注意：使用Docker Compose方法需克隆仓库并安装Docker Compose。不同平台可能需要调整卷挂载方式，详见https://github.com/roribio/alpine-sqs/wiki/Sharing-files-with-host-machine%E3%80%82

队列操作指南

默认队列

默认配置自动创建"default"队列，可通过以下URL访问：http://localhost:9324/queue/default

死信队列

默认死信队列为"dlq"，配置详情见https://github.com/softwaremill/elasticmq#automatically-creating-queues-on-startup

发送消息（AWS CLI示例）

bash
aws --endpoint-url http://localhost:9324 sqs send-message --queue-url http://localhost:9324/queue/default --message-body "Hello, queue!"

查看消息

• Web UI：访问http://localhost:9326（基于sqs-insight）
• 命令行：

  bash
  aws --endpoint-url http://localhost:9324 sqs receive-message --queue-url http://localhost:9324/queue/default --wait-time-seconds 10
  

注意：Web UI已从9325端口迁移至9326端口，9325端口现在用于ElasticMQ的统计API。

创建新队列

使用AWS CLI

bash
aws --endpoint-url http://localhost:9324 sqs create-queue --queue-name newqueue

编辑ElasticMQ配置文件

修改elasticmq.conf文件，在queues块中添加新队列配置：

queues {
    default {
        defaultVisibilityTimeout = 10 seconds
        delay = 5 seconds
        receiveMessageWait = 0 seconds
    },
    newqueue {
        defaultVisibilityTimeout = 10 seconds
        delay = 5 seconds
        receiveMessageWait = 0 seconds
    }
}

修改后需重启ElasticMQ：

bash
docker exec -it alpine-sqs sh -c "supervisorctl restart elasticmq"

在Web UI中注册新队列

编辑sqs-insight.conf文件，添加新队列端点（无需重启UI服务）：

json
"endpoints": [
    {
        "key": "notValidKey",
        "secretKey": "notValidSecret",
        "region": "eu-central-1",
        "url": "http://localhost:9324/queue/default"
    },
    {
        "key": "notValidKey",
        "secretKey": "notValidSecret",
        "region": "eu-central-1",
        "url": "http://localhost:9324/queue/newqueue"
    }
]

除url外，其他字段为sqs-insight必填项，但对本地队列无实际影响，可使用示例值。

维护者

Ronald E. Oribio R. - https://github.com/roribio

贡献

接受并鼓励PR！如有问题、需求或建议，请提交至项目https://github.com/roribio/alpine-sqs/issues%E3%80%82

注意：编辑本README时，请遵循https://github.com/RichardLitt/standard-readme%E8%A7%84%E8%8C%83%E3%80%82

许可证

Copyright 2017 Ronald E. Oribio R.

本项目采用GNU General Public License v3.0授权，详见LICENSE文件。